recipient_search

Search every entity that has received federal contract or assistance money, by name, UEI, or legacy DUNS.

Examples

from openbb import obb
# Find a recipient by name.
obb.ustreasury.recipient_search(keyword='Lockheed Martin', provider='us_treasury')
# Look a recipient up by its UEI or legacy DUNS.
obb.ustreasury.recipient_search(keyword='ZFN2JJXBLZT3', provider='us_treasury')
# Rank the largest grant recipients.
obb.ustreasury.recipient_search(award_type='grants', provider='us_treasury')

Parameters

• standard
• us_treasury

keyword: str | None
Search text matched against the recipient name, UEI, or legacy DUNS. Matching is case-insensitive and by prefix, so a partial name or identifier is accepted. When None, the entire recipient list is returned, ordered by the sort parameters.

award_type: str | None
Default: all
Award category the recipient's amount is measured over. Changes both the set of recipients returned and the amount reported for each.

sort: str | None
Default: amount
Field to sort the results by.

order: str | None
Default: desc
Sort order.

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

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

---

Returns

results: UsSpendingRecipientSearch

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

recipient_id: str
Identifier of the recipient at this level, used to look up the recipient's profile and awards.

name: str | None
Name of the recipient.

recipient_level: str | None
Whether the recipient is a Parent, a Child, or neither.

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

duns: str | None
Legacy DUNS number of the recipient.

amount: float | None
Aggregate value of the recipient's transactions over the trailing 12 months, in dollars. Negative when de-obligations exceed obligations.