Skip to main content

Retrieve Related Trades REST API Endpoint

Retrieve successful trades fulfilled by the given liquidity pool.

Updated on
Oct 04, 2023
Please note that this method can be used in streaming mode. Streaming mode allows you to listen for new trades 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 liquidity pools

next
object

The next link object which contains the following field:

href
string

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

prev
object

The prev link object which contains the following field:

href
string

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

_embedded
object

Embedded operation object which contains the following fields:

records
array

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

_links
object

Links to related resources associated with the specific liquidity pools

operation
object

The operation link object which contains the following field:

href
string

A link to the operation associated with the liquidity pools

self
object

The self link object which contains the following field:

href
string

A link to the detailed information about the specific liquidity pools record

counter
object

The counter link object which contains the following field:

href
string

A link to the account of the entity that received the counter asset in the liquidity pools

base
object

The counter link object which contains the following field:

href
string

A link to the account of the entity that provided the base asset for the liquidity pools

id
string

A unique identifier for the trade record

paging_token
string

The paging token for the trade record, aiding in navigation

ledger_close_time
string

An ISO 8601 formatted string of when the ledger with this trade was closed

offer_id
string

The identifier for the offer that initiated the trade

base_offer_id
string

The base offer ID

base_account
string

The account ID of the base party for this trade

base_amount
string

The amount of the base asset involved in the trade

base_asset_type
string

The type of base asset, which can take on one of three values: native, credit_alphanum4, or credit_alphanum12

base_asset_issuer
string

The address of the base asset’s issuer

base_asset_code
string

The code for the base asset

base_asset_code
string

The code for the base asset

counter_liquidity_pool
string

Identifies the liquidity pool associated with the counter asset

liquidity_pool_fee_bp
string

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

base_liquidity_pool_id
string

A unique identifier for the liquidity pool that represents the base asset in a trading pair.

counter_offer_id
string

The counter offer ID

counter_account
integer

The account ID of the base party for this trade

counter_amount
string

The amount of the counter asset involved in the trade

counter_asset_type
string

The type of counter asset, which can take on one of three values: native, credit_alphanum4, or credit_alphanum12

base_is_seller
boolean

A flag indicating whether the entity with the base account is the seller in the trade

price
string

The price of the trade, represented as a fraction with a numerator (n) and a denominator (d)

n
integer

The numerator

d
integer

The denominator

trade_type
string

The type of trade

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