Skip to main content

Retrieve an Order Book REST API Endpoint

Retrieves an order book's bids and asks for a specific asset pair. Can be used in streaming mode

Updated on
Sep 05, 2025
Please note that this method can be used in streaming mode. To read more about this, visit the streaming section.

Query Parameters

selling_asset_type
string
REQUIRED

The type of the asset being sold. Either 'native', 'credit_alphanum4', or 'credit_alphanum12'

selling_asset_issuer
string

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

selling_asset_code
string

The code for the asset being sold. Required if the selling_asset_type is not 'native'

buying_asset_type
string
REQUIRED

The type of the asset being bought. Either 'native', 'credit_alphanum4', or 'credit_alphanum12'

buying_asset_issuer
string

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

buying_asset_code
string

The code for the asset being bought. Required if the buying_asset_type is not 'native'

limit
integer

The maximum number of records to return for bids and asks

Returns

bids
array

An array of bid offers

price_r
object

The price as a rational number

n
integer

The numerator

d
integer

The denominator

price
string

The price as a decimal string

amount
string

The amount of the asset being offered

asks
array

An array of ask offers

price_r
object

The price as a rational number

n
integer

The numerator

d
integer

The denominator

price
string

The price as a decimal string

amount
string

The amount of the asset being offered

base
object

Details about the base asset

asset_type
string

The type of the base asset

asset_code
string

(Optional) The code of the base asset

asset_issuer
string

(Optional) The issuer of the base asset

counter
object

Details about the counter asset

asset_type
string

The type of the counter asset

asset_code
string

The code of the counter asset

asset_issuer
string

The issuer of the counter asset

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free