Skip to main content

List All Offers

GET 
/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.

Request​

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 string

    The Stellar address of the issuer of the asset being sold (base asset). Required if the selling_asset_type is not native.

    selling_asset_code string

    The code for the asset being sold (base asset). Required if the selling_asset_type is not native.

    buying_asset_type string

    Possible values: [native, credit_alphanum4, credit_alphanum12]

    The type for the asset being bought (counter asset). Either native, credit_alphanum4, or credit_alphanum12.

    buying_asset_issuer string

    The Stellar address of the issuer of the asset being bought (counter asset). Required if the buying_asset_type is not native.

    buying_asset_code string

    The code for the asset being bought (counter asset). Required if the buying_asset_type is not native.

    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

    object

    required

    href linkrequired
    templated boolean

    offer_maker

    object

    required

    href linkrequired
    templated boolean
    id id (string)required
    paging_token stringrequired
    seller address (string)required

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

    selling

    object

    required

    asset_type stringrequired
    asset_code string
    asset_issuer string

    buying

    object

    required

    asset_type stringrequired
    asset_code string
    asset_issuer string
    amount stringrequired

    price_r

    object

    required

    n int32
    d int32
    price stringrequired
    last_modified_ledger uint32required
    last_modified_time stringrequired
    sponser string

  • ]

Loading...
Last updated on by Elliot Voris