Skip to main content

Common Enum Definitions

Public API Parameters​

Terminology​

base asset refers to the asset being traded in a trading pair, i.e., the asset listed first. quote asset refers to the pricing asset in a trading pair, i.e., the asset listed second.

Enum Definitions​

Trading Pair Type:​

FUTURE Futures

Contract Type (contractType):​

  • PERPETUAL Perpetual Contract
  • CURRENT_MONTH Current Month Delivery Contract
  • NEXT_MONTH Next Month Delivery Contract
  • CURRENT_QUARTER Current Quarter Delivery Contract
  • NEXT_QUARTER Next Quarter Delivery Contract
  • PERPETUAL_DELIVERING Contract in Delivery Settlement

Contract Status (contractStatus, status):​

  • PENDING_TRADING Pending Listing
  • TRADING Trading
  • PRE_DELIVERING Pre-Delivery
  • DELIVERING Delivering
  • DELIVERED Delivered
  • PRE_SETTLE Pre-Settlement
  • SETTLING Settling
  • CLOSE Delisted

Order Status (status):​

  • NEW New Order
  • PARTIALLY_FILLED Partially Filled
  • FILLED Fully Filled
  • CANCELED Canceled
  • REJECTED Order Rejected
  • EXPIRED Order Expired (based on timeInForce parameter rules)
  • EXPIRED_IN_MATCH Order Expired by STP

Order Types (orderTypes, type):​

  • LIMIT Limit Order
  • MARKET Market Order
  • STOP Stop Limit Order
  • STOP_MARKET Stop Market Order
  • TAKE_PROFIT Take Profit Limit Order
  • TAKE_PROFIT_MARKET Take Profit Market Order
  • TRAILING_STOP_MARKET Trailing Stop Order

Order Side (side):​

  • BUY Buy
  • SELL Sell

Position Side:​

  • BOTH Single Position Mode
  • LONG Long (in Hedge Mode)
  • SHORT Short (in Hedge Mode)

Time in Force (timeInForce):​

  • GTC - Good Till Cancel (order remains valid for 1 year after placement, then auto-canceled)
  • IOC - Immediate or Cancel: any portion that cannot be immediately filled (as taker) is canceled
  • FOK - Fill or Kill: if the order cannot be fully filled immediately, it is canceled entirely
  • GTX - Good Till Crossing: if the order cannot be a maker order, it is canceled
  • GTD - Good Till Date: valid until a specified time, auto-canceled upon expiry
  • RPI - Retail Price Improvement (only matches with orders from APP or web, and is Post Only)

Conditional Price Trigger Type (workingType)​

  • ARK_PRICE
  • CONTRACT_PRICE

Response Type (newOrderRespType)​

  • ACK
  • RESULT

Kline/Candlestick Intervals:​

  • m -> minutes; h -> hours; d -> days; w -> weeks; M -> months
  • 1m
  • 3m
  • 5m
  • 15m
  • 30m
  • 1h
  • 2h
  • 4h
  • 1d

Self-Trade Prevention Mode:​

  • EXPIRE_TAKER
  • EXPIRE_BOTH
  • EXPIRE_MAKER

Book Price Order Mode:​

  • OPPONENT (Best bid/ask price)
  • OPPONENT_5 (5th level bid/ask price)
  • OPPONENT_10 (10th level bid/ask price)
  • OPPONENT_20 (20th level bid/ask price)
  • QUEUE (Same-side best price)
  • QUEUE_5 (Same-side 5th level price)
  • QUEUE_10 (Same-side 10th level price)
  • QUEUE_20 (Same-side 20th level price)

Rate Limit Type (rateLimitType)​

Order prices must satisfy both of the following conditions:

  • Buy order: price <= markPrice * multiplierUp
  • Sell order: price >= markPrice * multiplierDown MIN_NOTIONAL Minimum Notional Value Format in /exchangeInfo response:
{
  "filterType": "MIN_NOTIONAL",
  "notional": "5.0"
}

The MIN_NOTIONAL filter defines the minimum notional value (trade amount) allowed for orders on a trading pair. The notional value of an order is price * quantity. Since MARKET orders do not have a price, the mark price is used for calculation.