Skip to main content

ENUM Definitions

This will apply for both Rest API and WebSocket API.

Symbol status (status)​

  • PRE_TRADING
  • TRADING
  • POST_TRADING
  • END_OF_DAY
  • HALT
  • AUCTION_MATCH
  • BREAK

Account and Symbol Permissions (permissions)​

  • SPOT
  • MARGIN
  • LEVERAGED
  • TRD_GRP_002
  • TRD_GRP_003
  • TRD_GRP_004
  • TRD_GRP_005
  • TRD_GRP_006
  • TRD_GRP_007
  • TRD_GRP_008
  • TRD_GRP_009
  • TRD_GRP_010
  • TRD_GRP_011
  • TRD_GRP_012
  • TRD_GRP_013
  • TRD_GRP_014
  • TRD_GRP_015
  • TRD_GRP_016
  • TRD_GRP_017
  • TRD_GRP_018
  • TRD_GRP_019
  • TRD_GRP_020
  • TRD_GRP_021
  • TRD_GRP_022
  • TRD_GRP_023
  • TRD_GRP_024
  • TRD_GRP_025

Order status (status)​

StatusDescription
NEWThe order has been accepted by the engine.
PENDING_NEWThe order is in a pending phase until the working order of an order list has been fully filled.
PARTIALLY_FILLEDA part of the order has been filled.
FILLEDThe order has been completed.
CANCELEDThe order has been canceled by the user.
PENDING_CANCELCurrently unused
REJECTEDThe order was not accepted by the engine and not processed.
EXPIREDThe order was canceled according to the order type's rules (e.g. LIMIT FOK orders with no fill, LIMIT IOC or MARKET orders that partially fill)
or by the exchange, (e.g. orders canceled during liquidation, orders canceled during maintenance)
EXPIRED_IN_MATCHThe order was expired by the exchange due to STP. (e.g. an order with EXPIRE_TAKER will match with existing orders on the book with the same account or same tradeGroupId)

Order List Status (listStatusType)​

StatusDescription
RESPONSEThis is used when the ListStatus is responding to a failed action. (E.g. order list placement or cancellation)
EXEC_STARTEDThe order list has been placed or there is an update to the order list status.
ALL_DONEThe order list has finished executing and thus is no longer active.

Order List Order Status (listOrderStatus)​

StatusDescription
EXECUTINGEither an order list has been placed or there is an update to the status of the list.
ALL_DONEAn order list has completed execution and thus no longer active.
REJECTThe List Status is responding to a failed action either during order placement or order canceled.

ContingencyType​

  • OCO
  • OTO

AllocationType​

  • SOR

Order types (orderTypes, type)​

  • LIMIT
  • MARKET
  • STOP_LOSS
  • STOP_LOSS_LIMIT
  • TAKE_PROFIT
  • TAKE_PROFIT_LIMIT
  • LIMIT_MAKER

Order Response Type (newOrderRespType)​

  • ACK
  • RESULT
  • FULL

Working Floor​

  • EXCHANGE
  • SOR

Order side (side)​

  • BUY
  • SELL

Time in force (timeInForce)​

This sets how long an order will be active before expiration.

StatusDescription
GTCGood Til Canceled
An order will be on the book unless the order is canceled.
IOCImmediate Or Cancel
An order will try to fill the order as much as it can before the order expires.
FOKFill or Kill
An order will expire if the full order cannot be filled upon execution.

Rate limiters (rateLimitType)​

  • REQUEST_WEIGHT
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000
    }
  • ORDERS
    {
      "rateLimitType": "ORDERS",
      "interval": "SECOND",
      "intervalNum": 1,
      "limit": 10
    }
  • RAW_REQUESTS
    {
      "rateLimitType": "RAW_REQUESTS",
      "interval": "MINUTE",
      "intervalNum": 5,
      "limit": 61000
    }

Rate limit intervals (interval)​

  • SECOND
  • MINUTE
  • DAY

STP Modes​

  • NONE
  • EXPIRE_MAKER
  • EXPIRE_TAKER
  • EXPIRE_BOTH