Quote

Warrant Screener

WSRequest · cmd 23

This API is used to obtain the quotes of HK warrants, and supports sorting and filtering.

message WarrantFilterListRequest {
  string symbol = 1;
  FilterConfig filter_config = 2;
  int32 language = 3;
}

message WarrantFilterListResponse {
  repeated FilterWarrant warrant_list = 1;
  int32 total_count = 2;
}
Quote Permission RequiredFree

Included with OpenAPI activation — no extra purchase needed.

Request parameters

NameTypeRequiredDescription
symbolstringRequiredSecurity code, in ticker.region format, for example: 700.HK
filter_configobjectRequiredFilter conditions
└ sort_byint32RequiredWhich data to sort by, for example: 0, see the OrderSequence field of the response data
└ sort_orderint32RequiredOrder: 0 - Ascending, 1 - Descending
└ sort_offsetint32RequiredThe first data offset of paging, for example: 0
└ sort_countint32RequiredNumber of items per page, for example: 20, no pagination when filling in 0
└ typeint32[]OptionalFilter warrant type: 0 Call, 1 Put, 2 Bull, 3 Bear, 4 Inline
└ issuerint32[]OptionalFilter issuer example: [12,14], obtain Issuer ID through API
└ expiry_dateint32[]OptionalFilter expiry date: 1 <3 months, 2 3-6 months, 3 6-12 months, 4 >12 months
└ price_typeint32[]OptionalFilter in/out of bounds: 1 In bounds, 2 Out bounds
└ statusint32[]OptionalFilter status: 2 Suspend trading, 3 Prepare List, 4 Normal
languageint32RequiredLanguage: 0 zh-CN, 1 en, 2 zh-HK

Response fields

NameTypeRequiredDescription
warrant_listobject[]OptionalFiltered warrant data list
└ symbolstringOptionalSecurity code
└ namestringOptionalSecurity name
└ last_donestringOptionalLatest price
└ change_ratestringOptionalQuote change rate
└ change_valstringOptionalQuote change
└ volumeint64OptionalVolume
└ turnoverstringOptionalTurnover
└ expiry_datestringOptionalExpiry date, in YYMMDD format
└ strike_pricestringOptionalStrike price
└ upper_strike_pricestringOptionalUpper bound price
└ lower_strike_pricestringOptionalLower bound price
└ outstanding_qtystringOptionalOutstanding quantity
└ outstanding_ratiostringOptionalOutstanding ratio
└ premiumstringOptionalPremium
└ itm_otmstringOptionalIn/out of the bound
└ implied_volatilitystringOptionalImplied volatility
└ deltastringOptionalGreek value Delta
└ call_pricestringOptionalCall price
└ to_call_pricestringOptionalPrice interval from the call price
└ effective_leveragestringOptionalEffective leverage
└ leverage_ratiostringOptionalLeverage ratio
└ conversion_ratiostringOptionalConversion ratio
└ balance_pointstringOptionalBreakeven point
└ statusint32OptionalStatus: 2 Suspend trading, 3 Prepare List, 4 Normal
total_countint32OptionalTotal number of eligible

Response JSON example

{
  "warrant_list": [
    {
      "symbol": "13157.HK",
      "name": "MBTENCT@EP2207A",
      "last_done": "2.26",
      "change_rate": "-0.0216",
      "expiry_date": "20220705",
      "strike_price": "442.233",
      "status": 4
    }
  ],
  "total_count": 1197
}