Honeycluster Docs – List LP-token holders for an AMM pool

amm

List LP-token holders for an AMM pool

get

/amm/{ammId}/holders

operationId: pool-listHolders

Returns LP-token holders for the given pool, ordered by descending balance. share_pct is the holder's share of the pool's lp_token_supply as a percentage decimal.

Authorizations

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

Path Parameters

Name	Type	Default	Description
`ammId` required	string		AMM account identifier (XRPL classic address).

Query Parameters

Name	Type	Default	Description
`cursor`	string
`limit`	integer	`20`

Responses

200

application/json

Successful response

Field	Type	Description
`items`	object[]	Page of results.
`items[].account`	string	XRPL classic address of the LP-token holder.
`items[].balance`	string	Current LP-token balance, decimal string.
`items[].share_pct`	object	Holder's share of total LP supply, as a percentage decimal string. NULL when total LP supply is zero / unknown.
`nextCursor`	object	Cursor to fetch the next page, or null if this is the last page.

Example

Json

{
  "items": [
    {
      "account": "string",
      "balance": "string",
      "share_pct": "string"
    }
  ],
  "nextCursor": "string"
}

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