Skip to main content

List all Liquidity Pools REST API Endpoint

Lists all available liquidity pools.

Updated on
Oct 04, 2023

Query Parameters

reserves
string

A Comma-separated list of assets in canonical form

account
string

The account id for which the liquidity pool is to be fetched

cursor
integer

A number that points to a specific location in a collection of responses which is pulled from the paging_token value of a record

order
string

The designation of the order of the records. It can be ascending or descending. By default it is set to ascending

limit
integer

The maximum number of records returned

Returns

_links
object

The link object which provides links to various related resources

self
object

The self link object which contains the following field:

href
string

A link that points to the current page of liquidity pool

next
object

The next link object which contains the following field:

href
string

A link to the next page of liquidity pool, allowing for pagination

prev
object

The prev link object which contains the following field:

href
string

A link to the previous page of liquidity pool, enabling navigation backward

_embedded
object

Embedded operation object which contains the following fields:

records
array

An array containing individual liquidity pool records that match the query parameters

_links
object

Links to related resources associated with the specific liquidity pool

self
object

The self link object which contains the following field:

href
string

A link to the current liquidity pool, allowing navigation to the details of the operation

transaction
object

The transaction link object which contains the following field:

href
string

A link to the transaction containing the liquidity pool, enabling access to the details of the parent transaction

effects
object

The effects link object which contains the following field:

href
string

A link to the effects associated with the liquidity pool

succeeds
object

The succeeds link object which contains the following field:

href
string

A link to effects with an order in descending order relative to this liquidity pool's order

precedes
object

The precedes link object which contains the following field:

href
string

A link to effects with an order in ascending order relative to this liquidity pool's order

id
string

The unique identifier of the liquidity pool

paging_token
string

A token used for pagination, providing a reference point for navigating between pages of liquidity pool records

fee_bp
integer

The fee expressed in basis points (bp) associated with the liquidity pool.

type
string

The type of the liquidity pool, such as constant_product

total_trustlines
string

The total number of trustlines associated with the liquidity pool

total_shares
integer | string

The total number of shares issued by the liquidity pool

reserves
array

An array of reserve objects, each containing information about a specific asset held within the liquidity pool:

amount
string

The amount of the asset held as a reserve in the liquidity pool.

asset
string

The asset type and code of the reserve, along with its issuer's address

last_modified_ledger
number | string

The ledger sequence number in which the pool was last modifiedr

last_modified_time
string | null

The timestamp when the pool was last modified

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free