Bandwidth order status

GET

/bandwidth/status/{orderId}

State of the order. Needed above all after a 202 response, when the order went to an external provider. The order must belong to the key's owner.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type

API Key (header: X-API-KEY)

Parameters

Header Parameters

X-Real-IP*

An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.

Type

string

Required

Example"203.0.113.10"

Format

"ipv4"

Path Parameters

orderId*

Order id: B5M… or B1H….

Type

string

Required

Responses

The order state is in detail.code: 10000 — completed, 10001 — in progress, 10002 — bandwidth was already sufficient, 5003 — failed. application/json: schema: { $ref: '#/components/schemas/BandwidthResponse' }

Content-Type

application/json

{

  

"detail": {

  

  

"code": 10000,

  

  

"status": "string",

  

  

"msg": "string",

  

  

"data": {

  

  

  

"orderId": "string",

  

  

  

"paidTRX": 0,

  

  

  

"fulfilledBy": "string",

  

  

  

"hash": [

  

  

  

  

"3636f97dde244fca17cdc0b2cf7fd157a4b0de94d8fbd4c190d5378ba911dfae"

  

  

  

],

  

  

  

"trxSendHash": [

  

  

  

  

"3636f97dde244fca17cdc0b2cf7fd157a4b0de94d8fbd4c190d5378ba911dfae"

  

  

  

],

  

  

  

"reclaimHash": [

  

  

  

  

"3636f97dde244fca17cdc0b2cf7fd157a4b0de94d8fbd4c190d5378ba911dfae"

  

  

  

],

  

  

  

"bandwidth": 0,

  

  

  

"period": "string",

  

  

  

"testAction": "would_delegate",

  

  

  

"wouldCostTRX": 0,

  

  

  

"receiverFreeBandwidth": 0

  

  

}

  

}

}

GET

/bandwidth/status/{orderId}

Playground

Authorization

ApiKeyAuth

Headers

X-Real-IP*

Variables

Key

Value

orderId*

Samples

Powered by VitePress OpenAPI