Honeycluster Docs – Batch lookup AMM pools by ammId

amm

Batch lookup AMM pools by ammId

post

/amm/batch

operationId: pool-getDetails

Batch AMM-pool lookup by on-chain ammId (XRPL classic address). Body: { "ammIds": ["r…", "r…"] } (max 100). Returns each matched pool's raw row; unmatched ammIds are silently omitted. Prefer this over N parallel calls to /amm/{ammId}.

Authorizations

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

Request Body

application/json

required

Field	Type	Description
`ammIds` required	string[]	AMM account identifiers (XRPL classic addresses) to resolve. Max 100 per request. Unmatched ammIds are silently omitted.

Example

Json

{
  "ammIds": [
    "string"
  ]
}

Responses

200

application/json

Successful response

Field	Type	Description
`items`	object[]	Resolved pools. One entry per matched ammId; unmatched ammIds are silently omitted.
`items[].id`	string	Auto-generated UUID primary key.
`items[].ammId`	string	On-ledger AMM account identifier.
`items[].asset1Currency`	string	First pool asset currency code.
`items[].asset1Issuer`	object
`items[].asset2Currency`	string	Second pool asset currency code.
`items[].asset2Issuer`	object
`items[].lpTokenCurrency`	string	LP token currency code.
`items[].lpTokenIssuer`	string	LP token issuer address.
`items[].asset1Reserve`	string	Current asset1 reserve balance, decimal string.
`items[].asset2Reserve`	string	Current asset2 reserve balance, decimal string.
`items[].lpTokenSupply`	string	Outstanding LP token supply, decimal string.
`items[].tradingFee`	integer	Pool trading fee in basis points (0–1000; 1000 = 1%).
`items[].ownerAddress`	object
`items[].ledgerIndex`	integer	Ledger sequence of the most recent update.
`items[].createdAt`	integer	Record creation timestamp, Unix-seconds.
`items[].updatedAt`	integer	Record update timestamp, Unix-seconds.

Example

Json

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "ammId": "string",
      "asset1Currency": "string",
      "asset1Issuer": "string",
      "asset2Currency": "string",
      "asset2Issuer": "string",
      "lpTokenCurrency": "string",
      "lpTokenIssuer": "string",
      "asset1Reserve": "string",
      "asset2Reserve": "string",
      "lpTokenSupply": "string",
      "tradingFee": 0,
      "ownerAddress": "string",
      "ledgerIndex": 0,
      "createdAt": 1745798400,
      "updatedAt": 1745798400
    }
  ]
}

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": []
}

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": []
}