China SnapshotDocs
Get a key ↗
Open in AI ↗
Open in ChatGPTOpen in ClaudeView Markdown
API reference

Fetch endpoints

getEndpointsCatalog · GET /data/endpoints.json

Endpoint#

GET /data/endpoints.json

The self-describing catalog of every public China Snapshot data feed, regenerated after each collection run. Category, schema, access level, series, and item counts.

Authentication#

json
[]

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 statusMeaning
200The requested feed.
404Feed not published for this run.

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.

json
{
  "path": "/data/endpoints.json",
  "method": "GET",
  "parameters": [],
  "operationId": "getEndpointsCatalog",
  "summary": "Fetch endpoints",
  "description": "The self-describing catalog of every public China Snapshot data feed, regenerated after each collection run. Category, schema, access level, series, and item counts.",
  "tags": [
    "data"
  ],
  "security": [],
  "responses": {
    "200": {
      "description": "The requested feed.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "generated_at": {
                "type": "string"
              },
              "license": {
                "type": "string"
              },
              "llms_txt": {
                "type": "string"
              },
              "agents_txt": {
                "type": "string"
              },
              "developer_portal": {
                "type": "string"
              },
              "developer_portal_markdown": {
                "type": "string"
              },
              "openapi": {
                "type": "string"
              },
              "schema": {
                "type": "object",
                "properties": {
                  "version": {
                    "type": "integer"
                  },
                  "feed_schema_url": {
                    "type": "string"
                  },
                  "digest_schema_url": {
                    "type": "string"
                  },
                  "synthesis_schema_url": {
                    "type": "string"
                  },
                  "geo_catalog_schema_url": {
                    "type": "string"
                  },
                  "signal_packet_schema_url": {
                    "type": "string"
                  },
                  "feeds": {
                    "type": "string"
                  },
                  "digest": {
                    "type": "string"
                  },
                  "history": {
                    "type": "string"
                  },
                  "series": {
                    "type": "string"
                  },
                  "access": {
                    "type": "string"
                  }
                }
              },
              "access": {
                "type": "object",
                "properties": {
                  "default": {
                    "type": "string"
                  },
                  "levels": {
                    "type": "object",
                    "properties": {
                      "public": {
                        "type": "string"
                      },
                      "professional": {
                        "type": "string"
                      }
                    }
                  },
                  "professional_url_prefixes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "professional_endpoints": {
                    "type": "object",
                    "properties": {
                      "https://china-snapshot.com/api/research": {
                        "type": "string"
                      },
                      "https://china-snapshot.com/api/mcp": {
                        "type": "string"
                      }
                    }
                  },
                  "how_to_access": {
                    "type": "string"
                  }
                }
              },
              "archive": {
                "type": "object",
                "properties": {
                  "description": {
                    "type": "string"
                  },
                  "access": {
                    "type": "string"
                  },
                  "how_to_access": {
                    "type": "string"
                  },
                  "index_url": {
                    "type": "string"
                  },
                  "url_template": {
                    "type": "string"
                  },
                  "slots": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "earliest_date": {
                    "type": "string"
                  },
                  "latest_date": {
                    "type": "string"
                  },
                  "indexed_snapshots": {
                    "type": "integer"
                  },
                  "note": {
                    "type": "string"
                  }
                }
              },
              "synthesis": {
                "type": "object",
                "properties": {
                  "description": {
                    "type": "string"
                  },
                  "access": {
                    "type": "string"
                  },
                  "how_to_access": {
                    "type": "string"
                  },
                  "index_url": {
                    "type": "string"
                  },
                  "entities_url": {
                    "type": "string"
                  },
                  "topic_url_template": {
                    "type": "string"
                  },
                  "version_permalink_template": {
                    "type": "string"
                  },
                  "topic_count": {
                    "type": "integer"
                  }
                }
              },
              "topics": {
                "type": "object",
                "properties": {
                  "access": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "index_url": {
                    "type": "string"
                  },
                  "current_url_template": {
                    "type": "string"
                  },
                  "reading_url_template": {
                    "type": "string"
                  },
                  "markdown_url_template": {
                    "type": "string"
                  },
                  "human_url": {
                    "type": "string"
                  },
                  "note": {
                    "type": "string"
                  }
                }
              },
              "special": {
                "type": "object",
                "properties": {
                  "agents_txt": {
                    "type": "string"
                  },
                  "daily_digest": {
                    "type": "string"
                  },
                  "daily_digest_markdown": {
                    "type": "string"
                  },
                  "payload_budget": {
                    "type": "string"
                  },
                  "health": {
                    "type": "string"
                  },
                  "source_reliability": {
                    "type": "string"
                  },
                  "geo_catalog": {
                    "type": "string"
                  },
                  "professional_api": {
                    "type": "string"
                  },
                  "professional_mcp": {
                    "type": "string"
                  },
                  "openapi": {
                    "type": "string"
                  },
                  "developer_portal": {
                    "type": "string"
                  },
                  "professional_signal_packet": {
                    "type": "object",
                    "properties": {
                      "json": {
                        "type": "string"
                      },
                      "markdown": {
                        "type": "string"
                      },
                      "access": {
                        "type": "string"
                      }
                    }
                  },
                  "gov_registry_health": {
                    "type": "string"
                  },
                  "public_signal_packet": {
                    "type": "string"
                  },
                  "public_signal_packet_markdown": {
                    "type": "string"
                  }
                }
              },
              "feeds": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "category": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "url": {
                      "type": "string"
                    },
                    "access": {
                      "type": "string"
                    },
                    "as_of": {
                      "type": "string"
                    },
                    "schema_id": {
                      "type": "string"
                    },
                    "schema_url": {
                      "type": "string"
                    },
                    "item_count": {
                      "type": "integer"
                    },
                    "series": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "history_url": {
                      "type": "string"
                    },
                    "history_access": {
                      "type": "string"
                    }
                  }
                }
              },
              "forecasts": {
                "type": "object",
                "properties": {
                  "description": {
                    "type": "string"
                  },
                  "access": {
                    "type": "string"
                  },
                  "index_url": {
                    "type": "string"
                  },
                  "track_record_url": {
                    "type": "string"
                  },
                  "question_url_template": {
                    "type": "string"
                  },
                  "human_url": {
                    "type": "string"
                  },
                  "as_of": {
                    "type": "string"
                  },
                  "counts": {
                    "type": "object",
                    "properties": {
                      "total": {
                        "type": "integer"
                      },
                      "public": {
                        "type": "integer"
                      },
                      "member": {
                        "type": "integer"
                      },
                      "open": {
                        "type": "integer"
                      },
                      "resolved": {
                        "type": "integer"
                      },
                      "void": {
                        "type": "integer"
                      }
                    }
                  },
                  "note": {
                    "type": "string"
                  }
                }
              }
            },
            "additionalProperties": true,
            "description": "Inferred from the live feed at build time. The field inventory reflects this collection run; optional fields may be absent and the shape is refreshed on every deploy."
          }
        }
      }
    },
    "404": {
      "description": "Feed not published for this run.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "error"
            ],
            "properties": {
              "error": {
                "type": "object",
                "required": [
                  "code",
                  "message"
                ],
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "A stable machine-readable code, e.g. unauthorized or not_found."
                  },
                  "message": {
                    "type": "string",
                    "description": "A human-readable explanation."
                  },
                  "hint": {
                    "type": "string",
                    "description": "Optional resolution pointer."
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-codeSamples": [
    {
      "lang": "curl",
      "label": "curl",
      "source": "curl -s 'https://china-snapshot.com/data/endpoints.json'"
    }
  ]
}

Search documentation