Skip to main content

List All Offers​

This endpoint lists all currently open offers and can be used in streaming mode. Streaming mode allows you to listen for new offers as they are added to the Stellar ledger. If called in streaming mode, Horizon will start at the earliest known offer unless a cursor is set, in which case it will start from that cursor. By setting the cursor value to now, you can stream offers created since your request time. When filtering by buying or selling arguments, you must use a combination of selling_asset_type, selling_asset_issuer, and selling_asset_code for the selling asset, or a combination of buying_asset_type, buying_asset_issuer, and buying_asset_code for the buying asset.

Query Parameters
  • sponser string

    Account ID of the sponsor. Every account in the response will either be sponsored by the given account ID or have a subentry (trustline, offer, or data entry) which is sponsored by the given account ID.

  • seller any

    The account ID of the offer creator.

  • selling_asset_type string

    Possible values: [native, credit_alphanum4, credit_alphanum12]

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

  • selling_asset_issuer any

    The Stellar address of the selling asset’s issuer.

  • selling_asset_code any

    The code for the selling asset.

  • buying_asset_type string

    Possible values: [native, credit_alphanum4, credit_alphanum12]

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

  • buying_asset_issuer any

    The Stellar address of the buying asset’s issuer.

  • buying_asset_code any

    The code for the buying asset.

  • 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 link required
  • templated boolean
  • next object
  • href link required
  • templated boolean
  • prev object
  • href link required
  • templated boolean
  • _embedded object
  • records object[]
  • Array [
  • _links object
  • self object required
  • href link required
  • templated boolean
  • offer_maker object required
  • href link required
  • templated boolean
  • id id required
  • paging_token string required
  • seller address required

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

  • selling object required
  • asset_type string required
  • asset_code string
  • asset_issuer string
  • buying object required
  • asset_type string required
  • asset_code string
  • asset_issuer string
  • amount string required
  • price_r object required
  • n int32
  • d int32
  • price string required
  • last_modified_ledger uint32 required
  • last_modified_time string required
  • sponser string
  • ]
Loading...
Last updated on