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=. |
Compare valuation metrics (PE/PB/PS/market cap/close price) across multiple stocks. When no comparison symbols are provided, the server automatically selects peers from the same industry.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Primary security symbol, e.g. `AAPL.US` |
currency | string | Required | Result currency: `USD`, `HKD`, or `CNY` |
comparison_symbols | array | Optional | Symbols to compare against; if omitted, the server auto-selects industry peers |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
list | object[] | Optional | Valuation comparison list |
└ symbol | string | Optional | Security symbol |
└ name | string | Optional | Security name |
└ market | string | Optional | Market: `US`, `HK`, `CN`, `SG` |
└ currency | string | Optional | Currency of the values |
└ price_close | string | Optional | Latest closing price |
└ market_value | string | Optional | Market capitalisation |
└ volume | string | Optional | Volume. |
└ pe | string | Optional | P/E ratio (TTM) |
└ pb | string | Optional | P/B ratio |
└ ps | string | Optional | P/S ratio (TTM) |
└ div_yld | string | Optional | Dividend yield (%) |
└ roa | string | Optional | Return on assets (ROA). |
└ roe | string | Optional | Return on equity (%) |
└ turnover | string | Optional | Turnover. |
└ net_margin | string | Optional | Net profit margin |
└ leverage | string | Optional | Leverage ratio. |
└ liabilities_assets | string | Optional | Liabilities-to-assets ratio. |
└ eps | string | Optional | Earnings per share (TTM) |
└ sales_ps | string | Optional | Sales per share. |
└ bps | string | Optional | Book value per share |
└ dps | string | Optional | Dividends per share (TTM) |
└ five_y_avg_dps | string | Optional | 5-year average DPS |
└ div_payout_ratio | string | Optional | Dividend payout ratio |
└ assets | string | Optional | Total assets |
└ liabilities | string | Optional | Total liabilities. |
└ sales | string | Optional | Sales / revenue. |
└ net_income | string | Optional | Net income |
└ history | object[] | Optional | Historical valuation time series |
└ ∟ date | string | Optional | Date as Unix timestamp (seconds) |
└ ∟ pe | string | Optional | P/E ratio (TTM) |
└ ∟ pb | string | Optional | P/B ratio |
└ ∟ ps | string | Optional | P/S ratio (TTM) |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"list": [
{
"symbol": "AAPL.US",
"name": "Apple Inc.",
"currency": "USD",
"market_value": "3241500000000",
"price_close": "213.49",
"pe": "32.15",
"pb": "50.21",
"ps": "8.04",
"roe": "136.45",
"eps": "6.43",
"bps": "4.38",
"dps": "0.99",
"div_yld": "0.46",
"assets": "371082000000",
"history": [
{
"date": "1622520000",
"pe": "37.56",
"pb": "30.16",
"ps": "6.41"
},
{
"date": "1625112000",
"pe": "41.49",
"pb": "35.64",
"ps": "6.60"
}
]
},
{
"symbol": "MSFT.US",
"name": "Microsoft",
"currency": "USD",
"market_value": "3085000000000",
"price_close": "415.32",
"pe": "35.42",
"pb": "12.87",
"ps": "12.61",
"roe": "38.21",
"eps": "11.72",
"bps": "32.28",
"dps": "3.32",
"div_yld": "0.80",
"assets": "512163000000",
"history": [
{
"date": "1622520000",
"pe": "33.12",
"pb": "11.94",
"ps": "11.84"
}
]
}
]
}
}Error code
See the Error Codes page for the full list of error codes.