POST /api/cms_open_payments/payments/summary
Price: 1 credit
Get national-level CMS Open Payments payment totals and averages by year and category
Get national-level CMS Open Payments aggregate statistics: total, mean and median payment amounts and counts, split between physicians and non-physician practitioners. Optionally filter by program year, payment category (General, Research, Ownership) and covered recipient type.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)program_year string nullable — Filter by program year (one of: "2019", "2020", "2021", "2022", "2023", "2024", "2025")payment_type string nullable — Filter by payment category (one of: "General", "Research", "Ownership")recipient_type string nullable — Filter by covered recipient type (one of: "Covered Recipient Physician", "Covered Recipient Non-Physician Practitioner", "Covered Recipient Teaching Hospital")@type string (default: "CmsPaymentSummary")metric_level string nullablepayment_type string nullablerecipient_type string nullableprogram_year string nullabletotal_number_of_physicians integer nullabletotal_number_of_non_physician_practitioners integer nullabletotal_payment_amount_physician number nullabletotal_payment_amount_non_physician_practitioner number nullablemean_total_payment_amount_physician number nullablemean_total_payment_amount_non_physician_practitioner number nullablemedian_total_payment_amount_physician number nullablemedian_total_payment_amount_non_physician_practitioner number nullabletotal_payment_count_physician integer nullabletotal_payment_count_non_physician_practitioner integer nullablemean_total_payment_count_physician integer nullablemean_total_payment_count_non_physician_practitioner integer nullablemedian_total_payment_count_physician integer nullablemedian_total_payment_count_non_physician_practitioner integer nullable422 — 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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.