Honeycluster Docs – List XRPL DEX trades (page + sort)

XRPL

List XRPL DEX trades (page + sort)

get

/xrpl/list

operationId: xrpl-list

Page-based trade list with sort + direction. Optional filters: tokenSlug (or currency+issuer) narrows to one IOU's XRP-paired trades; account narrows to one taker. Mirrors the dashboard view; pair with /xrpl/recent for the cursor-paginated firehose.

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `oracle` audience. Present as `Authorization: Bearer <token>`.

Query Parameters

Name	Type	Default	Description
`page`	integer	`1`
`pageSize`	integer	`20`
`tokenSlug`	string
`currency`	string
`issuer`	object
`account`	string
`sort`	enum<string>	`"timestamp"`	Available `timestampledger_indexpricebase_amountquote_amount`
`direction`	enum<string>	`"desc"`	Available `ascdesc`

Responses

200

application/json

Successful response

Field	Type	Description
`items`	object[]	Items on the current page.
`items[].id`	string
`items[].tradePairId`	string
`items[].txHash`	string
`items[].ledgerIndex`	integer
`items[].timestamp`	string
`items[].takerAddress`	string
`items[].baseAmount`	string
`items[].quoteAmount`	string
`items[].price`	string
`items[].createdAt`	string
`items[].tradePair`	object	Trade pair the trade belongs to.
`items[].tradePair.id`	string
`items[].tradePair.baseCurrency`	string
`items[].tradePair.baseIssuer`	object
`items[].tradePair.quoteCurrency`	string
`items[].tradePair.quoteIssuer`	object
`items[].tradePair.createdAt`	string
`items[].tradePair.updatedAt`	string
`page`	integer	1-indexed page number of the returned page.
`pageSize`	integer	Items per page (echoed from the request).
`total`	integer	Total number of items across all pages.
`pageCount`	integer	Total number of pages at the requested pageSize.

Example

Json

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "tradePairId": "00000000-0000-0000-0000-000000000000",
      "txHash": "string",
      "ledgerIndex": 0,
      "timestamp": "string",
      "takerAddress": "string",
      "baseAmount": "string",
      "quoteAmount": "string",
      "price": "string",
      "createdAt": "string",
      "tradePair": {
        "id": "00000000-0000-0000-0000-000000000000",
        "baseCurrency": "string",
        "baseIssuer": "string",
        "quoteCurrency": "string",
        "quoteIssuer": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "pageCount": 0
}

400

application/json

Invalid input data

Field	Type	Description
`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

Field	Type	Description
`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

Field	Type	Description
`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": []
}

404

application/json

Not found

Field	Type	Description
`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": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`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": []
}