API reference

GET /v1

The API index for this site.

• site, name, tagline
• api_version: "v1"
• links.catalog, links.status

Example: https://api.healthdata.dev/v1

GET /v1/catalog

Every dataset published on this site.

• site
• datasets[]: id, kind, title, description, current (version), published_at, cadence, check_every, sla, discontinued
• datasets[].source: name, url, license, commercial_ok
• datasets[].coverage: start, end

Example: https://api.healthdata.dev/v1/catalog

GET /v1/status

How fresh each dataset is.

• site, generated_at, overall ("ok" or "degraded")
• datasets[]: id, status, version, checked_at, source_updated_at, sla, consecutive_failures, last_error
• status is one of ok, pending, late, stale-upstream, failing, blocked, discontinued

Example: https://api.healthdata.dev/v1/status

GET /v1/{dataset}

Metadata for one dataset: the version that answered, its coverage, source, validation and downloads.

• dataset, kind, title, description, cadence
• version, current_version, pinned, published_at
• source: id, name, publisher, url, license, commercial_ok, attribution, retrieved_at, source_updated_at
• coverage: start, end
• validation: status (pass, warn), warnings[]
• series[]: id, name; for tables also key[] and partition
• downloads[]: name, bytes, url
• links: locations, versions, this_version

Example: https://api.healthdata.dev/v1/overdose-deaths-county

Errors: unknown-dataset , unknown-version , data-unavailable , and rate-limited for any endpoint.

GET /v1/{dataset}/versions

The version history.

• dataset, current, published_at
• previous[]: earlier version ids, newest first
• snapshots: month (YYYY-MM) to version id

Example: https://api.healthdata.dev/v1/overdose-deaths-county/versions

Errors: unknown-dataset , and rate-limited for any endpoint.

GET /v1/{dataset}/locations

What can be requested: each series with its location ids, or for tables the partitions (under the series id "table").

• dataset, version, kind
• series[]: id, name, locations[] (ids)
• locations[]: id, name

Example: https://api.healthdata.dev/v1/overdose-deaths-county/locations

Errors: unknown-dataset , unknown-version , and rate-limited for any endpoint.

GET /v1/{dataset}/{series}/{location}.json

One series at one place, ordered by date. Also .csv.

• meta: dataset, series, series_name, location, location_name, units, source, license, attribution
• data[]: one object per row, with the dataset's columns

Example: https://api.healthdata.dev/v1/overdose-deaths-county/all-drugs/us-county-02261.json

Errors: unknown-file , unknown-format , and rate-limited for any endpoint.

GET /v1/{dataset}/table/{partition}.json

Rows of a table for one partition value; table/all has every row for tables up to 50,000 rows. Also .csv.

• meta: dataset, key, partition (when partitioned), rows (count), units, source, license, attribution
• rows[]: one object per row

Errors: unknown-file , unknown-format , and rate-limited for any endpoint.

GET /v1/{dataset}/download/{dataset}.csv

The whole dataset in one file. Also .parquet. Series downloads add series and location columns.

• CSV (text/csv) or Parquet (application/vnd.apache.parquet)
• Supports Range requests (206)

Example: https://api.healthdata.dev/v1/overdose-deaths-county/download/overdose-deaths-county.csv

Errors: unknown-file , and rate-limited for any endpoint.

GET /v1/{dataset}/{path}

A file of a files dataset, at its published path.

• The file, with a content type from its extension

Errors: unknown-file , and rate-limited for any endpoint.

Drug overdose deaths by county Time series

Id

overdose-deaths-county

Updates

Monthly

Series

all-drugs

Columns

date month (YYYY-MM) , deaths integer, deaths , suppressed true / false , percent_pending number, %

Drug overdose deaths by state and drug Time series

Id

overdose-deaths

Updates

Monthly

Series

all-drugs, opioids, synthetic-opioids, heroin, natural-opioids, methadone, natural-opioids-methadone, all-opioids-excl-heroin, cocaine, psychostimulants, all-causes

Columns

date month (YYYY-MM) , deaths integer, deaths , predicted_deaths integer, deaths , percent_complete number, % , percent_pending number, % , pct_drugs_specified number, % , suppressed true / false , underreported true / false

Health insurance coverage by county and state Time series

Id

uninsured

Updates

Yearly

Series

under-65, adults-18-64, children-under-19

Columns

date year (YYYY) , uninsured_pct number, % , uninsured_pct_moe number, % , uninsured integer, people , uninsured_moe integer, people , population integer, people , population_moe integer, people