Get a network

GET

/networks/{network_id}

const url = 'https://api.poweredbyaura.com/v1/networks/net_ng_a';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.poweredbyaura.com/v1/networks/net_ng_a \
  --header 'Authorization: Bearer <token>'

Authorizations

apiKey

Parameters

Path Parameters

network_id

required

string

Example

net_ng_a

Responses

200

The network.

application/json

object

required

string

object

required

string

Allowed value: network

name

required

string

country

required

ISO 3166-1 alpha-2 country code.

string

status

required

operational: purchases are accepted and confirmed normally. degraded: purchases are accepted but confirmations are slower than usual. unavailable: purchases are refused with network_unavailable.

string

Allowed values: operational degraded unavailable

status_message

required

A short explanation when the status is not operational.

string | null

status_updated_at

required

string format: date-time

recent_delivery

required

Measured time from accepting a purchase to the network’s confirmation, over the window shown. null when there were too few purchases in the window to measure.

object

median_seconds

required

number

p95_seconds

required

number

window_minutes

required

integer

sample_size

required

integer

Examples

operational

An operational network

{
  "id": "net_ng_a",
  "object": "network",
  "name": "Network A",
  "country": "NG",
  "status": "operational",
  "status_message": null,
  "status_updated_at": "2026-10-12T06:00:00Z",
  "recent_delivery": {
    "median_seconds": 4.2,
    "p95_seconds": 19.8,
    "window_minutes": 60,
    "sample_size": 1840
  }
}

Headers

Aura-Request-Id

string

Example

req_7Kp2Vx9QmR4t

A unique ID for this request. Quote it when you contact your technical contact.

401

The API key is missing, wrong or revoked.

application/json

object

error

required

object

code

required

A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP status and retryable flag.

string

Allowed values: invalid_request invalid_phone_number invalid_api_key ip_not_allowed not_found insufficient_balance reference_conflict bundle_unavailable network_mismatch unsupported_network rate_limited internal_error network_unavailable

message

required

A human-readable explanation. Do not parse it; use code.

string

param

The request field the error is about, when there is one.

string

retryable

required

Whether the same request can succeed if you retry it later.

boolean

request_id

required

string

details

Extra facts about the error, such as the existing purchase or the network’s status.

object

key

additional properties

any

Examples

invalidKey

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is not valid.",
    "retryable": false,
    "request_id": "req_2Mz6Rt8KcW1p"
  }
}

Headers

Aura-Request-Id

string

Example

req_7Kp2Vx9QmR4t

A unique ID for this request. Quote it when you contact your technical contact.

404

No such resource on your account.

application/json

object

error

required

object

code

required

A stable, machine-readable code. New codes may be added in v1, so treat an unknown code by its HTTP status and retryable flag.

string

message

required

A human-readable explanation. Do not parse it; use code.

string

param

The request field the error is about, when there is one.

string

retryable

required

Whether the same request can succeed if you retry it later.

boolean

request_id

required

string

details

Extra facts about the error, such as the existing purchase or the network’s status.

object

key

additional properties

any

Examples

notFound

{
  "error": {
    "code": "not_found",
    "message": "No purchase pur_01JA7ZK3Q9W2D8M5X4N6B1C0VX on this account.",
    "retryable": false,
    "request_id": "req_8Wc3Ld5YhF2k"
  }
}

Headers

Aura-Request-Id

string

Example

req_7Kp2Vx9QmR4t

A unique ID for this request. Quote it when you contact your technical contact.