Skip to content

Queue a statement file

POST
/reports/statement

Queues a statement file for one token over a period. The reply is immediate and contains an order number; the file itself is built in the background. Poll GET /reports/{order_no} or register a webhook to be told when it is ready.
Repeat calls are safe: send the same client_request_id, or an X-Idempotency-Key header, and a duplicate returns the existing order instead of creating a second one.

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

Your own idempotency key, 12 to 128 characters of A-Z a-z 0-9 . _ : -. When omitted, one is derived from the request body.

Type
string

Request Body

application/json
JSON
{
  
"client_request_id": "string",
  
"address": "string",
  
"token_id": "TRX",
  
"date_from": "string",
  
"date_to": "string",
  
"format": "csv"
}

Responses

Queued, or the already existing order for a repeated request.

application/json
JSON
{
  
"status": "success",
  
"code": 0,
  
"msg": "",
  
"data": {
  
  
"order_no": "REPxxxxxxxxxxxx",
  
  
"client_request_id": "string",
  
  
"type": "string",
  
  
"status": "string",
  
  
"address": "string",
  
  
"token_id": "string",
  
  
"date_from": "string",
  
  
"date_to": "string",
  
  
"format": "string",
  
  
"progress_pct": 100,
  
  
"created_at": "string",
  
  
"finished_at": "string",
  
  
"expires_at": "string",
  
  
"download_url": "string",
  
  
"artifact_sha256": "string",
  
  
"artifact_size": 0,
  
  
"error_code": "string",
  
  
"error_message": "string"
  
}
}

Playground

Authorization
Headers
Body

Samples

Powered by VitePress OpenAPI