Retrieve Related Effects REST API Endpoint
Please note that this method can be used in streaming mode. Streaming mode allows you to listen for new effects referencing this liquidity pool as they are added to the Stellar ledger.
Path Parameters
liquidity_pool_id
string
REQUIRED
A unique identifier for this liquidity pool
Query Parameters
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 effects
next
object
The next link object which contains the following field:
href
string
A link to the next page of effects, allowing for pagination
prev
object
The prev link object which contains the following field:
href
string
A link to the previous page of effects, enabling navigation backward
_embedded
object
Embedded effects object which contains the following fields:
records
array
An array containing individual effects records that match the query parameters
_links
object
Links to related resources associated with the specific effects
self
object
The self link object which contains the following field:
href
string
A link to the current effects, allowing navigation to the details of the effects
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 effects'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 effects's order
id
string
The unique identifier of the effects
paging_token
string
A token used for pagination, providing a reference point for navigating between pages of effects records
account
string
The account that initiated the effects
type
string
The type of effects
type_i
integer
The numeric code representing the effects type
created_at
string
The timestamp indicating when the operation was created
liquidity_pool
object
The liquidity_pool which include the following fields:
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
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
string
The ledger sequence number in which the pool was last modifiedr
last_modified_time
string
The timestamp when the pool was last modified
reserves_deposited
array
An array of reserves_deposited objects, each containing information about a specific asset held within the liquidity pool:
amount
string
The amount of the asset held as a reserve deposite in the liquidity pool.
asset
string
The asset type and code of the reserve deposite, along with its issuer's address
shares_received
string
The amount of shares recieved
Request
1curl -L -X GET 'https://docs-demo.stellar-mainnet.quiknode.pro/liquidity_pools/092c073428d07ee3b4a6db1e285dbe989bf1c9587efdd0f1bfb403e9874ad214/effects' \2-H 'Accept: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free