/usaspending/awards/search

POST /api/usaspending/awards/search

Price: 5 credits

Search U.S. federal awards by keywords and award type

How to use it

Search U.S. federal awards (contracts, IDVs, grants, loans, direct payments, other assistance) by keywords. All award type codes must come from one group. Returns a list projection of each award — award id, recipient, dollar amounts, award type, awarding and funding agencies, performance dates, and description. Use the returned 'id' with the 'awards' endpoint for full award details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keywords array required — Text terms to match against awards (examples: ["Lockheed"], ["solar","energy"]; minItems: 1)
• award_type_codes array required — Award types to include. All codes must belong to the same award group (contracts, IDVs, grants, loans, direct payments, or other financial assistance) (one of: "A", "B", "C", "D", "IDV_A", "IDV_B", "IDV_B_A", "IDV_B_B", "IDV_B_C", "IDV_C", "IDV_D", "IDV_E", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11"; examples: ["A","B","C","D"], ["02","03","04","05"]; minItems: 1)
• count integer required — Number of awards to return (min: 1)
• start_date string nullable — Filter awards active on or after this date (YYYY-MM-DD) (examples: "2020-01-01")
• end_date string nullable — Filter awards active on or before this date (YYYY-MM-DD) (examples: "2024-12-31")
• sort string — Field to sort results by (default: "Award Amount"; one of: "Award Amount", "Total Outlays", "Start Date", "End Date", "Recipient Name", "Award ID", "Last Modified Date", "Awarding Agency")
• order string — Sort direction (default: "desc"; one of: "asc", "desc")

Response

• @type string (default: "UsaspendingAwardSearchResult")
• id string required
• internal_id integer nullable
• award_id string nullable
• recipient_name string nullable
• recipient_id string nullable
• award_amount number nullable
• total_outlay number nullable
• award_type string nullable
• awarding_agency string nullable
• awarding_sub_agency string nullable
• funding_agency string nullable
• funding_sub_agency string nullable
• start_date string nullable
• end_date string nullable
• last_modified_date string nullable
• description string nullable
• agency_slug 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.