Health Check
GET /health
Check if the API is running.
Response:
{ "status": "ok"}Ingest API
Data ingestion endpoints for receiving batched data pushes from FinancialDataset. Authenticated via FD-API-KEY header.
| Endpoint | Description |
|---|---|
| Ingest | POST /api/v1/financialdataset/ingest/batches — Batch data ingestion (V3) |
GET /api/v1/financialdataset/ingest/batches/:batch_id — Batch status query |
Query API
Data query endpoints powered by F-API-KEY authentication. All responses follow a unified format with pagination metadata.
| Category | Path | Description |
|---|---|---|
| ETF | /api/v1/etf/* | Basic info, NAV, price, size, flow, holdings, PCF, dividends, kline |
| A-Share | /api/v1/stock/* | Spot data, financials, industry classification |
| Index | /api/v1/index/* | Constituents, price, metadata |
| Macro & Market | /api/v1/macro/* /api/v1/market/* | Macro indicators, margin trading, HK Stock Connect flows |
| US Stocks | /api/v1/us/* | Companies, SEC filings, financial facts, insider trades, 13F holdings |
Error Codes
| Status | Meaning |
|---|---|
| 401 | Missing or invalid API key |
| 403 | Rate limit exceeded or quota exhausted |
| 500 | Internal server error |