Endpoint#
GET /api/research
Unauthenticated discovery response. Describes the endpoint, the eleven operations, authentication, quotas, and links to pricing and account. Actual research calls are POST-only.
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 self-describing discovery body. |
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/research",
"method": "GET",
"parameters": [],
"operationId": "researchDiscovery",
"summary": "Describe the Professional research API",
"description": "Unauthenticated discovery response. Describes the endpoint, the eleven operations, authentication, quotas, and links to pricing and account. Actual research calls are POST-only.",
"tags": [
"research"
],
"security": [],
"responses": {
"200": {
"description": "The self-describing discovery body.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"x-codeSamples": [
{
"lang": "curl",
"label": "curl",
"source": "curl -s 'https://china-snapshot.com/api/research'"
}
]
}