Query Parameters
- sponsorstring
The account ID of the sponsor
- sellerstring
The account ID of the offer creator
- selling_asset_typestring
The type of selling asset, which can take on one of three values: native, credit_alphanum4, or credit_alphanum12
- selling_asset_issuerstring
The address of the selling asset’s issuer
- selling_asset_codestring
The code for the selling asset
- buying_asset_typestring
The type of buying asset, which can take on one of three values: native, credit_alphanum4, or credit_alphanum12
- buying_asset_issuerstring
The address of the buying asset’s issuer
- buying_asset_codestring
The code for the buying asset
- cursorinteger
A number that points to a specific location in a collection of responses which is pulled from the paging_token value of a record
- orderstring
The designation of the order of the records. It can be ascending or descending. By default it is set to ascending
- limitinteger
The maximum number of records returned
Returns
- _linksobject
The link object which provides links to various related resources
- selfobject
The self link object which contains the following field:
- hrefstring
A link that points to the current page of offers
- nextobject
The next link object which contains the following field:
- hrefstring
A link to the next page of offers, allowing for pagination
- prevobject
The prev link object which contains the following field:
- hrefstring
A link to the previous page of offers, enabling navigation backward
- _embeddedobject
Embedded operation object which contains the following fields:
- recordsarray
An array containing individual trades records that match the query parameters
- _linksobject
Links to related resources associated with the specific offers
- selfobject
The self link object which contains the following field:
- hrefstring
A link to the detailed information about the specific offer record
- offer_makerobject
The offer_maker link object which contains the following field:
- hrefstring
A link to the account of the entity that created the offer
- idstring
The unique identifier of the offer
- paging_tokenstring
The paging token for the offer record, aiding in navigation
- sellerstring
The public key of the account that created the offer
- sellingstring | object
Details about the asset being sold in the offer
- asset_typestring
The code of the asset being sold
- asset_codestring
The code of the asset being sold
- asset_issuerstring
The issuer's public key of the asset being sold
- buyingstring | object
Details about the asset being bought in exchange for the selling asset
- asset_typestring
he type of the asset being bought, which could be native or credit_alphanum4/12
- asset_codestring
The code of the asset being bought
- asset_issuerstring
The issuer's public key of the asset being bought
- amountstring
The amount of the selling asset that the offer is willing to exchange
- pricestring
The rational representation of the price of the offer
- ninteger
The numerator
- dinteger
The denominator
- pricestring
The decimal representation of the price calculated from price_r
- last_modified_ledgernumber | string
he ledger sequence number in which the offer was last modifiedr
- last_modified_timestring | null
The timestamp when the offer was last modified
- sponsorstring
The account ID of the sponsor