exchange
Get order book
exchange
- GETRetrieve a swap configuration
- DELDelete a swap configuration
- PATCHUpdate a swap configuration
- GETList standing orders
- POSTCreate a standing order
- GETGet order book
- POSTConvert an amount from one currency to another
- GETGet rate
- DELDelete a rate
- PATCHUpdate a rate
- PATCHRemove contact from a market maker
- GETList rates
- POSTCreate a rate
- GETList supported rates
- GETList market makers
- POSTCreate a market maker
- GETList swaps
- POSTMake a swap
- GETRetrieve an order
- GETList orders
- POSTCreate an order
- GETList swap configuration
- POSTCreate a swap configuration
- PUTCancel an order
- GETGet swap rate
- POSTIncrease order book liquidity
- GETList currencies
- GETFetch current market prices
- GETRetrieve list of orders created from a standing order
- GETRetrieve market maker details for current account
- GETRetrieve a market maker
- PATCHUpdate a market maker
- GETGet swap
- PATCHAdd contact to a market maker
- GETRetrieve a standing order
- DELDelete a standing order
- PATCHUpdate a standing order
payouts
- POSTRetry failed but retryable transfer
- DELDelete transfers
- POSTAdd transfers
- GETList bulk payouts
- POSTInitiate a bulk transfer
- POSTcancel bulk transfer
- GETGet payout details
- GETGenerate a payout receipt
- GETGet charge for a payout
- GETList payouts
- POSTInitiate a payout
- GETGet bulk payout details
- POSTExecute bulk transfer
payment-lifecycle
- POSTCancel a running payment session
- GETGet merchant profile
- PATCHUpdate merchant profile
- GETGet a payment link
- PATCHUpdate a payment link
- GETExport payment details
- POSTAuthorize a captured payment session
- GETGet encryption key
- GETGet payment stats
- POSTRetry the processing of a pending outgoing payment
- GETGet a hosted payment session
- GETList payment links
- POSTCreate a payment link
- GETGet a running payment session
- POSTCapture a payment session
- PATCHUpdate a pending payment session
- POSTInitiate a payment refund
- PATCHGet merchant profile
- GETGet payment details
- GETGet payment details
- POSTInitialize a payment session
exchange
Get order book
GET
/
exchange
/
exchange
/
books
/
{symbol}
{
"data": {
"asks": [
{
"business_id": "ce8331b2-a396-46c1-9638-5db5e9cf5b2e",
"created_at": "2023-12-23T19:11:23.215",
"id": "0fe2d322-a1c7-11ee-9c0e-560f156a658b",
"percent_filled": 0,
"price": 80000,
"price_type": "limit",
"status": "open",
"time_in_force": "gtc",
"total_qty": "1",
"unfilled_qty": "1.0",
"user_id": null
}
],
"bids": [
{
"business_id": "ce8331b2-a396-46c1-9638-5db5e9cf5b2e",
"created_at": "2023-12-23T19:11:23.097",
"id": "0fd0baf2-a1c7-11ee-ae88-560f156a658b",
"percent_filled": 0,
"price": 75000,
"price_type": "limit",
"status": "open",
"time_in_force": "gtc",
"total_qty": "1",
"unfilled_qty": "1.0",
"user_id": "82dde615-d181-4f3e-8d3f-53ac7962feb7"
}
],
"max_bid": 75000,
"min_ask": 80000,
"symbol": "USD-NGN"
}
}
Path Parameters
Currency pair
Response
200
application/json
Order book
Response schema for an order book
An order book
Sell orders
An order book entry
Business ID
Creation timestamp
Order ID
Portion of order quantity filled, in basis points
Order price
Price type
Available options:
limit
, market
Available options:
open
, cancelled
, rejected
, filled
, expired
, closed
Available options:
gtc
, gtt
, ioc
, fok
Order quantity
Order type
Available options:
sell
, buy
Unfilled portion of order quantity
User ID
Buy orders
An order book entry
Business ID
Creation timestamp
Order ID
Portion of order quantity filled, in basis points
Order price
Price type
Available options:
limit
, market
Available options:
open
, cancelled
, rejected
, filled
, expired
, closed
Available options:
gtc
, gtt
, ioc
, fok
Order quantity
Order type
Available options:
sell
, buy
Unfilled portion of order quantity
User ID
Maximum bid
Minimum ask
Currency pair
{
"data": {
"asks": [
{
"business_id": "ce8331b2-a396-46c1-9638-5db5e9cf5b2e",
"created_at": "2023-12-23T19:11:23.215",
"id": "0fe2d322-a1c7-11ee-9c0e-560f156a658b",
"percent_filled": 0,
"price": 80000,
"price_type": "limit",
"status": "open",
"time_in_force": "gtc",
"total_qty": "1",
"unfilled_qty": "1.0",
"user_id": null
}
],
"bids": [
{
"business_id": "ce8331b2-a396-46c1-9638-5db5e9cf5b2e",
"created_at": "2023-12-23T19:11:23.097",
"id": "0fd0baf2-a1c7-11ee-ae88-560f156a658b",
"percent_filled": 0,
"price": 75000,
"price_type": "limit",
"status": "open",
"time_in_force": "gtc",
"total_qty": "1",
"unfilled_qty": "1.0",
"user_id": "82dde615-d181-4f3e-8d3f-53ac7962feb7"
}
],
"max_bid": 75000,
"min_ask": 80000,
"symbol": "USD-NGN"
}
}