/cms_medicare/datasets/rows

POST /api/cms_medicare/datasets/rows

Price: 5 credits

Query provider rows from a CMS Medicare dataset

How to use it

Query the actual provider rows of any CMS Medicare provider dataset by its slug or distribution id. Each row holds the provider's identity (facility id, name, address, city, state, ZIP, county, phone) plus the dataset-specific quality metrics and ratings. Filter rows by any column with comparison operators, sort by any column, and restrict the returned columns. Column names are snake_case and differ per dataset — discover them with the columns endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• dataset string required — Dataset slug or distribution id (examples: "dgck-syfz"; minLength: 1)
• count integer required — Number of provider rows to return (min: 1)
• conditions array nullable — Column filters applied to the rows (combined with AND)
  • timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
  • column string required — Column name to filter on (examples: "state", "facility_name")
  • operator string — Comparison operator (default: "="; one of: "=", "<>", "starts with", "contains", ">", "<", ">=", "<=", "in")
  • value string required — Value to compare against (examples: "AL", "CHILDREN")
• sorts array nullable — Sorting applied to the rows
  • timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
  • column string required — Column name to sort by (examples: "facility_name")
  • order string — Sort direction (default: "asc"; one of: "asc", "desc")
• properties array nullable — Restrict the returned columns to this subset (examples: ["facility_id","facility_name"])

Response

• @type string (default: "CmsMedicareProviderRow")

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 — Dataset not found 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.