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.moomoo.com/api/v1.0/quote/HK.00700/corporate-actions/rehab' | jq

Response Fields

FieldTypeDescription
rehabsarrayList of corporate action events, sorted by ex_div_date ascending
rehabs[].ex_div_datestringEx-dividend date, format YYYY-MM-DD
rehabs[].action_typesarray<string>Set of action types on that date. See Naming Dictionary > action_type
rehabs[].desc_scstringEvent description (Simplified Chinese)
rehabs[].desc_tcstringEvent description (Traditional Chinese)
rehabs[].desc_enstringEvent description (English, not available for some events)
rehabs[].forward_adj_factorAnumberForward adjustment factor A for the day (high precision, scaled by 1e-9, can be used directly)
rehabs[].forward_adj_factorBnumberForward adjustment factor B for the day
rehabs[].backward_adj_factorAnumberBackward adjustment factor A for the day
rehabs[].backward_adj_factorBnumberBackward adjustment factor B for the day
rehabs[].cum_forward_adj_factorAnumberCumulative forward adjustment factor A (accumulated from listing date to this event)
rehabs[].cum_forward_adj_factorBnumberCumulative forward adjustment factor B
rehabs[].cum_backward_adj_factorAnumberCumulative backward adjustment factor A
rehabs[].cum_backward_adj_factorBnumberCumulative backward adjustment factor B
rehabs[].split_rationumberSplit/consolidation ratio: <1 means split (e.g. 0.25 = 1-for-4 split), >1 means consolidation, =1 means equal ratio
rehabs[].join_rationumberConsolidation ratio (paired with SPLIT/JOIN type)
rehabs[].bonus_rationumberBonus share ratio (N shares per base)
rehabs[].bonus_basenumberBonus share base
rehabs[].transfer_rationumberTransfer share ratio
rehabs[].transfer_basenumberTransfer share base
rehabs[].transfer_ertnumberTransfer event identifier value
rehabs[].allotment_rationumberRights issue ratio
rehabs[].allotment_pricenumberRights issue price
rehabs[].add_basenumberAdditional issue base
rehabs[].add_ertnumberAdditional issue event identifier value
rehabs[].dividendnumberDividend amount (per share, in original currency)
rehabs[].special_dividendnumberSpecial dividend amount (per share, in original currency)
rehabs[].special_dividend_basenumberSpecial dividend base
rehabs[].spin_off_rationumberSpin-off ratio

Supported Markets

  • Code must use a supported market prefix from the 8 markets listed below; otherwise returns invalid_symbol: HK / US / SH / SZ / CA / AU / JP / SG.
  • 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": 0,
        "transfer_ratio": 0,
        "transfer_base": 0,
        "allotment_ratio": 0,
        "allotment_price": 0,
        "dividend": 0.07,
        "special_dividend": 0,
        "spin_off_ratio": 0
      }
    ]
  }
}