DOCUMENTATION

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)

EndpointMethodKey ParametersDescription
/v1/factors/backtest-dataGETsymbol, date, start_date, end_date, limitGet Backtest Data
/v1/factors/industriesGET—Factor Library Industry List
/v1/factors/libraryGETsymbol, date, start_date, end_date, industry, fields, limitGet Factor Library
/v1/factors/performanceGETstart_date, end_date, factorFactor Performance Statistics (IC/IR)
/v1/factors/rankingGETfactor, date, industry, top_n, limit, order, neutralizeGet Factor Ranking
/v1/stocks/compareGETsymbols, date, fieldsMulti-Stock Comparison
/v1/stocks/screenGETpe_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, limitMulti-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

ParameterTypeRequiredDefaultDescription
symbolstringOptional—Stock code (e.g., sz.000001, sh.600519) (optional)
datestringOptional—Trading date (YYYY-MM-DD) (optional; returns the latest trading day if omitted)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
limitintegerOptional500Number 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

ParameterTypeRequiredDefaultDescription
symbolstringOptional—Stock code (e.g., sz.000001, sh.600519) (optional; returns the whole market if omitted)
datestringOptional—Trading date (YYYY-MM-DD) (optional; returns the latest trading day if omitted)
start_datestringOptional—Start date (YYYY-MM-DD) (optional)
end_datestringOptional—End date (YYYY-MM-DD) (optional)
industrystringOptional—Shenwan (SW) level-1 industry filter (optional)
fieldsstringOptional—Fields to return, comma-separated (compact set by default, ’*’ returns all fields)
limitintegerOptional200Number 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

ParameterTypeRequiredDefaultDescription
start_datestringOptional—Start date (YYYY-MM-DD)
end_datestringOptional—End date (YYYY-MM-DD)
factorstringOptional—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

ParameterTypeRequiredDefaultDescription
factorstringOptionalcomposite_scoreRanking basis (27 options: composite_score, value_score, f_momentum_1m_rank, …)
datestringOptional—Trading date (YYYY-MM-DD) (optional; returns the latest trading day if omitted)
industrystringOptional—Shenwan (SW) level-1 industry filter (optional)
top_nintegerOptional50Number of top-ranked stocks to return
limitstringOptional—Number of rows to return (compatible with the generic limit parameter; takes precedence over top_n when set)
orderstringOptionaldescSort direction: asc (ascending) / desc (descending)
neutralizestringOptional—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

ParameterTypeRequiredDefaultDescription
symbolsstringOptional—Comma-separated stock codes (e.g., sh.600519,sz.000858)
datestringOptional—Trading date (defaults to the latest)
fieldsstringOptional—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

ParameterTypeRequiredDefaultDescription
pe_rank_maxstringOptional—PE rank upper bound (lower means cheaper)
pb_rank_maxstringOptional—PB rank upper bound
roic_rank_minstringOptional—ROIC rank lower bound (higher is better)
roe_rank_minstringOptional—ROE rank lower bound
momentum_1m_minstringOptional—1-month momentum rank lower bound
momentum_12m_minstringOptional—12-month momentum rank lower bound
beta_rank_maxstringOptional—Beta rank upper bound (lower means lower risk)
composite_score_minstringOptional—Composite score lower bound
industrystringOptional—Shenwan (SW) level-1 industry filter
sortstringOptional—Sort field (e.g., -composite_score)
datestringOptional—Trading date (defaults to the latest)
fieldsstringOptional—Fields to return (compact set by default, ’*’ returns all fields)
weightsstringOptional—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)
limitintegerOptional50Number 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())