/usaspending/recipients

POST /api/usaspending/recipients

Price: 1 credit

Get federal spending recipient details by recipient identifier

How to use it

Get full details of a U.S. federal spending recipient (a company, organization, or government entity that received federal awards) by its recipient identifier. Returns name and alternate names, business registration identifiers (DUNS, UEI), recipient level, parent organization, business type categories, location, and lifetime totals of transaction amounts, transaction counts, and face value of loans.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• recipient_id string required — Recipient identifier (UUID with a level suffix -R, -P or -C) (examples: "b97d19b0-833c-8d8f-3a2c-157d04ea55ef-P", "b97d19b0-833c-8d8f-3a2c-157d04ea55ef-C"; pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}-[RPC]$)

Response

• @type string (default: "UsaspendingRecipient")
• id string required
• name string nullable
• alternate_names array (default: [])
• duns string nullable
• uei string nullable
• recipient_level string nullable (one of: "R", "P", "C")
• parent_id string nullable
• parent_name string nullable
• parent_duns string nullable
• parent_uei string nullable
• parents array (default: [])
  • @type string (default: "UsaspendingRecipientParent")
  • parent_id string nullable
  • parent_name string nullable
  • parent_duns string nullable
  • parent_uei string nullable
• business_types array (default: [])
• location object nullable
  • @type string (default: "UsaspendingRecipientLocation")
  • address_line1 string nullable
  • address_line2 string nullable
  • address_line3 string nullable
  • city_name string nullable
  • county_name string nullable
  • state_code string nullable
  • zip5 string nullable
  • zip4 string nullable
  • foreign_postal_code string nullable
  • foreign_province string nullable
  • country_name string nullable
  • country_code string nullable
  • congressional_code string nullable
• total_transaction_amount number nullable
• total_transactions integer nullable
• total_face_value_loan_amount number nullable
• total_face_value_loan_transactions integer 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 — Recipient 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.