USAspending API ReferenceIndependent
Try the API

How an award summary is built

One award: overview, funding, federal accounts, transactions, and subawards, plus the extra calls for IDVs.

An award summary shows everything about one prime award: its amounts and dates, who funded it, which federal accounts paid for it, each transaction that changed it, and the subawards under it.

Which ID to use

Award summary endpoints take generated_unique_award_id, the long ID search results return in generated_internal_id. Award IDs like a PIID or FAIN aren't unique on their own across agencies, so use the generated ID whenever you have it.

Contracts, assistance, and IDVs

The page changes with the award type. Contracts and assistance awards share most calls. Indefinite delivery vehicles (IDVs) add calls for the orders placed under them and for amounts rolled up across those orders, which is why the IDV steps below are marked separately.

The calls, in order

  1. On load

    GETAwards/api/v2/awards/{award_id}/

    Use the generated_unique_award_id from search results.

  2. For the funding summary

    POSTAward Funding Rollup/api/v2/awards/funding_rollup/
  3. For the federal accounts section

    POSTList Federal Accounts/api/v2/awards/accounts/
  4. For the Award History tab counts

    GETTransaction Count/api/v2/awards/count/transaction/{award_id}/
  5. For the Transaction History table

    POSTTransactions/api/v2/transactions/
  6. For the Sub-Awards table

    POSTSubawards/api/v2/subawards/
  7. For Federal Account Funding

    POSTAward Funding/api/v2/awards/funding/
  8. IDVs only: the orders placed under the vehicle

    POSTIDV Related Awards/api/v2/idvs/awards/
  9. IDVs only: rolled-up amounts across child awards

    GETIDV Award Amounts/api/v2/idvs/amounts/{award_id}/

Sources

Traced from these files in the public usaspending-website repo:

Next: How the Download Center works

Loading…