Sandbox version
For experimental use only. Proceed with caution.
trades
Batch resolve trades by IDs
post
/trade/batch
operationId: trade-getDetails

Batch trade-event lookup by trade UUID. Body: { "tradeIds": ["…", "…"] } (max 100). Returns each matched trade with its pair embedded; unmatched tradeIds are silently omitted. Prefer this over N parallel calls to /trade/{id}.

Unlock protected endpoints

Enter your Bearer token once to enable every protected route in this API reference.

HTTP bearer

Saved for this browser tab only. The credential is never sent until you test an endpoint.

Authorizations
NameLocationDetails
BearerAuthAuthorization header · bearerJWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.
Request Body
application/json
required
FieldTypeDescription
tradeIds
required
string[]
Trade UUIDs to resolve. Max 100 per request. Unmatched tradeIds are silently omitted.
Example
Json
{
  "tradeIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Responses
200
application/json
Successful response
FieldTypeDescription
items
object[]
Resolved trades. One entry per matched tradeId; unmatched tradeIds are silently omitted.
items[].id
string
UUID — part of the composite PK (id, timestamp).
items[].tradePairId
string
Parent trade_pairs.id.
items[].txHash
string
Transaction hash of the trade.
items[].ledgerIndex
integer
Ledger sequence of the trade.
items[].timestamp
integer
When the trade executed on-ledger, Unix-seconds.
items[].takerAddress
string
XRPL address that took liquidity.
items[].baseAmount
string
Base asset traded, decimal string.
items[].quoteAmount
string
Quote asset traded, decimal string.
items[].price
string
Execution price (quote / base), decimal string.
items[].sourceTag
object
items[].createdAt
integer
Record creation timestamp, Unix-seconds.
items[].tradePair
object
Trade pair the trade belongs to.
Example
Json
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "tradePairId": "00000000-0000-0000-0000-000000000000",
      "txHash": "string",
      "ledgerIndex": 0,
      "timestamp": 1745798400,
      "takerAddress": "string",
      "baseAmount": "string",
      "quoteAmount": "string",
      "price": "string",
      "sourceTag": 0,
      "createdAt": 1745798400,
      "tradePair": {
        "id": "00000000-0000-0000-0000-000000000000",
        "createdAt": 1745798400,
        "updatedAt": 1745798400,
        "baseCurrency": "string",
        "baseIssuer": "string",
        "quoteCurrency": "string",
        "quoteIssuer": "string"
      }
    }
  ]
}
400
application/json
Invalid input data
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
401
application/json
Authorization not provided
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
403
application/json
Insufficient access
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
500
application/json
Internal server error
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}