Atlas documentation
Developers

OpenAPI, GitHub, and support

Open the public Atlas contract, the GitHub repositories that own it, and the fields to include when you ask for help.

These guides explain how to call the public API. The contract itself stays in the owning service.

OpenAPI

SurfaceStatusURL
Production APIAvailablehttps://api.onehealthatlas.org
OpenAPI schemaAvailableopenapi.json
Swagger referenceAvailableSwagger reference
ReDoc referenceAvailableReDoc reference
Generated reference in this siteRendered from the pinned public specAPI reference

The generated section uses these paths:

PathContents
API referenceDocument version, source commit, and the operation index
DiscoveryIndicators and measures
ObservationsObservation query
ProvenanceSources and methodologies
GeographiesGeography identity
AtlasLegacy metadata, scores, geometry, and ranking export
CountiesLegacy county analytics and reports
StatesLegacy state review and reports
SchemasComponent schemas, including ProblemDetails

Use those pages for parameters, schemas, and the contract's own examples. Use the developer overview when you need the task and the meaning of a field.

/v1 is the HTTP contract. OpenAPI info.version is the application version. They are different identifiers.

GitHub

RepositoryWhat it owns
one-health-lyme-gap-atlas-apiThe public HTTP contract and openapi.json
one-health-lyme-gap-atlas-webThis documentation site and the Atlas web application
one-health-lyme-gap-atlas-mcpThe MCP server. It is not required for public REST reads

Contract questions belong with the API repository. Guide wording belongs with the web repository. API, MCP, and access records the current MCP boundary: bounded anonymous read-only evidence tools, with county identity kept separate from evidence. The September 2026 smoke-only receipt is historical.

Support

Include these items when you report a failed or surprising read:

  • The full request URL, without an Authorization header. Public reads do not use one.
  • The HTTP status and content-type.
  • request_id from the problem body.
  • Retry-After when the status is 429 or 503.
  • For a successful observation, measure_id, geography_id, period, value_state, release_id, and semantic_version.

There is no API key to rotate and no SDK version to report.

Unavailable in this contract

ItemStatus
Numeric rate-limit quota and concurrency capNot published in the public OpenAPI document. Honor Retry-After
Geography identity payloadDeclared route currently returns 503 CANONICAL_DATA_UNAVAILABLE and no geometry
Daily environmental measure idDescribed on the observations operation. Not present in the current measures catalog. Read environmental_context only when an observation includes it
API keys, required SDKs, and required MCP toolsNot part of anonymous public reads
Account, feedback, conversational AI, and literature retrievalExcluded from the public OpenAPI document