Endpoint#
GET /api/series
Every series_id with title, frequency, unit, first and last period, observation count and how many rows are CSV backfill rather than archive releases. Free, no key.
Authentication#
[]An empty security requirement means this operation does not declare authentication. Read operation notes for entitlement and protocol-method requirements.
Parameters#
No parameters declared by the specification.
Responses and errors#
| HTTP status | Meaning |
|---|---|
| 200 | The series catalog. |
| 503 | Archive unavailable; retry later. |
Response examples#
No response example is supplied by OpenAPI for this operation. The complete response schemas are preserved below; use an actual response for observed values.
Retry guidance#
See errors and retries. Honor operation-specific response headers. A POST may create state; do not replay it automatically.
Complete operation contract#
The expanded contract below includes all parameter constraints, response headers, schemas and examples from OpenAPI.
{
"path": "/api/series",
"method": "GET",
"parameters": [],
"operationId": "listSeries",
"summary": "Catalog of indicator time series",
"description": "Every series_id with title, frequency, unit, first and last period, observation count and how many rows are CSV backfill rather than archive releases. Free, no key.",
"tags": [
"data",
"Find records"
],
"security": [],
"responses": {
"200": {
"description": "The series catalog.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"series",
"count"
]
}
}
}
},
"503": {
"description": "Archive unavailable; retry later."
}
},
"x-codeSamples": [
{
"lang": "curl",
"label": "curl",
"source": "curl -s 'https://china-snapshot.com/api/series'"
}
]
}