Skip to main content

List all Offers REST API Endpoint

Lists all currently open offers.

Updated on
Oct 4, 2023

List all Offers REST API Endpoint

Please note that this method can be used in streaming mode. Streaming mode allows you to listen for new offers as they are added to the Stellar ledger.

Query Parameters

sponsor
string
The account ID of the sponsor
seller
string
The account ID of the offer creator
selling_asset_type
string
The type of selling asset, which can take on one of three values: native, credit_alphanum4, or credit_alphanum12
selling_asset_issuer
string
The address of the selling asset’s issuer
selling_asset_code
string
The code for the selling asset
buying_asset_type
string
The type of buying asset, which can take on one of three values: native, credit_alphanum4, or credit_alphanum12
buying_asset_issuer
string
The address of the buying asset’s issuer
buying_asset_code
string
The code for the buying asset
cursor
integer
A number that points to a specific location in a collection of responses which is pulled from the paging_token value of a record
order
string
The designation of the order of the records. It can be ascending or descending. By default it is set to ascending
limit
integer
The maximum number of records returned

Returns

_links
object
The link object which provides links to various related resources
self
object
The self link object which contains the following field:
href
string
A link that points to the current page of offers
next
object
The next link object which contains the following field:
href
string
A link to the next page of offers, allowing for pagination
prev
object
The prev link object which contains the following field:
href
string
A link to the previous page of offers, enabling navigation backward
_embedded
object
Embedded operation object which contains the following fields:
records
array
An array containing individual trades records that match the query parameters
_links
object
Links to related resources associated with the specific offers
self
object
The self link object which contains the following field:
href
string
A link to the detailed information about the specific offer record
offer_maker
object
The offer_maker link object which contains the following field:
href
string
A link to the account of the entity that created the offer
id
string
The unique identifier of the offer
paging_token
string
The paging token for the offer record, aiding in navigation
seller
string
The public key of the account that created the offer
selling
string
Details about the asset being sold in the offer
asset_type
string
The code of the asset being sold
asset_code
string
The code of the asset being sold
asset_issuer
string
The issuer's public key of the asset being sold
buying
string
Details about the asset being bought in exchange for the selling asset
asset_type
string
he type of the asset being bought, which could be native or credit_alphanum4/12
asset_code
string
The code of the asset being bought
asset_issuer
string
The issuer's public key of the asset being bought
amount
string
The amount of the selling asset that the offer is willing to exchange
price
string
The rational representation of the price of the offer
n
integer
The numerator
d
integer
The denominator
price
string
The decimal representation of the price calculated from price_r
last_modified_ledger
string
he ledger sequence number in which the offer was last modifiedr
last_modified_time
string
The timestamp when the offer was last modified
sponsor
string
The account ID of the sponsor
Request
1
curl -L -X GET 'https://docs-demo.stellar-mainnet.quiknode.pro/offers' \
2
-H 'Accept: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free