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.moomoo.com/api/v1.0/quote/HK.00700/corporate-actions/rehab' | jqResponse Fields
| Field | Type | Description |
|---|---|---|
rehabs | array | List of corporate action events, sorted by ex_div_date ascending |
rehabs[].ex_div_date | string | Ex-dividend date, format YYYY-MM-DD |
rehabs[].action_types | array<string> | Set of action types on that date. See Naming Dictionary > action_type |
rehabs[].desc_sc | string | Event description (Simplified Chinese) |
rehabs[].desc_tc | string | Event description (Traditional Chinese) |
rehabs[].desc_en | string | Event description (English, not available for some events) |
rehabs[].forward_adj_factorA | number | Forward adjustment factor A for the day (high precision, scaled by 1e-9, can be used directly) |
rehabs[].forward_adj_factorB | number | Forward adjustment factor B for the day |
rehabs[].backward_adj_factorA | number | Backward adjustment factor A for the day |
rehabs[].backward_adj_factorB | number | Backward adjustment factor B for the day |
rehabs[].cum_forward_adj_factorA | number | Cumulative forward adjustment factor A (accumulated from listing date to this event) |
rehabs[].cum_forward_adj_factorB | number | Cumulative forward adjustment factor B |
rehabs[].cum_backward_adj_factorA | number | Cumulative backward adjustment factor A |
rehabs[].cum_backward_adj_factorB | number | Cumulative backward adjustment factor B |
rehabs[].split_ratio | number | Split/consolidation ratio: <1 means split (e.g. 0.25 = 1-for-4 split), >1 means consolidation, =1 means equal ratio |
rehabs[].join_ratio | number | Consolidation ratio (paired with SPLIT/JOIN type) |
rehabs[].bonus_ratio | number | Bonus share ratio (N shares per base) |
rehabs[].bonus_base | number | Bonus share base |
rehabs[].transfer_ratio | number | Transfer share ratio |
rehabs[].transfer_base | number | Transfer share base |
rehabs[].transfer_ert | number | Transfer event identifier value |
rehabs[].allotment_ratio | number | Rights issue ratio |
rehabs[].allotment_price | number | Rights issue price |
rehabs[].add_base | number | Additional issue base |
rehabs[].add_ert | number | Additional issue event identifier value |
rehabs[].dividend | number | Dividend amount (per share, in original currency) |
rehabs[].special_dividend | number | Special dividend amount (per share, in original currency) |
rehabs[].special_dividend_base | number | Special dividend base |
rehabs[].spin_off_ratio | number | Spin-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_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": 0,
"transfer_ratio": 0,
"transfer_base": 0,
"allotment_ratio": 0,
"allotment_price": 0,
"dividend": 0.07,
"special_dividend": 0,
"spin_off_ratio": 0
}
]
}
}