API Reference

FinReport serves full-text financial reports as Markdown over a simple REST API. All endpoints require an API key.

Authentication

Pass your API key in the X-API-Key header:

curl -H "X-API-Key: YOUR_API_KEY" https://api.datasink.ing/documents

Missing or invalid keys return 401. Requests over your plan's rate limit return 429.

List documents GET /documents

Paginated list of document metadata with filters.

page	int	Page number (default 1)
size	int	Page size (default 50, max 200)
symbol	string	FMP-style ticker, e.g. 600519.SS
stock_code	string	6-digit code, e.g. 600519
doc_type	string	annual / semiannual / q1 / q3 / amendment
report_period	string	e.g. 2023-12-31

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.datasink.ing/documents?symbol=600519.SS&doc_type=annual"

Get a document GET /documents/:id

Returns metadata plus the full report body in Markdown (content field).

curl -H "X-API-Key: YOUR_API_KEY" https://api.datasink.ing/documents/42

Batch download POST /documents/batch

Fetch multiple documents by ID in one request.

curl -X POST -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"doc_ids": [1, 2, 3]}' \
  https://api.datasink.ing/documents/batch

Symbol format

Symbols follow the FMP / Yahoo convention, so they drop into existing workflows:

Exchange	Suffix	Example
Shanghai (SSE)	.SS	600519.SS
Shenzhen (SZSE)	.SZ	000001.SZ
Beijing (BSE)	.BJ	830799.BJ