Skip to content

Warrant Screen ​

POST /api/v1.0/quote/warrant-screen

Warrant screening -- filter within the warrant market (CALL warrants / PUT warrants / BULL CBBCs / BEAR CBBCs / INLINE warrants) by combining dimensions such as issuer, underlying, price, strike price, maturity date, street ratio, implied volatility, leverage, delta, warrant status, etc. Supports multi-level sorting and pagination.

Parameters ​

NameTypeInRequiredDescription
market_typeintbodynoMarket. Default 1. 1 HK, 4 Singapore, 15 Malaysia. Default 1; Values 1, 4, 15
is_delayboolbodynoUse delayed data. Default false. Default false
only_countboolbodynoReturn only the count, not the list. Default false. Default false
stock_ownerstringbodynoUnderlying symbol, for example HK.00700.
screen_groupsobject[]bodynoFilter condition list. Each element structure: {field_id, interval{lower{value,is_included}, upper{value,is_included}}, choices[{content_type, value}]}. Discrete selection uses choices (multiple elements = OR); range filtering uses interval. See the wrnt_field enum table below for field_id values.
sortsobject[]bodynoSort fields, in priority order. Max items 10000
next_keystringbodynoPagination cursor. Leave empty for the first page. Max length 1000; Pattern ^$|^(-?[0-9]+)?$
limitintbodynoPage size. ≤ 1000; Default 200

Enum wrnt_field (filter / sort field_id) ​

field_idMeaningType / Precision
4ISSUER_ID Issuer IDchoice
5STOCK_OWNER Underlying IDchoice
6WARRANT_TYPE Warrant typechoice (1=CALL, 2=PUT, 3=BULL, 4=BEAR, 5=INLINE)
7CONVERSION_RATIO Conversion ratiointerval, x1e3
8CURRENT_PRICE Current priceinterval, x1e3
9STREET_RATIO Street ratiointerval, x1e3
10VOLUME Volumeinterval
11MATURITY_DATE Maturity dateinterval (second-level timestamp)
12STRIKE_PRICE Strike priceinterval, x1e3
13PREMIUM Premiuminterval, x1e5
14RECOVERY_PRICE Call priceinterval, x1e3
15IMPLIED_VOLATILITY Implied volatilityinterval, x1e2
16LEVERAGE_RATIO Leverageinterval, x1e3
17PRICE_RECOVERY_RATIO Underlying distance to call price %interval, x1e5
18DELTA Deltainterval, x1e3
19STATUS Statuschoice (0=NORMAL, 2=STOP_TRADE, 3=PRE_IPO)
20IPO_TIME Listing timeinterval (second-level timestamp)
21BUY_VOL Bid volumeinterval
22SELL_VOL Ask volumeinterval
23EFFECTIVE_LEVERAGE Effective leverageinterval, x1e3
24LAST_CLOSE_PRICE Previous closeinterval, x1e3
25TURNOVER Turnoverinterval
26SELL_PRICE Ask priceinterval, x1e3
27BUY_PRICE Bid priceinterval, x1e3
28HIGH_PRICE High priceinterval, x1e3
29LOW_PRICE Low priceinterval, x1e3
30RATIO_ITM_OTM In/out of the money %interval, x1e5
31BREAK_EVEN_POINT Break-even pointinterval, x1e5
32AMPLITUDE Amplitude %interval, x1e5
33SCORE_FAXING SG scoreinterval, x1e5
34LAST_TRADE_DATE Last trading dateinterval (second-level timestamp)
35STREET_VOLUME Street volumeinterval
36LOT_SIZE Shares per lotinterval
37ISSUE_SIZE Issue sizeinterval
38IPO_PRICE Issue priceinterval, x1e3
39LOWER_STRIKE_PRICE Lower strike priceinterval, x1e3 (INLINE only)
40UPPER_STRIKE_PRICE Upper strike priceinterval, x1e3 (INLINE only)
41IW_PRICE_STATUS In/out of rangechoice (0=Within, 1=Outside upper, 2=Outside lower)
42SENSITIVITY Sensitivityinterval, x1e3
43CONVERSION_PRICE Conversion priceinterval
44CHANGE_RATE Change rate %interval, x1e3
45CHANGE_VALUE Change valueinterval
51SCORE Scoreinterval, x1e5
52FILTER_NO_TRADE Filter no-tradechoice (0=No filter, 1=Filter)
53CURRENCY_CODE Currencyinterval
54STOCK_OWNER_PRICE Underlying priceinterval, x1e3

Request Example ​

bash
curl -X POST "https://webapi.futunn.com/api/v1.0/quote/warrant-screen" \
  -H "Content-Type: application/json" \
  -d '{"market_type":1,"limit":3,"screen_groups":[{"field_id":6,"choices":[{"content_type":1,"value":1}]},{"field_id":5,"choices":[{"content_type":1,"value":54047868453564}]},{"field_id":19,"choices":[{"content_type":1,"value":0}]}],"sorts":[{"sort_field_id":16,"sort_flag":true}]}' | jq

Response Fields ​

General fields:

NameTypeDescription
dataobject
data.warrantsobject[]
data.warrants[].codestringWarrant code, e.g. HK.18869
data.warrants[].namestringWarrant English name
data.warrants[].sc_namestringWarrant Simplified Chinese name
data.warrants[].tc_namestringWarrant Traditional Chinese name
data.warrants[].stock_ownerstringUnderlying stock code, e.g. HK.00700
data.warrants[].typestringWarrant type. Values: CALL / PUT / BULL / BEAR / INLINE / N/A (unrecognized value)
data.warrants[].issuerstringIssuer name, e.g. 法巴 / 摩利 / 高盛
data.warrants[].maturity_timestringMaturity date string (market timezone), format yyyy-MM-dd, e.g. 2026-12-02
data.warrants[].maturity_timestampintMaturity date, millisecond timestamp, e.g. 1770048000000
data.warrants[].list_timestringListing date string (market timezone), format yyyy-MM-dd, e.g. 2025-08-01
data.warrants[].list_timestampintListing time, millisecond timestamp, e.g. 1753977600000
data.warrants[].last_trade_timestringLast trading day string (market timezone), format yyyy-MM-dd, e.g. 2026-11-26
data.warrants[].last_trade_timestampintLast trading day, millisecond timestamp, e.g. 1769529600000
data.warrants[].recovery_pricenumberRecovery price (Bull/Bear only), e.g. 0
data.warrants[].conversion_rationumberConversion ratio, e.g. 100
data.warrants[].lot_sizeintLot size (shares per lot), e.g. 10000
data.warrants[].strike_pricenumberStrike price, e.g. 738.88
data.warrants[].last_close_pricenumberPrevious close price, e.g. 0.01
data.warrants[].cur_pricenumberWarrant current price, e.g. 0.01
data.warrants[].statusstringWarrant status. Values: NORMAL / STOP_TRADE / PENDING_LISTING / N/A (unrecognized value)
data.warrants[].bid_pricenumberBest bid price, e.g. 0.01
data.warrants[].ask_pricenumberBest ask price, e.g. 0.01
data.warrants[].bid_volintBest bid volume (shares), e.g. 10000
data.warrants[].ask_volintBest ask volume (shares), e.g. 10000
data.warrants[].volumeintVolume (shares), e.g. 0
data.warrants[].turnovernumberTurnover, e.g. 0
data.warrants[].scorenumberWarrant score, e.g. 0.00002
data.warrants[].premiumnumberPremium (percentage), e.g. 0.4651
data.warrants[].break_even_pointnumberBreak-even point, e.g. 739.88
data.warrants[].leveragenumberLeverage ratio, e.g. 505
data.warrants[].ipopnumberIn-the-money / out-of-the-money (percentage; positive=ITM, negative=OTM), e.g. -0.46312
data.warrants[].price_recovery_rationumberDistance percentage from underlying to recovery price, e.g. 0
data.warrants[].street_ratenumberStreet ratio (percentage), e.g. 41.14
data.warrants[].street_volintStreet volume (shares), e.g. 20570000
data.warrants[].amplitudenumberAmplitude (percentage), e.g. 0
data.warrants[].issue_sizeintIssue size (shares), e.g. 50000000
data.warrants[].high_pricenumberHigh price, e.g. 0
data.warrants[].low_pricenumberLow price, e.g. 0
data.warrants[].implied_volatilitynumberImplied volatility (percentage), e.g. 0
data.warrants[].deltanumberDelta, e.g. 0
data.warrants[].effective_leveragenumberEffective leverage, e.g. 0
data.warrants[].upper_strike_pricenumberUpper strike price (Inline only), e.g. 0
data.warrants[].lower_strike_pricenumberLower strike price (Inline only), e.g. 0
data.warrants[].inline_price_statusstringIn-bound / out-of-bound (Inline only). Values: WITH_IN / OUTSIDE / N/A (non-Inline or unrecognized value)
data.warrants[].price_change_valnumberPrice change absolute value (current_price - last_close_price), e.g. 0
data.warrants[].change_ratenumberChange rate (percentage, relative to previous close), e.g. 0
data.warrants[].conversion_pricenumberConversion price (current_price x conversion_ratio), e.g. 1
paginationobject
pagination.totalint
pagination.has_morebool
pagination.next_keystring

Price / Volume:

FieldTypeDescription
cur_pricefloatWarrant current price.
last_close_pricefloatPrevious close price.
high_pricefloatHigh price.
low_pricefloatLow price.
bid_pricefloatBest bid price.
ask_pricefloatBest ask price.
bid_volintBest bid volume (shares).
ask_volintBest ask volume (shares).
volumeintVolume (shares).
turnoverfloatTurnover.
price_change_valfloatPrice change (cur_price - last_close_price).
change_ratefloatChange rate, unit %.
amplitudefloatAmplitude, unit %.

Derivative indicators:

FieldTypeDescription
strike_pricefloatStrike price.
conversion_ratiofloatConversion ratio.
conversion_pricefloatConversion price.
break_even_pointfloatBreak-even point.
premiumfloatPremium, unit %.
ipopfloatIn/out of the money, unit % (positive=ITM / negative=OTM).
leveragefloatLeverage ratio.
effective_leveragefloatEffective leverage.
deltafloatDelta.
implied_volatilityfloatImplied volatility, unit %.
scorefloatWarrant score.
street_ratefloatStreet ratio, unit %.
street_volintStreet volume (shares).

CBBC / Inline warrant specific:

FieldTypeDescription
recovery_pricefloatCall price (BULL/BEAR only).
price_recovery_ratiofloatUnderlying distance to call price % (BULL/BEAR only).
upper_strike_pricefloatUpper strike price (INLINE only).
lower_strike_pricefloatLower strike price (INLINE only).
inline_price_statusstringIn/out of range: WITH_IN / OUTSIDE / N/A.

Pagination:

FieldTypeDescription
pagination.totalintTotal number of warrants matching the criteria.
pagination.has_moreboolWhether there is a next page.
pagination.next_keystringNext page cursor; "-1" when no more pages.

Scope & Limits ​

  • Supported markets: HK (Hong Kong) / SG (Singapore) / MY (Malaysia) (market_type values 1 / 4 / 15). Other markets are not supported.
  • Supported categories: CALL (call warrants), PUT (put warrants), BULL (bull CBBCs), BEAR (bear CBBCs), INLINE (inline warrants).
  • Single page limit max 1000; next_key is an opaque cursor.
  • Valid but empty results (e.g. no warrants of that type in a market, overly strict filters) return ret_code=0 + data.warrants=[] + all_count=0.

Error Codes ​

ret_codeerror.codeTrigger ConditionHandling
-3invalid_parametermarket_type not in [1,4,15] / limit out of range (>1000) / invalid next_key / other invalid parameter types.Correct request body and retry.
-7invalid_symbolThe security code in stock_owner is not recognized.Verify underlying code validity via basic API, then retry.
-2 / -4 / -6internal_errorService errorRetry; contact support if errors persist.

Response Example ​

json
{
  "ret_code": 0,
  "ret_msg": "success",
  "data": {
    "warrants": [
      {
        "code": "HK.25894",
        "name": "腾讯摩通六七购B.C",
        "stock_owner": "HK.00700",
        "issuer": "JP",
        "type": "CALL",
        "status": "NORMAL",
        "strike_price": 778.27,
        "cur_price": 0.01,
        "leverage": 453.2,
        "premium": 71.948,
        "street_rate": 5.9,
        "maturity_time": "2026-07-29"
      }
    ]
  },
  "pagination": {
    "has_more": true,
    "next_key": "3",
    "total": 335
  }
}