Choose a path

What do you want to use safely?

Start with a public bundle, a source-health check, a search answer, or a protected export. Each path shows the route, the public limit, and the right next click.

Open civic data Protected access clear

How can I safely reuse Civic OS data?

Use these routes when you need public civic answers, source trails, assistant context, or shared summaries. Every route should show what it answers, where the evidence comes from, and what is intentionally not exposed.

Start here

Public bundle

/api/public-bundle.json

Protected exports

Public access

/api/x402/manifest.json

Source fields

1477

with public use status

Reuse check

Before reusing this data, check four things

Check the envelope, care limits, cache age, and care status before reusing a summary.

Consistent envelope ok + meta + data

Every response should state success, version, metadata, and data.

Source trail IDs and public URLs

Useful responses keep source references and evidence routes attached.

Public limit No sensitive details

Sensitive details do not appear in API, search, bundles, or exports.

Protected export Clear access

Protected routes should explain access without leaking private data.

Reusable routes

What each route answers

What each route answers
EndpointFormatAccessPurpose
/api/public-bundle.jsonJSONPublicSource and signal summary
/api/feed-status.jsonJSONPublicDated source check status and receipt evidence
/api/source-summary.jsonJSONPublicSource receipt and care-label summary
/api/source-refresh/manifest.jsonJSONPublicLatest public source-check manifest
/api/search-index.jsonJSONPublicSearch and assistant discovery
/api/search.json?q=housingJSONPublicSearch public guide records
/api/entities/index.jsonJSONPublicEntity list
/api/issues/housing.jsonJSONPublicIssue summary
/api/sources/summary.jsonJSONPublicPublic receipt overview
/api/sources/index.jsonJSONPublicSource list
/api/sources/src_d9659ce1ef2b.jsonJSONPublicSource detail summary
/api/sources/src_2bdd6d49b98d/runs.jsonJSONPublicDated source-check list
/api/sources/src_2bdd6d49b98d/evidence/20260525T061753750Z.jsonJSONPublicDated source receipt
/api/signals/issue_drift.jsonJSONPublicSignal explanation
/api/signals/outputs.jsonJSONPublicPublic explanation records
/api/claims/index.jsonJSONPublicClaims guide summary
/api/claims/contradiction_radar.jsonJSONPublicClaims explanation detail
/api/money/index.jsonJSONPublicMoney guide summary
/api/records/index.jsonJSONPublicRecords guide summary
/api/archive/index.jsonJSONPublicArchive guide summary
/api/x402/manifest.jsonJSONPublic discoveryProtected export access details
/sitemap-index.xmlXMLPublicSearch engine discovery
/llms.txtTextPublicAI assistant summary

Before reusing a public answer

Check the envelope, care limits, cache age, and care status before reusing a summary.

Before reusing a public answer
TopicRoute or fieldBehavior
Public explanation records/api/signals/outputs.jsonReturns public summaries, source references, source element IDs, public use status, care status, generated date, and evidence routes.
Protected export status/api/exports/source-statusReturns access details when an export requires payment or is not configured; protected exports still exclude sensitive details.
Display limitssourcePolicyResponses state what can be shown publicly and confirm that sensitive details are excluded.
Feed status/api/feed-status.jsonReturns audited source status, collection method, run timestamp, HTTP status, and content receipt for every cataloged source.
Run evidence/api/sources/src_2bdd6d49b98d/evidence/20260525T061753750Z.jsonReturns public-facing acquisition metadata for one run, including timestamp, HTTP status, content length, and content receipt.
Source refresh manifest/api/source-refresh/manifest.jsonReturns public-ready source collection jobs without emitting lookup keys or source element details.
FreshnessCache-ControlPublic JSON uses a 300 second browser cache with stale revalidation. Protected export responses use a shorter private cache.