API

Read-only public contract

PainMap's current public API is a set of static files. They are cacheable, inspectable, and safe for static hosting. Immutable release URLs are the reproducible contract; the latest alias is only a convenience pointer.

Endpoints

Static URLs

Endpoint Format Purpose
/data/openapi.jsonOpenAPI 3.1 JSONMachine-readable public contract.
/v1/releases.jsonJSONRelease index and latest alias metadata.
/releases/2026-05-31/manifest.jsonJSONImmutable artifact inventory with SHA-256 checksums.
/v1/layers.jsonJSONLayer definitions, evidence kinds, units, and ranking modes.
/v1/sources.jsonJSONSource and license registry.
/data/release-modes.jsonJSONSnapshot and live overlay mode contract with cache and network rules.
/v1/places/index.jsonJSONFull release place index with coverage status for boundary-only and measured places.
/v1/adm1/index.jsonJSONADM1 poverty-context overlay index with static-page priority ranks.
/v1/coverage.jsonJSONCoverage counts, direct-evidence layer coverage, last release date, and known sparse areas.
/v1/places/{place_id}/adm1.jsonJSONCountry-scoped ADM1 context rows from the GSAP poverty overlay.
/v1/places/{place_id}/neighbors.jsonJSONRelease-scoped border neighbors, nearest centroid neighbors, and place discovery links.
/ogc/index.jsonJSONStatic OGC API - Features-style landing document.
/ogc/collections/places/items.jsonGeoJSONCountry place features joined to coverage, profile, measurement, and neighbor links.
/ogc/collections/places/item-index.jsonJSONPartitioned country feature index for clients that should not download the full OGC collection.
/ogc/collections/places/items/{place_id}.jsonGeoJSONSingle-country OGC-style GeoJSON feature with coverage, profile, and neighbor links.
/v1/places/WLD.jsonJSONWorld profile rows in the canonical release.
/v1/places/BRA.jsonJSONCanonical place profile example for Brazil.
/v1/places/IND.jsonJSONCanonical place profile example for India.
/data/provenance-registry.jsonJSONSources, licenses, evidence-kind classes, uncertainty classes, and dataset distributions.
/data/place-measurements.jsonJSONCanonical release measurements with numeric values, display values, units, source ids, confidence bounds, release id, and per-row lineage fields.
/data/place-measurements.csvCSVSpreadsheet-friendly measurements export.
/data/places.geojsonGeoJSONRepresentative features for atlas clients.
/data/gsap-adm1-2023.jsonJSONVendored World Bank GSAP ADM1 poverty-context source table.
/data/dcat.jsonDCAT JSONCatalog metadata for public datasets.
/schemas/place-index.schema.jsonJSON SchemaValidation schema for the place index.
/schemas/adm1-context.schema.jsonJSON SchemaValidation schema for the ADM1 context overlay.
/schemas/place-measurements.schema.jsonJSON SchemaValidation schema for canonical measurements.
/schemas/coverage.schema.jsonJSON SchemaValidation schema for coverage status.
/schemas/release-modes.schema.jsonJSON SchemaValidation schema for the snapshot/live release-mode contract.
/schemas/ogc-place-features.schema.jsonJSON SchemaValidation schema for OGC-style place features.
/releases/2026-05-31/diff.jsonJSONRelease diff baseline for future release comparisons.
/releases/2026-05-31/migration.jsonJSONRelease migration notes for schema changes, renamed fields, and layer IDs.
/data/analytics-events.jsonJSONPrivacy-preserving telemetry event vocabulary.
/data/performance-budgets.jsonJSONField performance budgets for LCP, INP, and CLS.
/data/source-freshness.jsonJSONSource review cadence, validation lanes, and scheduled release-candidate freshness workflow.
/data/endpoint-smoke.jsonJSONEndpoint smoke-test manifest for static-host checks.
/data/ui-smoke.jsonJSONAccessibility and visual smoke-test manifest for core static routes.