Skip to main content
GET
Inspect a revert batch

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Path Parameters

batchId
string
required

Batch id returned by a revert call (or from the ledger list)

Query Parameters

accountsLimit
integer
default:1000

Accounts per page in accounts (oldest first)

Required range: 1 <= x <= 1000
accountsOffset
integer
default:0

Accounts to skip — page through batches larger than accountsLimit with accountsTotal

Required range: x >= 0

Response

Revert batch detail

success
boolean
Example:

true

data
object
Example: