Response Format

Success envelope

Every successful call returns HTTP 200 with this structure:

{
  "status": 200,
  "message": "Balance fetched successfully",
  "data": "<encrypted base64 payload>"
}

Field	Type	Description
`status`	number	HTTP status code
`message`	string	Human-readable summary of the result
`data`	string	The response payload, encrypted to your Ed25519 public key; see Encryption

Throughout the API Reference, response examples show the decrypted contents of data so you can see the actual payload shape. On the wire, data is always an encrypted base64 string.

Error envelope

Errors return the status and message with no data field:

{
  "status": 400,
  "message": "Invalid api key"
}

Permission failures use a slightly different shape:

{
  "status": false,
  "message": "Permission denied"
}

See the Error Reference for the full list.

Pagination

List endpoints such as Get Transactions return paginated data:

{
  "data": [ ... ],
  "pagination": {
    "count": 42,
    "pages": 5,
    "isLastPage": false,
    "nextPage": 2,
    "previousPage": null
  }
}

Field	Type	Description
`count`	number	Total number of records
`pages`	number	Total number of pages
`isLastPage`	boolean	Whether the current page is the last
`nextPage`	number \| null	Next page number, or `null` on the last page
`previousPage`	number \| null	Previous page number, or `null` on the first page

Get Started

Integration Guides

Success envelope

Error envelope

​Success envelope

​Error envelope

​Pagination

Success envelope

Error envelope

Pagination