Exchange information
Query current exchange trading rules, rate limits, and symbol information.
Exchange information › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Exchange information › Request Parameters optional
idClient-generated request identifier.
methodWebSocket API method name.
symbolDescribe a single symbol
symbolsDescribe multiple symbols
permissionsFilter symbols by permissions
showPermissionSetsControls whether the content of the permissionSets field is populated or not. Defaults to true.
symbolStatusFilters for symbols that have this tradingStatus. Valid values: TRADING, HALT, BREAK. Cannot be used in combination with symbol or symbols.
Exchange information › Responses
Exchange information
idstatustimezoneserverTimerateLimitTypeintervalintervalNumlimitcountDecision Table
| Variant | Matching Criteria |
|---|---|
| type = object · filterType="EXCHANGE_MAX_NUM_ORDERS" | |
| type = object · filterType="EXCHANGE_MAX_NUM_ALGO_ORDERS" | |
| type = object · filterType="EXCHANGE_MAX_NUM_ICEBERG_ORDERS" | |
| type = object · filterType="EXCHANGE_MAX_NUM_ORDER_LISTS" |
filterTypemaxNumOrderssymbolstatusbaseAssetbaseAssetPrecisionquoteAssetquotePrecisionquoteAssetPrecisionbaseCommissionPrecisionquoteCommissionPrecisionorderTypesicebergAllowedocoAllowedotoAllowedopoAllowedquoteOrderQtyMarketAllowedallowTrailingStopcancelReplaceAllowedamendAllowedpegInstructionsAllowedisSpotTradingAllowedisMarginTradingAllowedDecision Table
| Variant | Matching Criteria |
|---|---|
| type = object · filterType="PRICE_FILTER" | |
| type = object · filterType="PERCENT_PRICE" | |
| type = object · filterType="PERCENT_PRICE_BY_SIDE" | |
| type = object · filterType="LOT_SIZE" | |
| type = object · filterType="MIN_NOTIONAL" | |
| type = object · filterType="NOTIONAL" | |
| type = object · filterType="ICEBERG_PARTS" | |
| type = object · filterType="MARKET_LOT_SIZE" | |
| type = object · filterType="MAX_NUM_ORDERS" | |
| type = object · filterType="MAX_NUM_ALGO_ORDERS" | |
| type = object · filterType="MAX_NUM_ICEBERG_ORDERS" | |
| type = object · filterType="MAX_POSITION" | |
| type = object · filterType="TRAILING_DELTA" | |
| type = object · filterType="T_PLUS_SELL" | |
| type = object · filterType="MAX_NUM_ORDER_LISTS" | |
| type = object · filterType="MAX_NUM_ORDER_AMENDS" |
filterTypepriceExponentminPricemaxPricetickSizepermissionspermissionSetsdefaultSelfTradePreventionModeallowedSelfTradePreventionModesbaseAssetsymbolsQuery Execution Rules
Query execution rules for symbols.
Query Execution Rules › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
| Parameter | Weight |
|---|---|
symbol | 2 |
symbols | 2 for each symbol, capped at a max of 40 |
symbolStatus | 40 |
| None | 40 |
Query Execution Rules › Request Parameters optional
idClient-generated request identifier.
methodWebSocket API method name.
symbolQuery for specified symbol.
symbolsQuery for multiple symbols.
symbolStatusQuery for all symbols with the specified status. Supported values: TRADING, HALT, BREAK
Query Execution Rules › Responses
Query Execution Rules
idstatussymbolruleTypebidLimitMultUpbidLimitMultDownaskLimitMultUpaskLimitMultDownTest connectivity
Test connectivity to the WebSocket API.
Note: You can use regular WebSocket ping frames to test connectivity as well, WebSocket API will respond with pong frames as soon as possible. ping request along with time is a safe way to test request-response handling in your application.
Test connectivity › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Test connectivity › Request Parameters optional
idClient-generated request identifier.
methodWebSocket API method name.
paramsTest connectivity › Responses
Test connectivity
idstatusresultrateLimitTypeintervalintervalNumlimitcountCheck server time
Test connectivity to the WebSocket API and get the current server time.
Check server time › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Check server time › Request Parameters optional
idClient-generated request identifier.
methodWebSocket API method name.
paramsCheck server time › Responses
Check server time
idstatusserverTimerateLimitTypeintervalintervalNumlimitcount