award

Drill into a federal award from USAspending - its summary, transactions, subawards, federal accounts, funding, or the orders placed against a vehicle.

Examples

from openbb import obb
# Get the summary of an award by its usaspending.gov id.
obb.ustreasury.award(award_id='CONT_IDV_15F06724A0000314_1549', provider='us_treasury')
# Drill into the subawards of an award.
obb.ustreasury.award(award_id='CONT_IDV_15F06724A0000314_1549', section='subawards', provider='us_treasury')
# Get the orders placed against an indefinite delivery vehicle.
obb.ustreasury.award(award_id='CONT_IDV_15F06724A0000314_1549', section='idv_children', provider='us_treasury')

Parameters

• standard
• us_treasury

award_id: str
The award identifier, as it appears in a usaspending.gov/award/<id> URL, e.g. 'CONT_IDV_15F06724A0000314_1549'. The internal integer award id is also accepted.

section: str | None
Default: detail
The section of the award to return. 'detail' returns the award summary as a single row. 'idv_children' is only valid for IDV awards.

idv_children_type: str | None
Default: child_awards
For section='idv_children', the relation to return. 'child_awards' are the orders placed against the vehicle, 'child_idvs' are nested vehicles, and the two are disjoint sets.

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 5000 for 'transactions' and 100 for every other paginated section. Ignored when section='detail'.

---

Returns

results: UsSpendingAward

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

action_date: date | None
Date the transaction or subaward action was taken.

award_id: str
Identifier of the award the row belongs to.

child_award_id: str | None
Identifier of the child award, for section='idv_children'. Supply it back as award_id to drill into the child.

transaction_id: str | None
Natural identifier of the transaction, for section='transactions'.

modification_number: str | None
Modification number of the transaction.

subaward_id: int | None
Internal identifier of the subaward, for section='subawards'.

subaward_number: str | None
Subaward number as reported by the prime recipient. Not unique - it can repeat across rows.

piid: str | None
Procurement Instrument Identifier, for contracts and IDVs.

fain: str | None
Federal Award Identification Number, for assistance awards.

uri: str | None
Unique Record Identifier, for assistance awards.

parent_award_id: str | None
Identifier of the parent IDV, when the award has one.

parent_piid: str | None
PIID of the parent IDV, when the award has one.

internal_id: int | None
Internal surrogate identifier of the row's award.

record_type: int | None
Assistance record type - 1 is aggregate, 2 and 3 are non-aggregate.

category: str | None
Award category - contract, idv, grant, loans, direct payment, other, or insurance.

award_type: str | None
Award type code, e.g. 'IDV_E' or '02'.

award_type_description: str | None
Human readable award type, e.g. 'BPA'.

action_type: str | None
Action type code of the transaction, e.g. 'A' or 'G'.

action_type_description: str | None
Human readable action type of the transaction.

amount: float | None
Face value of the subaward, in dollars, for section='subawards'.

federal_action_obligation: float | None
Obligation recorded by the transaction, in dollars. This is a per-modification delta and is negative for de-obligations.

obligated_amount: float | None
Amount obligated to the child award, in dollars, for section='idv_children'.

total_obligation: float | None
Total amount obligated to the award, in dollars. Reported as 0 for an IDV, whose obligations sit on its children.

base_and_all_options: float | None
Award ceiling if all options are exercised, in dollars. Null for assistance awards.

base_exercised_options: float | None
Award value including exercised options, in dollars.

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

total_account_obligation: float | None
Total obligation reported in the award's federal account records, in dollars.

total_account_outlay: float | None
Total outlay reported in the award's federal account records, in dollars.

subaward_count: int | None
Number of subawards reported under the award.

total_subaward_amount: float | None
Total value of subawards reported under the award, in dollars. Null when there are no subawards.

total_subsidy_cost: float | None
Total subsidy cost, in dollars. Loans only.

total_loan_value: float | None
Total face value of the loan, in dollars. Loans only.

face_value_loan_guarantee: float | None
Face value of the loan guarantee, in dollars. Loans only.

original_loan_subsidy_cost: float | None
Original subsidy cost of the loan, in dollars. Loans only.

non_federal_funding: float | None
Non-federal funding, in dollars. Grants only.

total_funding: float | None
Total federal and non-federal funding, in dollars. Grants only.

transaction_obligated_amount: float | None
Amount obligated by the funding record, in dollars. Mutually exclusive with gross_outlay_amount on a funding row.

gross_outlay_amount: float | None
Amount outlayed by the funding record, in dollars. Negative values are downward adjustments. Mutually exclusive with transaction_obligated_amount on a funding row.

total_transaction_obligated_amount: float | None
Amount obligated from the federal account, in dollars, for section='federal_accounts'. Coalesced to 0 by the source when no funding records exist.

date_signed: date | None
Date the award was signed.

period_start: date | None
Start date of the period of performance.

period_end: date | None
Current end date of the period of performance.

period_potential_end: date | None
Potential end date of the period of performance, if all options are exercised.

last_date_to_order: date | None
Last date an order may be placed against the vehicle, for section='idv_children'.

last_modified: date | None
Date the award record was last modified.

recipient_name: str | None
Name of the recipient. For section='subawards' this is the subrecipient, otherwise the prime recipient.

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

parent_recipient_name: str | None
Name of the recipient's parent entity.

parent_recipient_uei: str | None
Unique Entity Identifier of the recipient's parent entity.

recipient_city: str | None
City of the recipient.

recipient_state: str | None
State code of the recipient.

recipient_zip: str | None
Five digit ZIP code of the recipient.

recipient_country: str | None
Country of the recipient.

recipient_congressional_district: str | None
Congressional district of the recipient.

place_of_performance_city: str | None
City where the award is performed.

place_of_performance_state: str | None
State code where the award is performed.

place_of_performance_country: str | None
Country where the award is performed.

place_of_performance_congressional_district: str | None
Congressional district where the award is performed.

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

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

awarding_office: str | None
Name of the awarding office.

funding_agency: str | None
Name of the funding top-tier agency.

funding_subagency: str | None
Name of the funding sub-tier agency.

funding_office: str | None
Name of the funding office.

funding_agency_abbreviation: str | None
Abbreviation of the funding agency, for section='federal_accounts'.

naics: str | None
North American Industry Classification System code.

naics_description: str | None
Description of the NAICS code.

psc: str | None
Product or Service Code.

psc_description: str | None
Description of the Product or Service Code.

cfda_number: str | None
Assistance Listing (CFDA) number. Assistance awards only.

cfda_title: str | None
Assistance Listing (CFDA) title. Assistance awards only.

federal_account: str | None
Federal account identifier, as '<agency code>-<main account code>'.

account_title: str | None
Title of the federal account.

disaster_emergency_fund_code: str | None
Disaster Emergency Fund Code, where 'Q' is non-disaster funding.

object_class: str | None
Object class code, e.g. '25.1'.

object_class_name: str | None
Name of the object class.

program_activity_code: str | None
Program activity code.

program_activity_name: str | None
Name of the program activity.

reporting_fiscal_year: int | None
Federal fiscal year of the submission.

reporting_fiscal_quarter: int | None
Federal fiscal quarter of the submission.

reporting_fiscal_month: int | None
Federal fiscal month of the submission, where 1 is October and 12 is September.

is_quarterly_submission: bool | None
True when the submission is quarterly, False when monthly.

description: str | None
Description of the award, transaction, or subaward.