/datagov/datasets/search

POST /api/datagov/datasets/search

Price: 5 credits

Search the U.S. government open data catalog

How to use it

Search Data.gov, the U.S. government open data catalog of 290k+ datasets. Filter by full-text query, organization type, organization slug, publisher, keyword, and geospatial flag; order by relevance, popularity, or last harvested date. Returns each dataset with title, description, identifier, license, keywords, themes, publisher, publishing organization, and downloadable distributions (files).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• q string — Full-text search query over the dataset catalog (default: "")
• count integer required — Number of datasets to return (min: 1)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "popularity", "last_harvested_date")
• org_type string nullable — Filter by publishing organization type (one of: "Federal Government", "State Government", "County Government", "City Government", "Tribal", "Non-Profit", "University")
• org_slug string nullable — Filter by organization slug (examples: "census", "california")
• publisher string nullable — Filter by exact publisher name (examples: "U.S. Geological Survey")
• keyword string nullable — Filter by exact keyword (examples: "climate", "water")
• spatial_filter string — Restrict to geospatial or non-geospatial datasets (default: ""; one of: "", "geospatial", "non-geospatial")

Response

• @type string (default: "DatagovDataset")
• alias string required
• description string nullable
• identifier string nullable
• access_level string nullable
• license string nullable
• rights string nullable
• issued string nullable
• modified string nullable
• temporal string nullable
• accrual_periodicity string nullable
• last_harvested_date string nullable
• landing_page string nullable
• publisher string nullable
• bureau_code array (default: [])
• program_code array (default: [])
• language array (default: [])
• keywords array (default: [])
• themes array (default: [])
• spatial string nullable
• has_spatial boolean (default: false)
• popularity integer nullable
• data_quality boolean nullable
• is_part_of string nullable
• harvest_record_url string nullable
• contact_point object nullable
  • @type string (default: "DatagovContactPoint")
  • name string nullable
  • email string nullable
• organization object nullable
  • @type string (default: "DatagovDatasetOrganization")
  • id string nullable
  • alias string nullable
  • name string nullable
  • organization_type string nullable
  • image string nullable
  • description string nullable
  • aliases array (default: [])
• distributions array (default: [])
  • @type string (default: "DatagovDistribution")
  • description string nullable
  • format string nullable
  • media_type string nullable
  • download_url string nullable
  • access_url string nullable
  • described_by string nullable
  • described_by_type string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.