Factor Analytics & Stock Screening
Multi-factor standardized library, cross-sectional ranking, backtest wide table, and multi-condition stock screening.
Factor Analytics & Stock Screening API
Multi-factor standardized library, cross-sectional ranking, backtest wide table, and multi-condition stock screening.
Endpoints Summary (7 endpoints)
| Endpoint | Method | Key Parameters | Description |
|---|---|---|---|
/v1/factors/backtest-data | GET | symbol, date, start_date, end_date, limit | Get Backtest Data |
/v1/factors/industries | GET | — | Factor Library Industry List |
/v1/factors/library | GET | symbol, date, start_date, end_date, industry, fields, limit | Get Factor Library |
/v1/factors/performance | GET | start_date, end_date, factor | Factor Performance Statistics (IC/IR) |
/v1/factors/ranking | GET | factor, date, industry, top_n, limit, order, neutralize | Get Factor Ranking |
/v1/stocks/compare | GET | symbols, date, fields | Multi-Stock Comparison |
/v1/stocks/screen | GET | pe_rank_max, pb_rank_max, roic_rank_min, roe_rank_min, momentum_1m_min, momentum_12m_min, beta_rank_max, composite_score_min, industry, sort, date, fields, weights, limit | Multi-Condition Stock Screening |
Detailed Endpoint Specifications
GET /v1/factors/backtest-data
Get Backtest Data
Export backtest factor wide-table data (quotes + standardized factors + forward returns + market regime).
Contains forward-return data and is large in volume; the Max plan gate applies by default (see the access_control policy).
Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | Optional | — | Stock code (e.g., sz.000001, sh.600519) (optional) |
date | string | Optional | — | Trading date (YYYY-MM-DD) (optional; returns the latest trading day if omitted) |
start_date | string | Optional | — | Start date (YYYY-MM-DD) (optional) |
end_date | string | Optional | — | End date (YYYY-MM-DD) (optional) |
limit | integer | Optional | 500 | Number of rows to return |
cURL Example
curl -X GET "https://tickerlab.org/v1/factors/backtest-data?symbol=sz.000001&date=2026-06-18&start_date=2026-01-01" \
-H "X-API-Key: $TICKERLAB_API_KEY"
Python Example
import requests
url = "https://tickerlab.org/v1/factors/backtest-data"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
"symbol": "sz.000001",
"date": "value",
"start_date": "2026-01-01"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())
GET /v1/factors/industries
Factor Library Industry List
Returns the names of all Shenwan (SW) level-1 industries in the factor library (for filtering reference).
(No query parameters required)
cURL Example
curl -X GET "https://tickerlab.org/v1/factors/industries" \
-H "X-API-Key: $TICKERLAB_API_KEY"
Python Example
import requests
url = "https://tickerlab.org/v1/factors/industries"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
response = requests.get(url, headers=headers)
print(response.json())
GET /v1/factors/library
Get Factor Library
Get multi-factor standardized library data (7 dimensions: value/quality/momentum/capital/risk/expectation/governance + composite score).
Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbol | string | Optional | — | Stock code (e.g., sz.000001, sh.600519) (optional; returns the whole market if omitted) |
date | string | Optional | — | Trading date (YYYY-MM-DD) (optional; returns the latest trading day if omitted) |
start_date | string | Optional | — | Start date (YYYY-MM-DD) (optional) |
end_date | string | Optional | — | End date (YYYY-MM-DD) (optional) |
industry | string | Optional | — | Shenwan (SW) level-1 industry filter (optional) |
fields | string | Optional | — | Fields to return, comma-separated (compact set by default, ’*’ returns all fields) |
limit | integer | Optional | 200 | Number of rows to return |
cURL Example
curl -X GET "https://tickerlab.org/v1/factors/library?symbol=sz.000001&date=2026-06-18&start_date=2026-01-01" \
-H "X-API-Key: $TICKERLAB_API_KEY"
Python Example
import requests
url = "https://tickerlab.org/v1/factors/library"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
"symbol": "sz.000001",
"date": "value",
"start_date": "2026-01-01"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())
GET /v1/factors/performance
Factor Performance Statistics (IC/IR)
Returns factor Rank IC mean, IC_IR, and win-rate statistics.
Computes cross-sectional Rank IC based on fwd_return_20d.
Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start_date | string | Optional | — | Start date (YYYY-MM-DD) |
end_date | string | Optional | — | End date (YYYY-MM-DD) |
factor | string | Optional | — | Single factor column name (all factors returned if omitted) |
cURL Example
curl -X GET "https://tickerlab.org/v1/factors/performance?start_date=2026-01-01&factor=composite_score" \
-H "X-API-Key: $TICKERLAB_API_KEY"
Python Example
import requests
url = "https://tickerlab.org/v1/factors/performance"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
"start_date": "2026-01-01",
"end_date": "value",
"factor": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())
GET /v1/factors/ranking
Get Factor Ranking
Get the top-N stocks by cross-sectional ranking on the specified factor.
Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
factor | string | Optional | composite_score | Ranking basis (27 options: composite_score, value_score, f_momentum_1m_rank, …) |
date | string | Optional | — | Trading date (YYYY-MM-DD) (optional; returns the latest trading day if omitted) |
industry | string | Optional | — | Shenwan (SW) level-1 industry filter (optional) |
top_n | integer | Optional | 50 | Number of top-ranked stocks to return |
limit | string | Optional | — | Number of rows to return (compatible with the generic limit parameter; takes precedence over top_n when set) |
order | string | Optional | desc | Sort direction: asc (ascending) / desc (descending) |
neutralize | string | Optional | — | Neutralization: set to ‘industry’ to rank within each industry (subtracting the industry mean) |
cURL Example
curl -X GET "https://tickerlab.org/v1/factors/ranking?factor=composite_score&date=2026-06-18&limit=10" \
-H "X-API-Key: $TICKERLAB_API_KEY"
Python Example
import requests
url = "https://tickerlab.org/v1/factors/ranking"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
"factor": "value",
"date": "value",
"industry": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())
GET /v1/stocks/compare
Multi-Stock Comparison
Compare the factor scores of multiple stocks on the same day.
Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
symbols | string | Optional | — | Comma-separated stock codes (e.g., sh.600519,sz.000858) |
date | string | Optional | — | Trading date (defaults to the latest) |
fields | string | Optional | — | Fields to return (compact set by default) |
cURL Example
curl -X GET "https://tickerlab.org/v1/stocks/compare?date=2026-06-18" \
-H "X-API-Key: $TICKERLAB_API_KEY"
Python Example
import requests
url = "https://tickerlab.org/v1/stocks/compare"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
"symbols": "value",
"date": "value",
"fields": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())
GET /v1/stocks/screen
Multi-Condition Stock Screening
Screen stocks by multiple conditions such as factor ranking ranges and industry.
Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pe_rank_max | string | Optional | — | PE rank upper bound (lower means cheaper) |
pb_rank_max | string | Optional | — | PB rank upper bound |
roic_rank_min | string | Optional | — | ROIC rank lower bound (higher is better) |
roe_rank_min | string | Optional | — | ROE rank lower bound |
momentum_1m_min | string | Optional | — | 1-month momentum rank lower bound |
momentum_12m_min | string | Optional | — | 12-month momentum rank lower bound |
beta_rank_max | string | Optional | — | Beta rank upper bound (lower means lower risk) |
composite_score_min | string | Optional | — | Composite score lower bound |
industry | string | Optional | — | Shenwan (SW) level-1 industry filter |
sort | string | Optional | — | Sort field (e.g., -composite_score) |
date | string | Optional | — | Trading date (defaults to the latest) |
fields | string | Optional | — | Fields to return (compact set by default, ’*’ returns all fields) |
weights | string | Optional | — | Custom 7-dimension weights, comma-separated: value,quality,momentum,capital,risk,expectation,governance (e.g., 0.30,0.30,0.15,0.10,0.05,0.05,0.05) |
limit | integer | Optional | 50 | Number of rows to return |
cURL Example
curl -X GET "https://tickerlab.org/v1/stocks/screen?date=2026-06-18&limit=10" \
-H "X-API-Key: $TICKERLAB_API_KEY"
Python Example
import requests
url = "https://tickerlab.org/v1/stocks/screen"
headers = {"X-API-Key": "$TICKERLAB_API_KEY"}
params = {
"pe_rank_max": "value",
"pb_rank_max": "value",
"roic_rank_min": "value"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())