Path Parameters
- liquidity_pool_idstringREQUIRED
A unique identifier for this liquidity pool
Query Parameters
- cursorinteger
A number that points to a specific location in a collection of responses which is pulled from the paging_token value of a record
- orderstring
The designation of the order of the records. It can be ascending or descending. By default it is set to ascending
- limitinteger
The maximum number of records returned
Returns
- _linksobject
The link object which provides links to various related resources
- selfobject
The self link object which contains the following field:
- hrefstring
A link that points to the current page of effects
- nextobject
The next link object which contains the following field:
- hrefstring
A link to the next page of effects, allowing for pagination
- prevobject
The prev link object which contains the following field:
- hrefstring
A link to the previous page of effects, enabling navigation backward
- _embeddedobject
Embedded effects object which contains the following fields:
- recordsarray
An array containing individual effects records that match the query parameters
- _linksobject
Links to related resources associated with the specific effects
- selfobject
The self link object which contains the following field:
- hrefstring
A link to the current effects, allowing navigation to the details of the effects
- succeedsobject
The succeeds link object which contains the following field:
- hrefstring
A link to effects with an order in descending order relative to this effects's order
- precedesobject
The precedes link object which contains the following field:
- hrefstring
A link to effects with an order in ascending order relative to this effects's order
- idstring
The unique identifier of the effects
- paging_tokenstring
A token used for pagination, providing a reference point for navigating between pages of effects records
- accountstring
The account that initiated the effects
- typestring
The type of effects
- type_iinteger
The numeric code representing the effects type
- created_atstring
The timestamp indicating when the operation was created
- liquidity_poolobject
The liquidity_pool which include the following fields:
- idstring
The unique identifier of the liquidity pool
- paging_tokenstring
A token used for pagination, providing a reference point for navigating between pages of liquidity pool records
- fee_bpinteger
The fee expressed in basis points (bp) associated with the liquidity pool.
- typestring
The type of the liquidity pool, such as constant_product
- total_trustlinesstring
The total number of trustlines associated with the liquidity pool
- total_sharesinteger
The total number of shares issued by the liquidity pool
- reservesarray
An array of reserve objects, each containing information about a specific asset held within the liquidity pool:
- amountstring
The amount of the asset held as a reserve in the liquidity pool.
- assetstring
The asset type and code of the reserve, along with its issuer's address
- last_modified_ledgerstring
The ledger sequence number in which the pool was last modifiedr
- last_modified_timestring
The timestamp when the pool was last modified
- reserves_depositedarray
An array of reserves_deposited objects, each containing information about a specific asset held within the liquidity pool:
- amountstring
The amount of the asset held as a reserve deposite in the liquidity pool.
- assetstring
The asset type and code of the reserve deposite, along with its issuer's address
- shares_receivedstring
The amount of shares recieved