TickerLab Documentation

Professional stock market data API service, providing K-line chart generation, technical indicators, and real-time market data.

Basic Information

Item	Description
Base URL	`https://tickerlab.org`
Authentication	API Key (Header or Query parameter)
Data Format	JSON
Protocol	HTTPS

Authentication

All API requests require an API Key:

# Method 1: Header Authentication (Recommended)
curl -H "X-API-Key: your_api_key" https://tickerlab.org/v1/indicators/time_series?symbol=000001.SZ

# Method 2: Query Parameter
curl "https://tickerlab.org/v1/indicators/query?apikey=your_api_key&symbol=000001.SZ&function=SMA"

Quick Start

Python

import requests

API_KEY = "your_api_key"
BASE_URL = "https://tickerlab.org"

# Get time series data
response = requests.get(
    f"{BASE_URL}/v1/indicators/time_series",
    params={"symbol": "000001.SZ", "interval": "1d"},
    headers={"X-API-Key": API_KEY}
)
data = response.json()
print(data["values"][:5])  # Latest 5 records

JavaScript

const API_KEY = 'your_api_key';
const BASE_URL = 'https://tickerlab.org';

// Get time series data
const response = await fetch(
  `${BASE_URL}/v1/indicators/time_series?symbol=000001.SZ&interval=1d`,
  { headers: { 'X-API-Key': API_KEY } }
);
const data = await response.json();
console.log(data.values.slice(0, 5));

cURL

curl -G "https://tickerlab.org/v1/indicators/time_series" \
  -H "X-API-Key: your_api_key" \
  -d "symbol=000001.SZ" \
  -d "interval=1d"

API Endpoints Overview

Access Policies

/v1/metadata/endpoint-policies is an internal admin endpoint and is no longer public.

Current public/pro split:

Tier	Endpoint Groups
Free	`/v1/market/` (except chart batch/storage), `/v1/macro/`, `/v1/flow/`, `/v1/stock/`, `/v1/finance/`, `/v1/sector/`, `/v1/ranking/`, `/v1/summary/`, `/v1/indicators/*`
Pro+	`/v1/intraday/`, `/v1/export/`, `/v1/market/chart/storage`, `/v1/market/chart/batch`

K-Line Data

Historical candlestick data with multiple intervals. This is the main entrypoint for time-series analysis.

Method	Endpoint
GET	`/v1/indicators/time_series`

Best for: OHLCV time series, backtesting, and charting feeds
Common params: symbol, interval, start_date, end_date, outputsize

Example:

curl -G "https://tickerlab.org/v1/indicators/time_series" \
  -H "X-API-Key: your_key" \
  -d "symbol=000001.SZ" \
  -d "interval=1d"

Real-time Quote

Latest bid/ask/last for a single symbol.

Method	Endpoint
GET	`/v1/market/quote`

Best for: quotes in dashboards and trading screens

Example:

curl -H "X-API-Key: your_key" "https://tickerlab.org/v1/market/quote?symbol=000001.SZ"

Historical Market Data (Export)

Export-friendly historical data for batch or CSV/JSON download.

Method	Endpoint
GET	`/v1/market/history`

Best for: bulk history, CSV/JSON export

Example:

curl -H "X-API-Key: your_key" \
  "https://tickerlab.org/v1/market/history?symbol=BTCUSDT&interval=1d&start_date=2023-01-01"

Batch Charting

Generate static charts for multiple symbols in a single request.

Method	Endpoint
POST	`/v1/market/chart/batch`

Best for: batch PNG generation, reporting

Example:

curl -X POST "https://tickerlab.org/v1/market/chart/batch" \
  -H "X-API-Key: your_key" \
  -H "Content-Type: application/json" \
  -d '[
    {"symbol": "000001.SZ", "interval": "1d", "studies": [{"name": "MACD"}]},
    {"symbol": "BTCUSDT", "interval": "4h", "studies": [{"name": "RSI"}]}
  ]'

Technical Indicators

All indicators support symbol, interval, start_date, end_date parameters.

Endpoint	Description	Specific Parameters
`/v1/market/vwap`	VWAP	-
`/v1/indicators/bbands`	Bollinger Bands	`timeperiod` (default 20), `nbdevup` (2)
`/v1/indicators/macd`	MACD	`fastperiod` (12), `slowperiod` (26), `signalperiod` (9)
`/v1/indicators/rsi`	RSI	`timeperiod` (14)
`/v1/market/stoch`	Stochastic	`fastk_period` (14), `slowk_period` (3)
`/v1/market/atr`	ATR	`timeperiod` (14)
`/v1/market/obv`	OBV	-
`/v1/market/adx`	ADX	`timeperiod` (14)

Macro Data (Newly Expanded)

Macro and global cross-asset datasets for policy, migration, commodities, FX, crypto, and risk monitoring.

Method	Endpoint Group	Notes
GET	`/v1/macro/cpi`, `/v1/macro/ppi`, `/v1/macro/gdp`, `/v1/macro/money-supply`, `/v1/macro/lpr`, `/v1/macro/pmi`	China core macro indicators
GET	`/v1/macro/social-finance`, `/v1/macro/new-loans`, `/v1/macro/fx-reserves`	Credit and reserve indicators
GET	`/v1/macro/migration-scale`, `/v1/macro/migration-area`, `/v1/macro/epu-index`	Migration and policy uncertainty
GET	`/v1/macro/oil-price-adjustment`, `/v1/macro/oil-price-region`	China oil price tracking
GET	`/v1/macro/commodity-daily`, `/v1/macro/forex-daily`, `/v1/macro/crypto-daily`	Daily commodity / FX / crypto series
GET	`/v1/macro/global-index-daily`, `/v1/macro/global-index-spot`, `/v1/macro/fx-spot`	Global index and FX snapshots
GET	`/v1/macro/energy-inventory`, `/v1/macro/global-risk-factor`	US energy and global risk factors

Common params: start_date, end_date, limit

Market Flow (Newly Expanded)

Capital flow, northbound holdings, restricted release events, and market microstructure event streams.

Method	Endpoint Group	Notes
GET	`/v1/flow/capital-flow`, `/v1/flow/north-flow`, `/v1/flow/south-flow`	Core fund flow channels
GET	`/v1/flow/margin`, `/v1/flow/margin-detail`	Margin financing summary/detail
GET	`/v1/flow/dragon-tiger`, `/v1/flow/institute-recommend`	Trading activity and institutional view
GET	`/v1/flow/hsgt-hold-rank`, `/v1/flow/hsgt-stock-statistics`	HSGT holding rank/statistics
GET	`/v1/flow/stock-repurchase`	Stock repurchase progress
GET	`/v1/flow/restricted-release-summary`, `/v1/flow/restricted-release-detail`, `/v1/flow/restricted-release-queue`, `/v1/flow/restricted-release-stockholder`	Restricted release lifecycle
GET	`/v1/flow/suspend-resume-events`	Suspend/resume events

Common params: symbol/stock_code, start_date, end_date, limit

Summary Intelligence (P0)

Aggregated endpoints designed for agent workflows: market regime detection, sentiment, rotation, and stock-level synthesis.

Method	Endpoint Group	Notes
GET	`/v1/summary/market/regime`, `/v1/summary/market/sentiment`	Market state and sentiment overview
GET	`/v1/summary/market/hot-stock-trend`	Hot-stock ranking trend summary
GET	`/v1/summary/sector/rotation`	Sector leadership and rotation strength
GET	`/v1/summary/sector/concept-heat`, `/v1/summary/sector/breadth`	Concept/sector heat and breadth
GET	`/v1/summary/stock/snapshot`	Single-stock unified snapshot (price/technical/capital/finance/risk)
GET	`/v1/summary/stock/event-timeline`	Catalyst timeline for one symbol
GET	`/v1/summary/opportunity/watchlist`, `/v1/summary/risk/invalidation`	Opportunity pool and invalidation tracking

Common params: trade_date, sector_type, symbol, start_date, end_date, limit

Intraday Intelligence (Pro)

Method	Endpoint Group	Notes
GET	`/v1/intraday/momentum`	Intraday momentum and breakout/fade risk
GET	`/v1/intraday/sector-pulse`	Sector pulse and continuation probability
GET	`/v1/intraday/market-breadth`	Minute-level market breadth turns

Error Handling

All API errors return a standardized JSON format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable error description",
    "request_id": "abc123-uuid"
  }
}

Error Codes

Code	HTTP Status	Description
`BAD_REQUEST`	400	Invalid request parameters
`UNAUTHORIZED`	401	Invalid or missing API Key
`FORBIDDEN`	403	Access denied
`NOT_FOUND`	404	Resource not found
`VALIDATION_ERROR`	422	Request body validation failed
`RATE_LIMIT_EXCEEDED`	429	Rate limit exceeded
`GEO_RESTRICTED`	451	Region restricted (e.g. some crypto)
`INTERNAL_ERROR`	500	Internal server error

Rate Limits

Plan	Requests/minute	Requests/hour
Free	3	150
Pro	60	1000
Premium	300	10000