Skip to content

Rehabilitation Factor ​

GET /api/v1.0/quote/{symbol}/corporate-actions/rehab

Get the adjustment (rehabilitation) factors for a stock, including forward/backward adjustment factors, dividend, split, and allotment ratios.

Parameters ​

NameTypeInRequiredDefaultDescription
symbolstringpathyes-Symbol code, e.g. HK.00700 / US.AAPL
divi_modestringquerynoinclude_diviDividend 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' | jq

Response Fields ​

NameTypeDescription
dataobject
data.rehabsobject[]
data.rehabs[].ex_div_datestringEx-rights / ex-dividend date, format yyyy-MM-dd (market local calendar, no tz conversion). e.g. '2005-04-19'
data.rehabs[].action_typesstring[]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_scstringEvent description in Simplified Chinese, e.g. 'Cash dividend HKD 0.07 per share'
data.rehabs[].desc_tcstringEvent description in Traditional Chinese
data.rehabs[].desc_enstringEvent description in English
data.rehabs[].forward_adj_factorAnumberForward adjustment factor A (multiplicative, per-event)
data.rehabs[].forward_adj_factorBnumberForward adjustment factor B (additive, per-event)
data.rehabs[].backward_adj_factorAnumberBackward adjustment factor A (multiplicative, per-event)
data.rehabs[].backward_adj_factorBnumberBackward adjustment factor B (additive, per-event)
data.rehabs[].cum_forward_adj_factorAnumberCumulative forward adjustment factor A (running value across historical events)
data.rehabs[].cum_forward_adj_factorBnumberCumulative forward adjustment factor B
data.rehabs[].cum_backward_adj_factorAnumberCumulative backward adjustment factor A
data.rehabs[].cum_backward_adj_factorBnumberCumulative backward adjustment factor B
data.rehabs[].split_baseintPre-split base (int); integer, no scaling; no scaling
data.rehabs[].split_ertintPost-split shares (int); integer, no scaling; no scaling
data.rehabs[].join_basestringPre-consolidation base (legacy HK data may be x1e5 scaled)
data.rehabs[].join_ertstringPost-consolidation shares (legacy HK data may be x1e5 scaled)
data.rehabs[].split_rationumberSplit/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_baseintPre-bonus base (int)
data.rehabs[].bonus_ertintPost-bonus shares (int)
data.rehabs[].per_share_div_rationumberBonus shares per share (bonus_stk_base/bonus_stk_ert)
data.rehabs[].transfer_baseintPre-transfer base (int)
data.rehabs[].transfer_ertintPost-transfer shares (int)
data.rehabs[].per_share_trans_rationumberTransferred shares per share (into_shr_base/into_ert)
data.rehabs[].allot_baseintPre-rights-issue base (int)
data.rehabs[].allot_ertintPost-rights-issue shares (int)
data.rehabs[].allotment_rationumberRights issue ratio (allot_base/allot_ert)
data.rehabs[].allotment_pricenumberRights issue price (in reporting currency)
data.rehabs[].add_baseintPre-secondary-offering base (int)
data.rehabs[].add_ertintPost-secondary-offering shares (int)
data.rehabs[].stk_spo_rationumberSecondary offering ratio (stk_add_base/stk_add_ert)
data.rehabs[].stk_spo_pricenumberSecondary offering price (in reporting currency)
data.rehabs[].spin_off_baseintPre-spin-off base (int)
data.rehabs[].spin_off_ertintPost-spin-off shares (int)
data.rehabs[].spin_off_rationumberSpin-off ratio (spin_off_base/spin_off_ert)
data.rehabs[].per_cash_divnumberCash dividend per share (in reporting currency). The returned value is the amount per share. e.g. 0.07
data.rehabs[].special_dividendnumberSpecial dividend per share (in reporting currency). Same formula as per_cash_div: amount/base/1e5
paginationobjectPagination 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_codeerror.codeTrigger ConditionRecommended Action
0-Success (including when rehabs is an empty array)Normal processing; empty array means no corporate action history for this symbol
-3invalid_parameterdivi_mode value not in enum setCheck parameter is one of compat / exclude_divi / include_divi
-7invalid_symbolsymbol cannot be resolved to a valid securityCheck 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
      }
    ]
  }
}