Retrieve an Order Book
The order book endpoint provides an order book’s bids and asks and can be used in streaming mode. When filtering for a specific order book, you must use use all six of these arguments: base_asset_type, base_asset_issuer, base_asset_code, counter_asset_type, counter_asset_issuer, and counter_asset_code. If the base or counter asset is XLM, you only need to indicate the asset type as native and do not need to designate the code or the issuer.
Path Parameters
- selling_asset_type string required
Possible values: [
native
,credit_alphanum4
,credit_alphanum12
]The type for the selling asset. Either native, credit_alphanum4, or credit_alphanum12.
Query Parameters
- 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.
- 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.
- 200
Success
- application/json
- Schema
- Example (from schema)
- RetrieveAnOrderBook
Schema
bids object[]
Array [price_r object
n integerd integerprice stringamount string]asks object[]
Array [price_r object
n integerd integerprice stringamount string]base object
asset_type stringcounter object
asset_type stringasset_code stringasset_issuer addressPossible values: Value must match regular expression
G[A-Z0-9]{55}
{
"bids": [
{
"price_r": {
"n": 0,
"d": 0
},
"price": "string",
"amount": "string"
}
],
"asks": [
{
"price_r": {
"n": 0,
"d": 0
},
"price": "string",
"amount": "string"
}
],
"base": {
"asset_type": "string"
},
"counter": {
"asset_type": "string",
"asset_code": "string",
"asset_issuer": "string"
}
}
{
"bids": [
{
"price_r": {
"n": 10000000,
"d": 139999999
},
"price": "0.0714286",
"amount": "24.9999990"
},
{
"price_r": {
"n": 1,
"d": 14
},
"price": "0.0714286",
"amount": "188.0000000"
},
{
"price_r": {
"n": 1,
"d": 15
},
"price": "0.0666667",
"amount": "230.3200000"
},
{
"price_r": {
"n": 1,
"d": 16
},
"price": "0.0625000",
"amount": "50.0000000"
}
],
"asks": [
{
"price_r": {
"n": 5000000,
"d": 62500001
},
"price": "0.0800000",
"amount": "4.9400001"
},
{
"price_r": {
"n": 10000000,
"d": 125000001
},
"price": "0.0800000",
"amount": "2516.5154327"
},
{
"price_r": {
"n": 2,
"d": 25
},
"price": "0.0800000",
"amount": "3125.0000000"
},
{
"price_r": {
"n": 4,
"d": 49
},
"price": "0.0816327",
"amount": "4593.7500000"
}
],
"base": {
"asset_type": "native"
},
"counter": {
"asset_type": "credit_alphanum4",
"asset_code": "BB1",
"asset_issuer": "GD5J6HLF5666X4AZLTFTXLY46J5SW7EXRKBLEYPJP33S33MXZGV6CWFN"
}
}