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.
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 Request
The base currency of the trading pair, e.g., 'BTC'.
The quote currency of the trading pair, e.g., 'USDT'.
The side of the order: 'buy' or 'sell'.
The amount of the base currency to buy or sell.
Create Quote Response
Indicates whether the quote retrieval was successful. True means the quote was generated without errors.
Message confirming the result of the quote request, useful for feedback or debugging.
Unique identifier for the quote. Use this to reference or execute a trade with this quote.
The base currency of the trading pair (e.g., BTC).
The quote currency of the trading pair (e.g., USDT).
The side of the quote: BUY or SELL.
The amount of base currency for which the quote was generated.
The quoted price per unit of the base currency in terms of the quote currency.
Timestamp indicating when the quote will expire and can no longer be used. Quotes are valid for 30 seconds.
Timestamp when the quote was created.
The original quantity requested when the quote was created.
The amount of the quote that has already been used in executed trades.
The amount of the quote still available to trade. Equals original_quantity minus consumed_quantity.
Whether the quote has been fully consumed. If true, no more trades can be executed against this quote.
A summary of what will be sent and received if the quote is executed.
The amount you will send to execute the trade (e.g., 6.91 USDT).
The currency you will send (e.g., USDT for a BUY order).
The amount you will receive after the trade (e.g., 0.00010000 BTC).
The currency you will receive (e.g., BTC for a BUY order).
Contains additional request information including the unique request_id for tracking.
Timestamp when the API response was generated.
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 Request
The base currency of the trading pair, e.g., 'BTC'.
The quote currency of the trading pair, e.g., 'USDT'.
The side of the order: 'buy' or 'sell'.
The amount of the base currency to buy or sell.
The price per unit of the base currency in terms of the quote currency.
A unique identifier for the quote used to create this order. Ensures the order is executed at the intended price.
Create Order Response
Indicates whether the order submission was successful.
Message confirming the result of the order submission.
Unique identifier for the order. Can be used to query or manage the order later.
The base currency of the trading pair (e.g., 'BTC').
The quote currency of the trading pair (e.g., 'USDT').
Indicates whether the order is 'BUY' or 'SELL'.
Type of the order, e.g., 'limit' or 'market'.
The amount of base currency specified in the order.
The price per unit of base currency in terms of the quote currency.
Current status of the order (e.g., 'pending', 'filled', 'rejected').
Timestamp when the order was created.
Timestamp when the order was last updated.
Amount of base currency that has been filled so far.
Amount of base currency remaining to be filled.
The identifier of the quote used to create this order.
An array of trade fills representing partial or full executions of the order. Each fill includes id, order_id, quantity, and created_at.
Details about the quote usage for this order. Includes quote_id, consumed_quantity (amount of the quote used), and remaining_quantity (amount still available on the quote).
Contains additional request information including the unique request_id for tracking.
Timestamp when the API response was generated.
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 Response
Indicates whether the request was successful. True means orders were retrieved without errors.
Message confirming the result of the request, useful for user feedback or debugging.
Unique identifier of the order, used to reference or manage it later.
The cryptocurrency being traded (e.g., 'BTC').
The currency used to price the base currency (e.g., 'USDT').
Indicates whether the order is 'BUY' or 'SELL'.
Type of the order, e.g., 'limit' or 'market'.
Current status of the order (e.g., 'pending', 'filled', 'rejected').
Total amount of base currency in the order.
Price per unit of base currency in terms of the quote currency.
Amount of base currency that has been executed so far.
Amount of base currency still pending execution.
Exchange where the order was submitted.
Timestamp when the order was created.
Timestamp when the order was last updated.
Contains additional request information including the unique request_id for tracking.
Timestamp when the API response was generated.
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 Response
Indicates whether the request was successful.
Message confirming the result of the request.
Unique identifier for the order.
The base currency of the trading pair (e.g., 'BTC', 'USDC').
The quote currency of the trading pair (e.g., 'USDT').
Indicates whether the order is 'BUY' or 'SELL'.
Type of the order, e.g., 'limit' or 'market'.
Total amount of base currency in the order.
Price per unit of base currency in terms of the quote currency.
Current status of the order (e.g., 'pending', 'filled', 'rejected').
The exchange where the order was submitted.
Timestamp when the order was created.
Timestamp when the order was last updated.
Amount of base currency that has been filled.
Amount of base currency remaining to be filled.
Contains additional request information including the unique request_id for tracking.
Timestamp when the API response was generated.
Get Prices
Use Case
Retrieve the latest prices for all supported trading pairs. Use this to display live market rates, power conversion previews, or check prices before creating a quote.
Response Body
Indicates whether the request was successful.
A message confirming the result of the request.
A list of price objects for each supported trading pair.
The base currency of the pair (e.g., BTC, USDC).
The quote currency of the pair (e.g., USDT, USDC).
The current price of one unit of the base currency in terms of the quote currency.
Timestamp indicating when this price was last updated.
Contains the unique request_id for tracking.
Timestamp when the API response was generated.