recipient_awards

List the federal awards belonging to one recipient, then drill into any award by its id.

Examples

from openbb import obb
# List a recipient's largest contracts.
obb.ustreasury.recipient_awards(recipient_id='b97d19b0-833c-8d8f-3a2c-157d04ea55ef-P', provider='us_treasury')
# List a recipient's grants.
obb.ustreasury.recipient_awards(recipient_id='ab4b0d9e-2a56-a67b-1fb7-b54a68b680ed-P', award_group='grants', provider='us_treasury')

Parameters

• standard
• us_treasury

recipient_id: str
Identifier of the recipient, as returned by the recipient search, e.g. 'ab4b0d9e-2a56-a67b-1fb7-b54a68b680ed-P'. A parent level identifier rolls up the awards of every subsidiary.

award_group: str | None
Default: contracts
Award category to list.

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

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

---

Returns

results: UsSpendingRecipientAwards

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
Identifier of the award, used to look up the award detail.

award_number: str | None
The award's public identifier, its PIID, FAIN, or URI.

recipient_name: str | None
Name of the recipient on the award.

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

award_type: str | None
Human readable award type.

award_amount: float | None
Current total value of the award, in dollars.

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

awarding_agency: str | None
Name of the awarding top-tier agency.

awarding_subagency: str | None
Name of the awarding sub-tier agency.

start_date: date | None | str
Start date of the period of performance.

end_date: date | None | str
End date of the period of performance.

description: str | None
Description of the award.