Warrant Screen
POST/api/v1.0/quote/warrant-screenWarrant 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
| Name | Type | In | Required | Description |
|---|---|---|---|---|
market_type | int | body | no | Market. Default 1. 1 HK, 4 Singapore, 15 Malaysia. Default 1; Values 1, 4, 15 |
is_delay | bool | body | no | Use delayed data. Default false. Default false |
only_count | bool | body | no | Return only the count, not the list. Default false. Default false |
stock_owner | string | body | no | Underlying symbol, for example HK.00700. |
screen_groups | object[] | body | no | Filter 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. |
sorts | object[] | body | no | Sort fields, in priority order. Max items 10000 |
next_key | string | body | no | Pagination cursor. Leave empty for the first page. Max length 1000; Pattern ^$|^(-?[0-9]+)?$ |
limit | int | body | no | Page size. ≤ 1000; Default 200 |
Enum wrnt_field (filter / sort field_id)
| field_id | Meaning | Type / Precision |
|---|---|---|
| 4 | ISSUER_ID Issuer ID | choice |
| 5 | STOCK_OWNER Underlying ID | choice |
| 6 | WARRANT_TYPE Warrant type | choice (1=CALL, 2=PUT, 3=BULL, 4=BEAR, 5=INLINE) |
| 7 | CONVERSION_RATIO Conversion ratio | interval, x1e3 |
| 8 | CURRENT_PRICE Current price | interval, x1e3 |
| 9 | STREET_RATIO Street ratio | interval, x1e3 |
| 10 | VOLUME Volume | interval |
| 11 | MATURITY_DATE Maturity date | interval (second-level timestamp) |
| 12 | STRIKE_PRICE Strike price | interval, x1e3 |
| 13 | PREMIUM Premium | interval, x1e5 |
| 14 | RECOVERY_PRICE Call price | interval, x1e3 |
| 15 | IMPLIED_VOLATILITY Implied volatility | interval, x1e2 |
| 16 | LEVERAGE_RATIO Leverage | interval, x1e3 |
| 17 | PRICE_RECOVERY_RATIO Underlying distance to call price % | interval, x1e5 |
| 18 | DELTA Delta | interval, x1e3 |
| 19 | STATUS Status | choice (0=NORMAL, 2=STOP_TRADE, 3=PRE_IPO) |
| 20 | IPO_TIME Listing time | interval (second-level timestamp) |
| 21 | BUY_VOL Bid volume | interval |
| 22 | SELL_VOL Ask volume | interval |
| 23 | EFFECTIVE_LEVERAGE Effective leverage | interval, x1e3 |
| 24 | LAST_CLOSE_PRICE Previous close | interval, x1e3 |
| 25 | TURNOVER Turnover | interval |
| 26 | SELL_PRICE Ask price | interval, x1e3 |
| 27 | BUY_PRICE Bid price | interval, x1e3 |
| 28 | HIGH_PRICE High price | interval, x1e3 |
| 29 | LOW_PRICE Low price | interval, x1e3 |
| 30 | RATIO_ITM_OTM In/out of the money % | interval, x1e5 |
| 31 | BREAK_EVEN_POINT Break-even point | interval, x1e5 |
| 32 | AMPLITUDE Amplitude % | interval, x1e5 |
| 33 | SCORE_FAXING SG score | interval, x1e5 |
| 34 | LAST_TRADE_DATE Last trading date | interval (second-level timestamp) |
| 35 | STREET_VOLUME Street volume | interval |
| 36 | LOT_SIZE Shares per lot | interval |
| 37 | ISSUE_SIZE Issue size | interval |
| 38 | IPO_PRICE Issue price | interval, x1e3 |
| 39 | LOWER_STRIKE_PRICE Lower strike price | interval, x1e3 (INLINE only) |
| 40 | UPPER_STRIKE_PRICE Upper strike price | interval, x1e3 (INLINE only) |
| 41 | IW_PRICE_STATUS In/out of range | choice (0=Within, 1=Outside upper, 2=Outside lower) |
| 42 | SENSITIVITY Sensitivity | interval, x1e3 |
| 43 | CONVERSION_PRICE Conversion price | interval |
| 44 | CHANGE_RATE Change rate % | interval, x1e3 |
| 45 | CHANGE_VALUE Change value | interval |
| 51 | SCORE Score | interval, x1e5 |
| 52 | FILTER_NO_TRADE Filter no-trade | choice (0=No filter, 1=Filter) |
| 53 | CURRENCY_CODE Currency | interval |
| 54 | STOCK_OWNER_PRICE Underlying price | interval, 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}]}' | jqResponse Fields
General fields:
| Name | Type | Description |
|---|---|---|
data | object | |
data.warrants | object[] | |
data.warrants[].code | string | Warrant code, e.g. HK.18869 |
data.warrants[].name | string | Warrant English name |
data.warrants[].sc_name | string | Warrant Simplified Chinese name |
data.warrants[].tc_name | string | Warrant Traditional Chinese name |
data.warrants[].stock_owner | string | Underlying stock code, e.g. HK.00700 |
data.warrants[].type | string | Warrant type. Values: CALL / PUT / BULL / BEAR / INLINE / N/A (unrecognized value) |
data.warrants[].issuer | string | Issuer name, e.g. 法巴 / 摩利 / 高盛 |
data.warrants[].maturity_time | string | Maturity date string (market timezone), format yyyy-MM-dd, e.g. 2026-12-02 |
data.warrants[].maturity_timestamp | int | Maturity date, millisecond timestamp, e.g. 1770048000000 |
data.warrants[].list_time | string | Listing date string (market timezone), format yyyy-MM-dd, e.g. 2025-08-01 |
data.warrants[].list_timestamp | int | Listing time, millisecond timestamp, e.g. 1753977600000 |
data.warrants[].last_trade_time | string | Last trading day string (market timezone), format yyyy-MM-dd, e.g. 2026-11-26 |
data.warrants[].last_trade_timestamp | int | Last trading day, millisecond timestamp, e.g. 1769529600000 |
data.warrants[].recovery_price | number | Recovery price (Bull/Bear only), e.g. 0 |
data.warrants[].conversion_ratio | number | Conversion ratio, e.g. 100 |
data.warrants[].lot_size | int | Lot size (shares per lot), e.g. 10000 |
data.warrants[].strike_price | number | Strike price, e.g. 738.88 |
data.warrants[].last_close_price | number | Previous close price, e.g. 0.01 |
data.warrants[].cur_price | number | Warrant current price, e.g. 0.01 |
data.warrants[].status | string | Warrant status. Values: NORMAL / STOP_TRADE / PENDING_LISTING / N/A (unrecognized value) |
data.warrants[].bid_price | number | Best bid price, e.g. 0.01 |
data.warrants[].ask_price | number | Best ask price, e.g. 0.01 |
data.warrants[].bid_vol | int | Best bid volume (shares), e.g. 10000 |
data.warrants[].ask_vol | int | Best ask volume (shares), e.g. 10000 |
data.warrants[].volume | int | Volume (shares), e.g. 0 |
data.warrants[].turnover | number | Turnover, e.g. 0 |
data.warrants[].score | number | Warrant score, e.g. 0.00002 |
data.warrants[].premium | number | Premium (percentage), e.g. 0.4651 |
data.warrants[].break_even_point | number | Break-even point, e.g. 739.88 |
data.warrants[].leverage | number | Leverage ratio, e.g. 505 |
data.warrants[].ipop | number | In-the-money / out-of-the-money (percentage; positive=ITM, negative=OTM), e.g. -0.46312 |
data.warrants[].price_recovery_ratio | number | Distance percentage from underlying to recovery price, e.g. 0 |
data.warrants[].street_rate | number | Street ratio (percentage), e.g. 41.14 |
data.warrants[].street_vol | int | Street volume (shares), e.g. 20570000 |
data.warrants[].amplitude | number | Amplitude (percentage), e.g. 0 |
data.warrants[].issue_size | int | Issue size (shares), e.g. 50000000 |
data.warrants[].high_price | number | High price, e.g. 0 |
data.warrants[].low_price | number | Low price, e.g. 0 |
data.warrants[].implied_volatility | number | Implied volatility (percentage), e.g. 0 |
data.warrants[].delta | number | Delta, e.g. 0 |
data.warrants[].effective_leverage | number | Effective leverage, e.g. 0 |
data.warrants[].upper_strike_price | number | Upper strike price (Inline only), e.g. 0 |
data.warrants[].lower_strike_price | number | Lower strike price (Inline only), e.g. 0 |
data.warrants[].inline_price_status | string | In-bound / out-of-bound (Inline only). Values: WITH_IN / OUTSIDE / N/A (non-Inline or unrecognized value) |
data.warrants[].price_change_val | number | Price change absolute value (current_price - last_close_price), e.g. 0 |
data.warrants[].change_rate | number | Change rate (percentage, relative to previous close), e.g. 0 |
data.warrants[].conversion_price | number | Conversion price (current_price x conversion_ratio), e.g. 1 |
pagination | object | |
pagination.total | int | |
pagination.has_more | bool | |
pagination.next_key | string |
Price / Volume:
| Field | Type | Description |
|---|---|---|
cur_price | float | Warrant current price. |
last_close_price | float | Previous close price. |
high_price | float | High price. |
low_price | float | Low price. |
bid_price | float | Best bid price. |
ask_price | float | Best ask price. |
bid_vol | int | Best bid volume (shares). |
ask_vol | int | Best ask volume (shares). |
volume | int | Volume (shares). |
turnover | float | Turnover. |
price_change_val | float | Price change (cur_price - last_close_price). |
change_rate | float | Change rate, unit %. |
amplitude | float | Amplitude, unit %. |
Derivative indicators:
| Field | Type | Description |
|---|---|---|
strike_price | float | Strike price. |
conversion_ratio | float | Conversion ratio. |
conversion_price | float | Conversion price. |
break_even_point | float | Break-even point. |
premium | float | Premium, unit %. |
ipop | float | In/out of the money, unit % (positive=ITM / negative=OTM). |
leverage | float | Leverage ratio. |
effective_leverage | float | Effective leverage. |
delta | float | Delta. |
implied_volatility | float | Implied volatility, unit %. |
score | float | Warrant score. |
street_rate | float | Street ratio, unit %. |
street_vol | int | Street volume (shares). |
CBBC / Inline warrant specific:
| Field | Type | Description |
|---|---|---|
recovery_price | float | Call price (BULL/BEAR only). |
price_recovery_ratio | float | Underlying distance to call price % (BULL/BEAR only). |
upper_strike_price | float | Upper strike price (INLINE only). |
lower_strike_price | float | Lower strike price (INLINE only). |
inline_price_status | string | In/out of range: WITH_IN / OUTSIDE / N/A. |
Pagination:
| Field | Type | Description |
|---|---|---|
pagination.total | int | Total number of warrants matching the criteria. |
pagination.has_more | bool | Whether there is a next page. |
pagination.next_key | string | Next page cursor; "-1" when no more pages. |
Scope & Limits
- Supported markets: HK (Hong Kong) / SG (Singapore) / MY (Malaysia) (
market_typevalues 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
limitmax 1000;next_keyis 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_code | error.code | Trigger Condition | Handling |
|---|---|---|---|
| -3 | invalid_parameter | market_type not in [1,4,15] / limit out of range (>1000) / invalid next_key / other invalid parameter types. | Correct request body and retry. |
| -7 | invalid_symbol | The security code in stock_owner is not recognized. | Verify underlying code validity via basic API, then retry. |
| -2 / -4 / -6 | internal_error | Service error | Retry; 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
}
}