Notation

The abbreviations and terms used in this documentation are defined below. Please note that the QuBit API v1 adopts standardized designs for key parameters to provide a more unified developer experience.

Abbreviation
Full Name
Explanation

instId

Instrument ID

A string that uniquely identifies a tradable asset, e.g., BTC-USDT for Spot or BTC-USDT-SWAP for perpetual Swap.

instType

Instrument Type

The type of the instrument. SPOT, SWAP.

baseCcy

Base Currency

The currency being traded. The part before the hyphen - in an instId, e.g., BTC in BTC-USDT.

quoteCcy

Quote Currency

The currency used for pricing. The part after the hyphen - in an instId, e.g., USDT in BTC-USDT.

px

Price

The price of an order, denominated in the quoteCcy.

sz

Size (by Value)

Core Term: The size of an order, denominated uniformly in USDT. This applies to all instrument types (Spot and Swap) and represents the order's notional value.

side

Side

The direction of an order. buy or sell.

ordType

Order Type

The type of an order. limit or market.

tdMode

Trade Mode

The mode of trading. cash (for spot), cross (for cross margin/contracts), isolated (for isolated margin/contracts).

posSide

Position Side

The direction of a position. long or short. Used for leverage settings and closing positions in hedge mode.

mgnMode

Margin Mode

The margin mode. cross or isolated.

clOrdId

Client Order ID

A user-defined order ID. It is a 15-digit numeric string provided by the user when placing an order to identify it.

ordId

Order ID

The system-generated, unique ID for an order.

ccy

Currency

The currency identifier, e.g., BTC, USDT. Used in asset-related endpoints.

availBal

Available Balance

The amount of funds available for trading or withdrawal.

Last updated