/cms_medicare/datasets/search

POST /api/cms_medicare/datasets/search

Price: 1 credit

Search the CMS Medicare provider dataset catalog

How to use it

Search the CMS Medicare Provider Data Catalog of provider datasets. Filter by full-text query, provider topic (theme) and keyword; order by relevance, last modified date, or title. Returns each dataset with title, description, keywords, themes, publisher, and downloadable distributions. Use a returned dataset slug or distribution id to fetch the actual provider rows.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• fulltext string — Full-text query over the dataset catalog (default: "")
• count integer required — Number of datasets to return (min: 1)
• theme string nullable — Filter by provider topic (one of: "Dialysis facilities", "Home health services", "Hospice care", "Inpatient rehabilitation facilities", "Long-term care hospitals", "Nursing homes including rehab services", "Doctors and clinicians", "Supplier directory", "Hospitals", "Physician office visit costs")
• keyword string nullable — Filter by exact keyword (examples: "National", "Patient Survey")
• sort string — Result ordering (default: "search_api_relevance"; one of: "search_api_relevance", "modified", "title")
• sort_order string — Sort direction (default: "desc"; one of: "asc", "desc")

Response

• @type string (default: "CmsMedicareDataset")
• alias string required
• description string nullable
• access_level string nullable
• landing_page string nullable
• issued string nullable
• modified string nullable
• released string nullable
• bureau_code array (default: [])
• program_code array (default: [])
• keywords array (default: [])
• themes array (default: [])
• publisher string nullable
• contact_point object nullable
  • @type string (default: "CmsMedicareContactPoint")
  • name string nullable
  • email string nullable
  • url string nullable
• distributions array (default: [])
  • @type string (default: "CmsMedicareDistribution")
  • id string nullable
  • description string nullable
  • media_type string nullable
  • download_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.