Skip to main content
cURL

Query Parameters

instrument_name
string
required

Instrument name Unique instrument identifier

Example:

"BTC-PERPETUAL"

amount
number
required

It represents the requested order size. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin. For spot instruments the unit is controlled by amount_type.

amount_type
enum<string>
default:base

How the amount parameter is interpreted. Spot instruments only.

base (the default) reads amount as a quantity of the base currency, with fees charged on top of it. quote reads amount as a total spend in the quote currency, with fees included in it. For every spot order the matching base amounts are returned in taker_base_amount and maker_base_amount.

Because the taker and maker fee rates differ, a fee-inclusive spend buys a slightly different quantity in each role. Both quantities are floored to a whole multiple of the instrument's min_trade_amount, so the cost plus the fee never exceeds the requested spend. Where the fee rate is negative (a maker rebate) the cost alone exceeds the spend and the rebate brings the total back within it.

In quote mode the buy field reports the taker notional. The maker notional differs, and the fee-inclusive maker total is in maker_margin_required.

On the sell side the spend is the gross proceeds: the base amount sold is worth exactly that, and the fee is deducted from what is received. The sell quantity does not depend on the fee role, so it is the same in taker_base_amount and maker_base_amount.

Available options:
base,
quote
price
number
required

Price

Example:

3725

Response

200 - application/json

Success response

jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
result
object
required
id
integer

The id that was sent in the request