Status
GEThttps://api.inplan.io/v1/status
Whether the API is up, and the date each source type is current to. No key needed, and it never counts against a quota.
WHEN TO USE IT
Use it for health checks and uptime monitors, and to read data dates without spending calls. Each client may call it up to 5 times a second.
PARAMETERS
None. No key needed.
RESPONSE FIELDS
Every response has the envelope request_id, data_as_of, data, sources and notes (details). Fields of data:
| FIELD | DESCRIPTION |
|---|---|
statusstring | ok, degraded (answers still served), busy or paused. busy and paused come with HTTP 503. |
api_enabledboolean | false while the API is paused for maintenance. |
versionstring | The running API build. |
timestring | Server time, ISO 8601 UTC. |
checksobject | Health of the parts behind the API. |
checks.databaseobject | The database check. |
checks.database.okboolean | true when the database answered. |
checks.database.latency_msinteger | null | Time the database check took, in milliseconds. |
checks.cacheobject | The cache check. |
checks.cache.okboolean | true when the cache answered. |
datasetsobject[] | Every source type with the date it is current to. |
datasets[].typestring | The source type: insurer_directory, plan_directory, provider_registry or plan_catalog. |
datasets[].descriptionstring | The source type in plain words. |
datasets[].as_ofdate | The date this type of data is current to. |
RESPONSES
status is ok, or degraded while answers are still served.
200 OK · application/json
{ "request_id": "req_me9mgrJWQxf7oYGP", "data_as_of": "2026-10-29", "data": { "status": "ok", "api_enabled": true, "version": "d470109", "time": "2026-10-30T09:28:11.713Z", "checks": { "database": { "ok": true, "latency_ms": 0 }, "cache": { "ok": true } }, "datasets": [ { "type": "insurer_directory", "description": "Provider network directories published by health insurers", "as_of": "2026-10-29" }, { "type": "plan_directory", "description": "Provider network directories published by Medicare Advantage plans", "as_of": "2026-10-29" }, { "type": "provider_registry", "description": "National provider registry and practice records", "as_of": "2026-10-29" }, { "type": "plan_catalog", "description": "Published health plan catalogs", "as_of": "2026-10-28" } ] }, "sources": [ { "type": "insurer_directory", "description": "Provider network directories published by health insurers", "as_of": "2026-10-29" }, { "type": "plan_directory", "description": "Provider network directories published by Medicare Advantage plans", "as_of": "2026-10-29" }, { "type": "provider_registry", "description": "National provider registry and practice records", "as_of": "2026-10-29" }, { "type": "plan_catalog", "description": "Published health plan catalogs", "as_of": "2026-10-28" } ]}
ERROR FORMAT
Errors use application/problem+json (RFC 7807) with type, title, status, detail, instance, request_id and docs. Other statuses this endpoint can return: 503 with status busy or paused and a Retry-After header, and 429 above 5 requests a second from one client. See Errors.