Skip to content

Batch order for up to 100 addresses

POST
/orchestrator

One request instead of three per address. For every address the whole sequence runs: probe → activation if the address is not active → a bandwidth top-up if free bandwidth is below 400 → energy rental, with large amounts split into chunks automatically.

The 202 response arrives immediately, the connection is not held. A failure in activation or bandwidth does not cancel the energy order for that address, and one address failing never affects the others.

Addresses run in parallel, up to five at a time within one order, so a large batch does not queue behind a single slow address. The order of completion is not guaranteed.

Amounts above 1,000,000 are split into even chunks automatically, each becoming its own energy order — all their numbers and hashes arrive in energy.orderIds and energy.hashes.

Limits: 100 addresses per order, 61,000…50,000,000 energy per address, no more than 50,000,000 in total per order, 3 orders and 300 addresses in flight per account, and a minimum balance of 4 TRX to be accepted.

Idempotency. The order is identified by your key — the X-Idempotency-Key header or the clientRequestId field. A repeat with the same key and the same body returns 208 with the original order; a repeat with the same key and a different body is rejected as 4090 IDEMPOTENCY_CONFLICT. Inside the order every address carries its own internal key, so a repeat never double-charges an individual address either.

Billing. The orchestrator itself charges nothing: each step is billed by the service that performs it — activation as a separate deduction with an A… number, bandwidth with a B1H… number and only when actually delegated, energy as one deduction per chunk with 1H… numbers. If your balance runs out mid-batch, the remaining addresses end as insufficient_balance without being attempted.

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"
X-Idempotency-Key

Order key, 12–128 characters from A-Z a-z 0-9 . _ : -. Required when the body carries no clientRequestId. type: string pattern: '^[A-Za-z0-9._:-]{12,128}$'

Type
string
Pattern
"^[A-Za-z0-9._:-]{12,128}$"

Request Body

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"bandwidth": true,
  
  
  
"bandwidthAmount": 400,
  
  
  
"bandwidthPeriod": "1h",
  
  
  
"check": true,
  
  
  
"trx_send": false,
  
  
  
"activation": true,
  
  
  
"receiveAddress": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE",
  
  
  
"amount": 0
  
  
}
  
],
  
"clientRequestId": "string",
  
"defaults": {
  
  
"bandwidth": true,
  
  
"bandwidthAmount": 400,
  
  
"bandwidthPeriod": "1h",
  
  
"check": true,
  
  
"trx_send": false,
  
  
"activation": true
  
}
}

Responses

The order is queued. Nothing has been executed or charged yet.

application/json
JSON
{
  
"detail": {
  
  
"code": 10202,
  
  
"status": "accepted",
  
  
"msg": "string",
  
  
"data": {
  
  
  
"idempotencyKey": "string",
  
  
  
"requestId": 0,
  
  
  
"itemsAccepted": 0,
  
  
  
"statusUrl": "string",
  
  
  
"originalAcceptedAt": "string",
  
  
  
"items": [
  
  
  
  
{
  
  
  
  
  
"deliveryKey": 0,
  
  
  
  
  
"trackingId": "string",
  
  
  
  
  
"receiveAddress": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE",
  
  
  
  
  
"amount": 0,
  
  
  
  
  
"energyChunks": 0,
  
  
  
  
  
"activation": "string",
  
  
  
  
  
"bandwidth": "string",
  
  
  
  
  
"status": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
}
}

Playground

Authorization
Headers
Body

Samples

Powered by VitePress OpenAPI