Fundamental
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
Get historical valuation metric time series (PE, PB, PS, dividend yield).
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security symbol, e.g. `AAPL.US` |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
overview | object | Required | Current-valuation summary |
overview.metrics | object | Optional | Metrics map keyed by indicator (pe/pb/ps) |
overview.metrics.pe | object | Optional | Metric block for the requested indicator |
overview.metrics.pe.metric | string | Optional | Current value, e.g. 14.85x |
overview.metrics.pe.industry_median | string | Optional | Industry median |
overview.metrics.pe.desc | string | Optional | Human-readable summary |
overview.indicator | string | Optional | Requested indicator key |
overview.range | integer | Optional | Lookback range in years |
overview.date | string | Optional | As-of date |
overview.ccy_symbol | string | Optional | Currency symbol |
history | object | Required | Historical time series |
history.metrics.pe | object | Optional | History block for the indicator |
history.metrics.pe.low | string | Optional | Historical low |
history.metrics.pe.median | string | Optional | Historical median |
history.metrics.pe.high | string | Optional | Historical high |
history.metrics.pe.list | object[] | Optional | Time-series points |
history.metrics.pe.list[].timestamp | string | Optional | Unix seconds (string) |
history.metrics.pe.list[].value | string | Optional | Value at this point |
peers | object | Optional | Industry peers comparison |
peers.pe.industry_median | string | Optional | Peer-group median |
peers.pe.list | object[] | Optional | Peer companies |
peers.pe.list[].symbol | string | Optional | Security symbol, e.g. 9626.HK |
peers.pe.list[].name | string | Optional | Security name |
peers.pe.list[].value | string | Optional | Metric value |
layouts | object | Optional | Distribution buckets for charting |
symbols | object | Optional | Map keyed by symbol -> { name, market_cap } |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"history": {
"metrics": {
"pe": {
"desc": "P/E Ratio",
"high": "35.2",
"low": "18.1",
"median": "26.5",
"list": [
{
"timestamp": "1622520000",
"value": "28.5"
}
]
},
"pb": null,
"ps": null
}
}
}
}Error code
See the Error Codes page for the full list of error codes.