Reference Data
Static reference data related to crypto pairs traded on the Bullish platform can be requested by submitting the SecurityListRequest [x] message. This can be used to request details about the market for one or more cryptocurrencies by setting:
-
SecurityListRequestType (559) = 0 (single security) and specifying Symbol(55), or
-
SecurityListRequestType (559) = 4 (all securities)
Table 17: SecurityListRequest [x] message
| Tag | Field Name | Req'd | Type | Comments |
|---|---|---|---|---|
| < Standard Header > | 35 = x | |||
| 320 | SecurityReqID | Y | String | Unique id of the request. |
| 559 | SecurityListRequestType | Y | int | Type of SecurityList Request being made 0 = Single Symbol 4 = All securities |
| 55 | Symbol | C | String | Required where SecurityListRequestType (559) = 0 (Single Symbol) |
| < Standard Trailer > |
Upon receipt of the SecurityListRequest [x] message, the Bullish platform will respond with a single SecurityList [y] message containing a list of matching crypto instruments; this will be a single instrument if the SecurityListRequest [x] specified a single Instrument, or all instruments on the platform.
Note that the SecurityList [y] message is fragmented.
Table 18: SecurityList [y] message
| Tag | Field Name | Req'd | Type | Comments |
|---|---|---|---|---|
| < Standard Header > | 35 = y | |||
| 320 | SecurityReqID | Y | String | The unique id of the request. |
| 560 | SecurityRequestResult | Y | int | Status result of the SecurityListRequest. See Error & Rejection Codes. 0 = Valid request 1 = Invalid or unsupported request 2 = Instrument not found |
| 1607 | SecurityRejectReason | N | int | Used to specify a rejection reason when SecurityResponseResult (560) = 1 (Invalid or unsupported request). |
| 60 | TransactTime | Y | UTCTimestamp | Timestamp that this message was sent. |
| 893 | LastFragment | N | Boolean | Indicates if this message in a fragmented response is the final one of the sequence |
| 146 | NoRelatedSym | Y | int | Number of symbols indicated in this message |
| → 55 | Symbol | Y | String | Instrument symbol |
| → 1647 | NoRelatedInstruments | Y | int | Always 2 |
| →→ 1649 | RelatedSymbol | Y | String | The related symbol (either base or quoted currency) |
| →→ 1652 | RelatedSecurityType | Y | String | The type of the related symbol DIGITAL = Cryptocurrency CASH = Fiat currency |
| → 969 | MinPriceIncrement | Y | float | Minimum price increment for a given instrument (i.e. the tick size) |
| → 8000 | MinQtySize | Y | float | Minimum quantity for a given instrument |
| → 8001 | MaxQtySize | Y | float | Maximum quantity for a given instrument |
| → 8002 | PricePrecision | Y | int | The precision to which prices can be specified (integer representing the number of digits after the decimal point) |
| → 8003 | QtyPrecision | Y | int | The precision to which quantities can be specified (integer representing the number of digits after the decimal point) |
| → 8005 | MarginEnabled | Y | Boolean | Whether margin trading is enabled on this instrument or not. |
| < Standard Trailer > |