Skip to main content
The SecurityListRequest(x) message is used to return a list of securities (instruments) from the Deribit.

Arguments

TagNameTypeRequiredComments
320SecurityReqIdStringYesA user-generated ID for this request. This can be used to match the request to the response
559SecurityListRequestTypeintYes0 or 4 – in any case list of instruments is returned
263SubscriptionRequestTypeintNoSubscription Request Type to get notifications about new or terminated instruments. Valid values:
  • 0 = Snapshot,
  • 1 = Snapshot + Updates (Subscribe),
  • 2 = Disable previous Snapshot + Update Request (Unsubscribe)
9013DisplayMulticastInstrumentIDBooleanNoCustom tag, default is false (N). If the tag is present and set to ‘Y’, then symbol entries will include the Multicast identifier of the Symbol (if applicable). See NoSecurityAltID(454) below
9018DisplayIncrementStepsBooleanNoCustom tag, default is false (N). If the tag is present and set to ‘Y’, then symbol entries will include the Price Increment steps of the Symbol (if applicable). See NoTickRules(1205) below
15CurrencyStringNoFirst currency of the currency pair for limiting the resulted list. Required if SecondaryCurrency(5544) specified.
5544SecondaryCurrencyStringNoSecond currency of the currency pair for limiting the resulted list. Default is USD if Currency(15) is specified. Current API doesn’t support queries by SecondaryCurrency only, so Currency (15) is mandatory if SecondaryCurrency is present. In current implementation SecondaryCurrency is ignored in subscription when SubscriptionRequestType (263) = 1
167SecurityTypeStringNoOptional parameter for limiting output by the SecurityType. Describes type of security.

Possible values:

  • FXSPOT for currency exchange spot
  • FUT for futures,
  • OPT for options,
  • FUTCO for future combo,
  • OPTCO for option combo
  • INDEX for indexes

Response

The server will respond with a Security List(y) message, where the SecurityReq(320) is equal to that of the request.