Retrieve an Offer's Trades

GET 
/offers/:offer_id/trades

This endpoint represents all trades for a given offer and can be used in streaming mode. Streaming mode allows you to listen for trades for this offer 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.

Request

Path Parameters

offer_id anyrequired

A unique identifier for this offer.

Query Parameters

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

200

Success

application/json

Schema

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

object

required

href linkrequired

templated boolean

base

object

required

href linkrequired

templated boolean

counter

object

required

href linkrequired

templated boolean

operation

object

required

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

]

Example (from schema)

{
  "_links": {
    "self": {
      "href": "string",
      "templated": true
    },
    "next": {
      "href": "string",
      "templated": true
    },
    "prev": {
      "href": "string",
      "templated": true
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "self": {
            "href": "string",
            "templated": true
          },
          "base": {
            "href": "string",
            "templated": true
          },
          "counter": {
            "href": "string",
            "templated": true
          },
          "operation": {
            "href": "string",
            "templated": true
          }
        },
        "id": "string",
        "paging_token": "string",
        "ledger_close_time": "string",
        "offer_id": "string",
        "trade_type": "string",
        "liquidity_pool_fee_bp": 0,
        "base_liquidity_pool_id": "string",
        "base_offer_id": "string",
        "base_account": "string",
        "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": "string",
        "counter_amount": "string",
        "counter_asset_type": "string",
        "counter_asset_code": "string",
        "counter_asset_issuer": "string",
        "base_is_seller": true,
        "price": {
          "n": "string",
          "d": "string"
        }
      }
    ]
  }
}

GetTradesByOfferId

{
  "_links": {
    "self": {
      "href": "https://horizon-testnet.stellar.org/offers/104078276/trades?cursor=&limit=3&order=asc"
    },
    "next": {
      "href": "https://horizon-testnet.stellar.org/offers/104078276/trades?cursor=107449584845914113-0&limit=3&order=asc"
    },
    "prev": {
      "href": "https://horizon-testnet.stellar.org/offers/104078276/trades?cursor=107449468881756161-0&limit=3&order=desc"
    }
  },
  "_embedded": {
    "records": [
      {
        "_links": {
          "self": {
            "href": ""
          },
          "base": {
            "href": "https://horizon-testnet.stellar.org/accounts/GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX"
          },
          "counter": {
            "href": "https://horizon-testnet.stellar.org/accounts/GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K"
          },
          "operation": {
            "href": "https://horizon-testnet.stellar.org/operations/107449468881756161"
          }
        },
        "id": "107449468881756161-0",
        "paging_token": "107449468881756161-0",
        "ledger_close_time": "2019-07-26T09:17:02Z",
        "offer_id": "104078276",
        "base_offer_id": "104078276",
        "base_account": "GCO7OW5P2PP7WDN6YUDXUUOPAR4ZHJSDDCZTIAQRTRZHKQWV45WUPBWX",
        "base_amount": "4433.2000000",
        "base_asset_type": "native",
        "counter_offer_id": "4719135487309144065",
        "counter_account": "GD3CJYUTZAY6JQF4CEI6Z7VW5O6VNGKZTBYUECTOJPEDTB7I2HZSPI2K",
        "counter_amount": "443.3200000",
        "counter_asset_type": "credit_alphanum4",
        "counter_asset_code": "BB1",
        "counter_asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN",
        "base_is_seller": true,
        "price": {
          "n": 1,
          "d": 10
        }
      }
    ]
  }
}

Loading...