award_search

Search federal contract and assistance awards from USAspending by agency, recipient, keyword, amount, and date, then drill into any award by its id.

Examples

from openbb import obb
# Search the largest recent defense contracts.
obb.ustreasury.award_search(award_group='contracts', agency='Department of Defense', provider='us_treasury')
# Find recent grants to a recipient by keyword.
obb.ustreasury.award_search(award_group='grants', recipient='California', keywords='medicaid', provider='us_treasury')

Parameters

• standard
• us_treasury

award_group: str | None
Default: contracts
Award family to search: 'contracts', 'idvs' (indefinite delivery vehicles), 'grants', 'direct_payments', 'loans', or 'other_assistance'. Sets the underlying award-type codes.

start_date: date | None | str
Start date of the data, in YYYY-MM-DD format. Filters on the award action period. When None, defaults to the trailing 365 days rather than all of history.

end_date: date | None | str
End date of the data, in YYYY-MM-DD format. Filters on the award action period.

keywords: str | None
Free-text search over award descriptions and identifiers. Accepts a comma-separated list; awards matching any term are kept.

recipient: str | None
Recipient name search text, e.g. 'Boeing'.

agency: str | None
Awarding top-tier agency name, exactly as published, e.g. 'Department of Defense'.

min_amount: float | None
Minimum award amount, in dollars.

max_amount: float | None
Maximum award amount, in dollars.

award_number: str | None
Award number, its PIID, FAIN, or URI, e.g. 'SPE30018FLGFZ'. Accepts a comma-separated list. Matching is fuzzy; wrap a value in double quotes for an exact match, which is needed for identifiers containing spaces.

description: str | None
Search text matched against the award description only, unlike 'keywords', which also searches identifiers.

naics: str | None
North American Industry Classification System code, e.g. '541519'. Accepts a comma-separated list. Validated against the source's reference list.

psc: str | None
Product or Service Code, e.g. 'R425'. Accepts a comma-separated list. Validated against the source's reference list.

assistance_listing: str | None
Assistance Listing (CFDA) program number, e.g. '10.331'. Accepts a comma-separated list. Validated against the source's reference list. Assistance awards only.

defc: str | None
Disaster Emergency Fund Code, e.g. 'L' for COVID-19 or 'Z' for infrastructure. Accepts a comma-separated list.

contract_pricing: str | None
Type of contract pricing, by code, e.g. 'J' for Firm Fixed Price. Accepts a comma-separated list. Contracts and IDVs only.

set_aside: str | None
Type of set aside, by code, e.g. 'SBA' for Small Business Set Aside - Total. Accepts a comma-separated list. Contracts and IDVs only.

extent_competed: str | None
Extent competed, by code, e.g. 'A' for Full and Open Competition. Accepts a comma-separated list. Contracts and IDVs only.

sort: str | None
Default: Award Amount
Field to sort by.

order: str | None
Default: desc
Sort order.

page: int | None
Default: 1
The page of results to return.

limit: int | None
Default: 100
The number of data entries to return. Capped by the source at 100.

---

Returns

results: UsSpendingAwardSearch

Serializable results.

provider: str | None

Provider name.

warnings: Optional[list[Warning_]]

List of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---

Data

• standard
• us_treasury

award_id: str
USAspending award identifier, as used by the award drill-down, e.g. 'CONT_AWD_HT940216C0001_9700_-NONE-_-NONE-'. Click it to open the award in the drill-down widgets.

award_number: str | None
Published award number: the contract PIID, or the assistance FAIN or URI.

recipient_name: str | None
Name of the award recipient.

recipient_uei: str | None
Unique Entity Identifier of the recipient.

award_type: str | None
Award type, e.g. 'DEFINITIVE CONTRACT' or 'BLOCK GRANT (A)'.

award_amount: float | None
Current total award amount, in dollars.

total_outlays: float | None
Total outlays paid against the award, in dollars.

awarding_agency: str | None
Awarding top-tier agency.

awarding_sub_agency: str | None
Awarding sub-agency.

start_date: date | None | str
Period-of-performance start date.

end_date: date | None | str
Period-of-performance current end date.

description: str | None
Award description.

recipient_id: str | None
Internal recipient identifier.

internal_id: int | None
Internal award identifier.