Us Spending Recipient Awards
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
UsSpendingRecipientAwards | UsSpendingRecipientAwardsQueryParams | UsSpendingRecipientAwardsData |
Import Statement
from openbb_core.provider.standard_models. import (
UsSpendingRecipientAwardsData,
UsSpendingRecipientAwardsQueryParams,
)
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.
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.