Skip to main content

Enumeration of Definitions

market_type​

  • SPOT: spot market
  • MARGIN: margin market
  • FUTURES: futures market

order_side​

  • buy: buy order
  • sell: sell order

order_type​

  • limit: Limit order (Always Valid, Good Till Cancel)
  • market: Market order
  • maker_only: Maker only order (Post only order)
  • ioc: Immediate or Cancel
  • fok: Fill or Kill

stp_mode​

  • ct: Cancel the remaining Taker orders immediately
  • cm: Cancel the remaining Maker orders immediately
  • both: Cancel the remaining Taker and Maker orders immediately

order_event​

  • put: Order placed successfully (unfilled/partially filled)
  • update: Order updated (partially filled)
  • modify: Order modified successfully (unfilled/partially filled)
  • finish: Order completed (filled or canceled)

stop_order_event​

  • put: Stop order placed successfully
  • active: Stop order triggered
  • cancel: Stop order canceled

stop_order_status​

  • put: Stop order placed successfully
  • active_success: Stop order triggered successfully
  • active_fail: Stop order trigger unsuccessful
  • cancel: Stop order canceled

trigger_direction​

  • higher: The latest price is higher than the trigger price
  • lower: The latest price is lower than the trigger price

position_event​

  • update: Position updated (opening position/partial closing/margin changes, etc.)
  • close: All positions closed
  • sys_close: All positions closed by system
  • adl: Position automatically reduced (partially/fully closed)
  • liq: Position liquidated
  • alert: Position liquidation alert

locale​

  • de-DE
  • en-US
  • es-AR
  • es-ES
  • es-MX
  • fr-FR
  • kk-KZ
  • id-ID
  • uk-UA
  • ja-JP
  • ru-RU
  • th-TH
  • pt-BR
  • tr-TR
  • vi-VN
  • zh-TW
  • ar-SA
  • hi-IN
  • fil-PH

permissions​

  • FUTURES: Futures trading permissions
  • MARGIN: Margin trading permissions
  • AMM: AMM (Automated market making) permissions
  • API: API management permissions

transfer_status​

  • created: The transfer request has been submitted
  • deducted: Assets have been deducted
  • failed: Transfer failed
  • finished: Transfer complete

loan_status​

  • loan: Borrowing loans
  • debt: In debt
  • liquidated: The loan is forcefully liquidated
  • finish: The loan has been fully repaid

deposit_status​

  • processing: deposit being processed
  • confirming: deposit awaiting block confirmations
  • cancelled: deposit canceled
  • finished: deposit credited
  • too_small: deposit amount lower than the minimum limit
  • exception: the deposit cannot be processed as usual

withdraw_status​

  • created: 'withdrawal pending for Email confirmation'
  • audit_required: 'withdrawal to be audited'
  • audited: 'withdrawal approved'
  • processing: 'withdrawal being processed'
  • confirming: 'withdrawal awaiting block confirmations'
  • finished: 'withdrawal complete'
  • cancelled: 'withdrawal canceled'
  • cancellation_failed: 'withdrawal cancellation failed'
  • failed: 'withdrawal failed'

order_status​

  • open: the order is placed and pending execution;
  • part_filled: order partially executed (still pending);
  • filled: order fully executed (completed);
  • part_canceled: order partially executed and then canceled;
  • canceled: the order is canceled; to maintain server performance, any canceled orders without execution will not be saved.

contract_type​

  • linear: linear contract (USDT-margined contract), which uses USDT or other stable coins as quote currency, settlement currency, and margin.
  • inverse: inverse contract (Coin-margined contract), which uses the base currency for both settlement and margin, while USD is used as the quote currency.

margin_mode​

  • isolated: isolated margin. In Isolated Margin mode, the margin for each position is separate and cannot be shared with other positions. The system won't add margin automatically, and any additional margin needs to be manually added by the user.
  • cross: cross margin. In Cross Margin mode, all available balances in the Futures account can be used as a shared margin for all current positions. To avoid forced liquidation, the system will add margin automatically by using the available balance in the Futures account.

take_profit_type​

  • latest_price: current market price
  • mark_price: mark price

stop_loss_type​

  • latest_price: current market price
  • mark_price: mark price

position_side​

  • short: short position
  • long: long position

position_finished_type​

  • liq: Close position by forced liquidation
  • adl: Close position by ADL
  • sys: Close position by system
  • limit: Close position at limit price
  • market: Close position at market price
  • market_close_all: Close all positions at market price
  • take_profit: Take profit and close position
  • stop_loss: Stop loss and close position

trigger_price_type​

  • latest_price: current market price
  • mark_price: mark price
  • index_price: index price

transcation_type​

  • deposit: Deposit
  • withdraw: Withdraw
  • trade: Trade
  • maker_cash_back: Maker cashback