Rehabilitation Factor
GET/api/v1.0/quote/{symbol}/corporate-actions/rehabGet the adjustment (rehabilitation) factors for a stock, including forward/backward adjustment factors, dividend, split, and allotment ratios.
Parameters
| Name | Type | In | Required | Default | Description |
|---|---|---|---|---|---|
symbol | string | path | yes | - | Symbol code, e.g. HK.00700 / US.AAPL |
divi_mode | string | query | no | include_divi | Dividend handling mode for adjustment factors. See Naming Dictionary > divi_mode |
Request Example
bash
curl 'https://webapi.futunn.com/api/v1.0/quote/HK.00700/corporate-actions/rehab' | jqResponse Fields
| Name | Type | Description |
|---|---|---|
data | object | |
data.rehabs | object[] | |
data.rehabs[].ex_div_date | string | Ex-rights / ex-dividend date, format yyyy-MM-dd (market local calendar, no tz conversion). e.g. '2005-04-19' |
data.rehabs[].action_types | string[] | Corporate-action types included in this single event (string array decoded from the ert_flag bitmask, can combine, e.g. ['SPLIT','DIVIDEND']). Values: SPLIT/JOIN/BONUS_STK/INTOSHARES/ALLOT/ADD/DIVIDEND/SPECIALDIVIDEND/SPINOFF |
data.rehabs[].desc_sc | string | Event description in Simplified Chinese, e.g. 'Cash dividend HKD 0.07 per share' |
data.rehabs[].desc_tc | string | Event description in Traditional Chinese |
data.rehabs[].desc_en | string | Event description in English |
data.rehabs[].forward_adj_factorA | number | Forward adjustment factor A (multiplicative, per-event) |
data.rehabs[].forward_adj_factorB | number | Forward adjustment factor B (additive, per-event) |
data.rehabs[].backward_adj_factorA | number | Backward adjustment factor A (multiplicative, per-event) |
data.rehabs[].backward_adj_factorB | number | Backward adjustment factor B (additive, per-event) |
data.rehabs[].cum_forward_adj_factorA | number | Cumulative forward adjustment factor A (running value across historical events) |
data.rehabs[].cum_forward_adj_factorB | number | Cumulative forward adjustment factor B |
data.rehabs[].cum_backward_adj_factorA | number | Cumulative backward adjustment factor A |
data.rehabs[].cum_backward_adj_factorB | number | Cumulative backward adjustment factor B |
data.rehabs[].split_base | int | Pre-split base (int); integer, no scaling; no scaling |
data.rehabs[].split_ert | int | Post-split shares (int); integer, no scaling; no scaling |
data.rehabs[].join_base | string | Pre-consolidation base (legacy HK data may be x1e5 scaled) |
data.rehabs[].join_ert | string | Post-consolidation shares (legacy HK data may be x1e5 scaled) |
data.rehabs[].split_ratio | number | Split/consolidation ratio (split_base/split_ert; falls back to join_base/join_ert). e.g. 0.2 for a 1->5 split |
data.rehabs[].bonus_base | int | Pre-bonus base (int) |
data.rehabs[].bonus_ert | int | Post-bonus shares (int) |
data.rehabs[].per_share_div_ratio | number | Bonus shares per share (bonus_stk_base/bonus_stk_ert) |
data.rehabs[].transfer_base | int | Pre-transfer base (int) |
data.rehabs[].transfer_ert | int | Post-transfer shares (int) |
data.rehabs[].per_share_trans_ratio | number | Transferred shares per share (into_shr_base/into_ert) |
data.rehabs[].allot_base | int | Pre-rights-issue base (int) |
data.rehabs[].allot_ert | int | Post-rights-issue shares (int) |
data.rehabs[].allotment_ratio | number | Rights issue ratio (allot_base/allot_ert) |
data.rehabs[].allotment_price | number | Rights issue price (in reporting currency) |
data.rehabs[].add_base | int | Pre-secondary-offering base (int) |
data.rehabs[].add_ert | int | Post-secondary-offering shares (int) |
data.rehabs[].stk_spo_ratio | number | Secondary offering ratio (stk_add_base/stk_add_ert) |
data.rehabs[].stk_spo_price | number | Secondary offering price (in reporting currency) |
data.rehabs[].spin_off_base | int | Pre-spin-off base (int) |
data.rehabs[].spin_off_ert | int | Post-spin-off shares (int) |
data.rehabs[].spin_off_ratio | number | Spin-off ratio (spin_off_base/spin_off_ert) |
data.rehabs[].per_cash_div | number | Cash dividend per share (in reporting currency). The returned value is the amount per share. e.g. 0.07 |
data.rehabs[].special_dividend | number | Special dividend per share (in reporting currency). Same formula as per_cash_div: amount/base/1e5 |
pagination | object | Pagination returned by some endpoints |
Supported Markets
- Code must use a supported market prefix from the 9 markets listed below; otherwise returns
invalid_symbol: HK / US / SH / SZ / CA / AU / JP / SG / KR. - Categories: Only stocks have corporate action history; indices, ETFs, warrants, options, futures, bonds, etc. are valid calls but rehabs is generally an empty array.
- History range: All corporate action events since the symbol's listing date; no time window parameter.
- Data precision: Adjustment factors are scaled by 1e-9; callers can use the float values directly without further processing.
Error Codes
| ret_code | error.code | Trigger Condition | Recommended Action |
|---|---|---|---|
| 0 | - | Success (including when rehabs is an empty array) | Normal processing; empty array means no corporate action history for this symbol |
| -3 | invalid_parameter | divi_mode value not in enum set | Check parameter is one of compat / exclude_divi / include_divi |
| -7 | invalid_symbol | symbol cannot be resolved to a valid security | Check symbol format and existence |
Response Example
json
{
"ret_code": 0,
"ret_msg": "success",
"data": {
"rehabs": [
{
"ex_div_date": "2005-04-19",
"action_types": [
"DIVIDEND"
],
"desc_sc": "派息 每股0.07港元",
"forward_adj_factorA": 2.9764677429100327e-07,
"forward_adj_factorB": -5.300133775844185,
"backward_adj_factorA": 3359687.0061233053,
"backward_adj_factorB": 17806790.57741896,
"cum_forward_adj_factorA": 2.9764677429100327e-07,
"cum_forward_adj_factorB": -5.300133775844185,
"cum_backward_adj_factorA": 3359687.0061233053,
"cum_backward_adj_factorB": 17806790.57741896,
"split_ratio": 0,
"join_ratio": 0,
"bonus_ratio": 0,
"bonus_base": 1,
"transfer_ratio": 0,
"transfer_base": 1,
"allotment_ratio": 0,
"allotment_price": 0,
"dividend": 0.07,
"special_dividend": 0,
"spin_off_ratio": 0
}
]
}
}