# /cms_open_payments/payments/search

`POST /api/cms_open_payments/payments/search`

Price: 20 credits

Search CMS Open Payments payment records by recipient, manufacturer, drug/device and amount

## How to use it

Search detailed CMS Open Payments records of payments and transfers of value made by drug and medical-device manufacturers and group purchasing organizations to physicians, non-physician practitioners and teaching hospitals in the United States. Choose a program year and payment category (General, Research, or Ownership). Filter by recipient (NPI, profile id, name, state, city), paying manufacturer or GPO (name or id), teaching hospital, drug or device name, payment amount range, and — for General payments — nature of payment, form of payment and recipient type. Each record includes the recipient, paying entity, amount, date, nature and form of payment, associated drugs or devices, and — for research payments — the study and principal investigators.

## How to fill these in

- `recipient_state` — Two-letter US state code (e.g. CA, NY, TX)

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `program_year` (string, required) — Program year of the payment data (one of: "2019", "2020", "2021", "2022", "2023", "2024", "2025")
- `payment_type` (string, required) — Payment category to search within (one of: "General", "Research", "Ownership")
- `count` (integer, required) — Max number of results (min: 1)
- `recipient_npi` (string, nullable) — Recipient National Provider Identifier
- `recipient_profile_id` (string, nullable) — CMS covered recipient profile id
- `recipient_last_name` (string, nullable) — Recipient last name (partial match)
- `recipient_first_name` (string, nullable) — Recipient first name (partial match)
- `recipient_state` (string, nullable) — Recipient US state code, e.g. CA
- `recipient_city` (string, nullable) — Recipient city name
- `teaching_hospital_name` (string, nullable) — Teaching hospital name (partial match)
- `manufacturer_name` (string, nullable) — Paying manufacturer or GPO name (partial match)
- `manufacturer_id` (string, nullable) — Paying manufacturer or GPO identifier
- `nature_of_payment` (string, nullable) — Nature of the payment (General payments only) (one of: "Consulting Fee", "Compensation for services other than consulting, including serving as faculty or as a speaker at a venue other than a continuing education program", "Honoraria", "Gift", "Entertainment", "Food and Beverage", "Travel and Lodging", "Education", "Research", "Charitable Contribution", "Royalty or License", "Current or prospective ownership or investment interest", "Compensation for serving as faculty or as a speaker for a medical education program", "Grant", "Space rental or facility fees (teaching hospital only)", "Debt forgiveness", "Long term medical supply or device loan", "Acquisitions")
- `form_of_payment` (string, nullable) — Form of the payment (General and Research payments only) (one of: "Cash or cash equivalent", "In-kind items and services", "Stock, stock option, or any other ownership interest", "Dividend, profit or other return on investment")
- `covered_recipient_type` (string, nullable) — Type of covered recipient (General and Research payments only) (one of: "Covered Recipient Physician", "Covered Recipient Non-Physician Practitioner", "Covered Recipient Teaching Hospital")
- `drug_or_device_name` (string, nullable) — Associated drug, biological, device or medical supply name (partial match)
- `min_amount` (number, nullable) — Minimum total payment amount in US dollars (min: 0)
- `max_amount` (number, nullable) — Maximum total payment amount in US dollars (min: 0)

## Response

### 200 — Successful Response

- `@type` (string) (default: "CmsPayment")
- `record_id` (string, required)
- `program_year` (string, nullable)
- `payment_type` (string, required) (one of: "General", "Research", "Ownership")
- `covered_recipient_type` (string, nullable)
- `recipient_profile_id` (string, nullable)
- `recipient_npi` (string, nullable)
- `recipient_first_name` (string, nullable)
- `recipient_middle_name` (string, nullable)
- `recipient_last_name` (string, nullable)
- `recipient_name_suffix` (string, nullable)
- `recipient_primary_type` (string, nullable)
- `recipient_specialty` (string, nullable)
- `recipient_license_states` (array) (default: [])
- `teaching_hospital_id` (string, nullable)
- `teaching_hospital_ccn` (string, nullable)
- `teaching_hospital_name` (string, nullable)
- `noncovered_recipient_entity_name` (string, nullable)
- `recipient_address_line1` (string, nullable)
- `recipient_address_line2` (string, nullable)
- `recipient_city` (string, nullable)
- `recipient_state` (string, nullable)
- `recipient_zip_code` (string, nullable)
- `recipient_country` (string, nullable)
- `recipient_province` (string, nullable)
- `manufacturer_id` (string, nullable)
- `manufacturer_name` (string, nullable)
- `manufacturer_state` (string, nullable)
- `manufacturer_country` (string, nullable)
- `submitting_manufacturer_name` (string, nullable)
- `amount` (number, nullable)
- `amount_invested` (number, nullable)
- `value_of_interest` (number, nullable)
- `terms_of_interest` (string, nullable)
- `interest_held_by` (string, nullable)
- `date_of_payment` (string, nullable)
- `number_of_payments` (integer, nullable)
- `form_of_payment` (string, nullable)
- `nature_of_payment` (string, nullable)
- `physician_ownership_indicator` (string, nullable)
- `third_party_payment_recipient_indicator` (string, nullable)
- `charity_indicator` (string, nullable)
- `dispute_status` (string, nullable)
- `delay_in_publication_indicator` (string, nullable)
- `related_product_indicator` (string, nullable)
- `contextual_information` (string, nullable)
- `name_of_study` (string, nullable)
- `clinicaltrials_gov_identifier` (string, nullable)
- `research_information_link` (string, nullable)
- `context_of_research` (string, nullable)
- `preclinical_research_indicator` (string, nullable)
- `expenditure_categories` (array) (default: [])
- `products` (array) (default: [])
  - `@type` (string) (default: "CmsPaymentProduct")
  - `indicator` (string, nullable)
  - `type` (string, nullable)
  - `category` (string, nullable)
  - `name` (string, nullable)
  - `ndc` (string, nullable)
  - `pdi` (string, nullable)
- `principal_investigators` (array) (default: [])
  - `@type` (string) (default: "CmsPaymentInvestigator")
  - `profile_id` (string, nullable)
  - `npi` (string, nullable)
  - `first_name` (string, nullable)
  - `middle_name` (string, nullable)
  - `last_name` (string, nullable)
  - `name_suffix` (string, nullable)
  - `primary_type` (string, nullable)
  - `specialty` (string, nullable)
  - `address_line1` (string, nullable)
  - `address_line2` (string, nullable)
  - `city` (string, nullable)
  - `state` (string, nullable)
  - `zip_code` (string, nullable)
  - `country` (string, nullable)
- `payment_publication_date` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.