Skip to main content

List All Trades

GET 
/trades

This endpoint lists all trades and can be used in streaming mode. Streaming mode allows you to listen for new trades as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known trade unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream trades created since your request time. When filtering for a specific orderbook, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.

Request​

Query Parameters

    offer_id any

    The offer ID. Used to filter for trades originating from a specific offer.

    base_asset_type string

    Possible values: [native, credit_alphanum4, credit_alphanum12]

    The type for the base asset. Either native, credit_alphanum4, or credit_alphanum12.

    base_asset_issuer string

    The Stellar address of the base asset’s issuer.

    base_asset_code string

    The code for the base asset.

    counter_asset_type string

    Possible values: [native, credit_alphanum4, credit_alphanum12]

    The type for the counter asset. Either native, credit_alphanum4, or credit_alphanum12.

    counter_asset_issuer string

    The Stellar address of the counter asset’s issuer.

    counter_asset_code any

    The code for the counter asset.

    trade_type string

    Possible values: [all, orderbook, liquidity_pools]

    Can be set to all, orderbook, or liquidity_pools to filter only trades executed across a given mechanism.

    cursor integer

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

    order string

    Possible values: [asc, desc]

    A designation of the order in which records should appear. Options include asc (ascending) or desc (descending). If this argument isn’t set, it defaults to asc.

    limit integer

    The maximum number of records returned. The limit can range from 1 to 200 - an upper limit that is hardcoded in Horizon for performance reasons. If this argument isn’t designated, it defaults to 10.

Responses​

Success

Schema
    _links object
    self object
    href linkrequired
    templated boolean
    next object
    href linkrequired
    templated boolean
    prev object
    href linkrequired
    templated boolean
    _embedded object
    records object[]
  • Array [
    • _links object
    self objectrequired
    href linkrequired
    templated boolean
    base objectrequired
    href linkrequired
    templated boolean
    counter objectrequired
    href linkrequired
    templated boolean
    operation objectrequired
    href linkrequired
    templated boolean
    id id (string)
    paging_token paging_token (string)
    ledger_close_time string
    offer_id string
    trade_type string
    liquidity_pool_fee_bp uint32
    base_liquidity_pool_id string
    base_offer_id string
    base_account address (string)

    Possible values: Value must match regular expression G[A-Z0-9]{55}

    base_amount string
    base_asset_type string
    base_asset_code string
    base_asset_issuer string
    counter_liquidity_pool_id string
    counter_offer_id string
    counter_account address (string)

    Possible values: Value must match regular expression G[A-Z0-9]{55}

    counter_amount string
    counter_asset_type string
    counter_asset_code string
    counter_asset_issuer address (string)

    Possible values: Value must match regular expression G[A-Z0-9]{55}

    base_is_seller boolean
    price object
    n string
    d string
  • ]
Loading...
Last updated on by Jane Wang