Bitnob Black Logo

Trading

The Trading section provides APIs to create, retrieve, and manage buy/sell orders for supported currency pairs. It also allows you to generate quotes, fetch current prices, and monitor market activity. These APIs are essential for integrating trading functionalities into your applications, enabling users to execute trades, track orders, and stay updated with live market prices.

Trading API Endpoints

Create Quote

The Quotes endpoint allows users to get a real-time price estimate for buying or selling a specific amount of a currency. Use this before placing an order to lock in a price.

Create Quote
Create Quote Request
1
base_currencystringRequired

The base currency of the trading pair, e.g., 'BTC'.

2
quote_currencystringRequired

The quote currency of the trading pair, e.g., 'USDT'.

3
sidestringRequired

The side of the order: 'buy' or 'sell'.

4
quantitystringRequired

The amount of the base currency to buy or sell.

Sample Quote Request
Create Quote Response
1
successboolean

Indicates whether the quote retrieval was successful. True means the quote was generated without errors.

2
messagestring

Message confirming the result of the quote request, useful for feedback or debugging.

3
idstring (UUID)

Unique identifier for the quote. Can be used to reference or execute the order using this quote.

4
base_currencystring

The base currency of the trading pair (e.g., 'BTC').

5
quote_currencystring

The quote currency of the trading pair (e.g., 'USDT').

6
sidestring

The side of the quote: 'BUY' or 'SELL'.

7
quantitystring

The amount of base currency for which the quote was generated.

8
pricestring

The quoted price per unit of the base currency in terms of the quote currency.

9
spread_bpsnumber

The spread applied to the quote, expressed in basis points (bps).

10
expires_atstring (ISO 8601)

Timestamp indicating when the quote will expire and can no longer be used.

11
created_atstring (ISO 8601)

Timestamp when the quote was created.

12
metadataobject

Contains additional request information including the unique request_id for tracking.

13
timestampstring (ISO 8601)

Timestamp when the API response was generated.

Sample Quote Response

Create Order

Submit a new order to buy or sell a specific amount of a trading pair. Use the quote_id from a previously generated quote to ensure the order is executed at the intended price.

Create Order
Create Order Request
1
base_currencystringRequired

The base currency of the trading pair, e.g., 'BTC'.

2
quote_currencystringRequired

The quote currency of the trading pair, e.g., 'USDT'.

3
sidestringRequired

The side of the order: 'buy' or 'sell'.

4
quantitystringRequired

The amount of the base currency to buy or sell.

5
pricestringRequired

The price per unit of the base currency in terms of the quote currency.

6
quote_idstring (UUID)Required

A unique identifier for the quote used to create this order. Ensures the order is executed at the intended price.

7
metadataobject

Optional metadata to attach to the order. Can include custom references or tags for tracking purposes.

Sample Create Order Request
Create Order Response
1
successboolean

Indicates whether the order submission was successful.

2
messagestring

Message confirming the result of the order submission.

3
idstring (UUID)

Unique identifier for the order. Can be used to query or manage the order later.

4
base_currencystring

The base currency of the trading pair (e.g., 'BTC').

5
quote_currencystring

The quote currency of the trading pair (e.g., 'USDT').

6
sidestring

Indicates whether the order is 'BUY' or 'SELL'.

7
order_typestring

Type of the order, e.g., 'limit' or 'market'.

8
quantitystring

The amount of base currency specified in the order.

9
pricestring

The price per unit of base currency in terms of the quote currency.

10
statusstring

Current status of the order (e.g., 'pending', 'filled', 'rejected').

11
exchangestring

The exchange where the order was submitted.

12
created_atstring (ISO 8601)

Timestamp when the order was created.

13
updated_atstring (ISO 8601)

Timestamp when the order was last updated.

14
filled_quantitystring

Amount of base currency that has been filled so far.

15
remaining_quantitystring

Amount of base currency remaining to be filled.

16
fillsarray

An array of trade fills representing partial or full executions of the order.

17
metadataobject

Contains additional request information including the unique request_id for tracking.

18
timestampstring (ISO 8601)

Timestamp when the API response was generated.

Sample Create Order Response

Get Orders

Retrieves a list of all orders for the user. Each order includes its status, quantities, price, and exchange details, helping you track all trading activity quickly.

Get Orders
Get Orders Response
1
successboolean

Indicates whether the request was successful. True means orders were retrieved without errors.

2
messagestring

Message confirming the result of the request, useful for user feedback or debugging.

3
idstring (UUID)

Unique identifier of the order, used to reference or manage it later.

4
base_currencystring

The cryptocurrency being traded (e.g., 'BTC').

5
quote_currencystring

The currency used to price the base currency (e.g., 'USDT').

6
sidestring

Indicates whether the order is 'BUY' or 'SELL'.

7
order_typestring

Type of the order, e.g., 'limit' or 'market'.

8
statusstring

Current status of the order (e.g., 'pending', 'filled', 'rejected').

9
quantitystring

Total amount of base currency in the order.

10
pricestring

Price per unit of base currency in terms of the quote currency.

11
filled_quantitystring

Amount of base currency that has been executed so far.

12
remaining_quantitystring

Amount of base currency still pending execution.

13
exchangestring

Exchange where the order was submitted.

14
created_atstring (ISO 8601)

Timestamp when the order was created.

15
updated_atstring (ISO 8601)

Timestamp when the order was last updated.

16
metadataobject

Contains additional request information including the unique request_id for tracking.

17
timestampstring (ISO 8601)

Timestamp when the API response was generated.

Sample Get Orders Response

Get Order By ID

Retrieve detailed information about a specific order using its unique ID. This endpoint returns the order's current status, filled and remaining quantities, price, and timestamps.

Get Order By ID
Get Order By ID Response
1
successboolean

Indicates whether the request was successful.

2
messagestring

Message confirming the result of the request.

3
idstring (UUID)

Unique identifier for the order.

4
base_currencystring

The base currency of the trading pair (e.g., 'BTC', 'USDC').

5
quote_currencystring

The quote currency of the trading pair (e.g., 'USDT').

6
sidestring

Indicates whether the order is 'BUY' or 'SELL'.

7
order_typestring

Type of the order, e.g., 'limit' or 'market'.

8
quantitystring

Total amount of base currency in the order.

9
pricestring

Price per unit of base currency in terms of the quote currency.

10
statusstring

Current status of the order (e.g., 'pending', 'filled', 'rejected').

11
exchangestring

The exchange where the order was submitted.

12
created_atstring (ISO 8601)

Timestamp when the order was created.

13
updated_atstring (ISO 8601)

Timestamp when the order was last updated.

14
filled_quantitystring

Amount of base currency that has been filled.

15
remaining_quantitystring

Amount of base currency remaining to be filled.

16
metadataobject

Contains additional request information including the unique request_id for tracking.

17
timestampstring (ISO 8601)

Timestamp when the API response was generated.

Sample Get Order By ID Response
Did you find this page useful?