USAspending API ReferenceIndependent
Try the API

Award summaries

One award: its funding, transactions, subawards, and, for IDVs, the orders under it.

GET7POST10Open on usaspending.gov How an award summary is built

Open a row for parameters and ready-to-run samples. The full reference has every field and a live console.

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

This endpoint is used to power USAspending.gov's award profile pages.

{award_id} *
curl 'https://api.usaspending.gov/api/v2/awards/CONT_AWD_H907_9700_SPE2DX16D1500_9700/'
Full reference and live console Contract
POSTList Federal Accounts/api/v2/awards/accounts/

This endpoint returns a list of federal accounts under a given award.

award_idpagelimitordersort
curl -X POST 'https://api.usaspending.gov/api/v2/awards/accounts/' \
  -H 'Content-Type: application/json' \
  -d '{
  "limit": 10,
  "sort": "total_transaction_obligated_amount",
  "order": "desc",
  "award_id": "CONT_AWD_N0001917C0001_9700_-NONE-_-NONE-",
  "page": 1
}'
Full reference and live console Contract
GETFederal Accounts Count/api/v2/awards/count/federal_account/{award_id}/

This endpoint is used for the federal accounts tab on the awards page.

{award_id} *
curl 'https://api.usaspending.gov/api/v2/awards/count/federal_account/ASST_NON_NNX17AJ96A_8000/'
Full reference and live console Contract
GETSubaward Count/api/v2/awards/count/subaward/{award_id}/

This endpoint is used for the subawards tab on the awards page.

{award_id} *
curl 'https://api.usaspending.gov/api/v2/awards/count/subaward/ASST_NON_NNX17AJ96A_8000/'
Full reference and live console Contract
GETTransaction Count/api/v2/awards/count/transaction/{award_id}/

This endpoint is used for the transaction history tab on the awards page.

{award_id} *
curl 'https://api.usaspending.gov/api/v2/awards/count/transaction/ASST_NON_NNX17AJ96A_8000/'
Full reference and live console Contract
POSTAward Funding Rollup/api/v2/awards/funding_rollup/

This endpoint returns the total transaction obligations and count of awarding agencies, funding agencies, and federal accounts for an award.

award_id
curl -X POST 'https://api.usaspending.gov/api/v2/awards/funding_rollup/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_AWD_N0001902C3002_9700_-NONE-_-NONE-",
  "page": 1,
  "sort": "reporting_fiscal_date",
  "order": "asc",
  "limit": 15
}'
Full reference and live console Contract
POSTAward Funding/api/v2/awards/funding/

Used to populate the Federal Account Funding tab on the Award V2 summary pages

award_idlimitpagesortorderBody
curl -X POST 'https://api.usaspending.gov/api/v2/awards/funding/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_AWD_0002_2800_SS001740003_2800",
  "limit": 5,
  "page": 1,
  "sort": "reporting_fiscal_date",
  "order": "desc",
  "Body": ""
}'
Full reference and live console Contract
GETAwards Last Updated/api/v2/awards/last_updated/

This route sends a request to the backend to retrieve the last updated date for the Award data.

curl 'https://api.usaspending.gov/api/v2/awards/last_updated/'
Full reference and live console Contract
POSTList Federal Accounts/api/v2/idvs/accounts/

This endpoint returns a list of federal accounts under a given IDV.

award_idpagelimitordersort
curl -X POST 'https://api.usaspending.gov/api/v2/idvs/accounts/' \
  -H 'Content-Type: application/json' \
  -d '{
  "limit": 10,
  "sort": "total_transaction_obligated_amount",
  "order": "desc",
  "award_id": "CONT_IDV_TMHQ10C0040_2044",
  "page": 1
}'
Full reference and live console Contract
POSTIDV Activity/api/v2/idvs/activity/

This endpoint is used to power the IDV (Indefinite Delivery Vehicle) Activity visualization on IDV Summary Pages.

award_idlimitpagehide_edge_cases
curl -X POST 'https://api.usaspending.gov/api/v2/idvs/activity/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_IDV_TMHQ10C0040_2044",
  "page": 1,
  "hide_edge_cases": true,
  "limit": 50
}'
Full reference and live console Contract
GETIDV Award Amounts/api/v2/idvs/amounts/{award_id}/

Used to populate the Federal Account Funding tab on the IDV summary page.

{award_id} *
curl 'https://api.usaspending.gov/api/v2/idvs/amounts/CONT_IDV_FA304715A0037_9700/'
Full reference and live console Contract
POSTIDV Related Awards/api/v2/idvs/awards/

List child IDVs, child awards, or grandchild awards for IDV

award_idtypelimitpagesortorder
curl -X POST 'https://api.usaspending.gov/api/v2/idvs/awards/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_IDV_TMHQ10C0040_2044",
  "type": "child_awards",
  "limit": 10,
  "page": 1,
  "sort": "period_of_performance_start_date",
  "order": "desc"
}'
Full reference and live console Contract
GETFederal Accounts Count/api/v2/idvs/count/federal_account/{award_id}/

This endpoint is used for the federal accounts tab on the idv summary page.

{award_id} *
curl 'https://api.usaspending.gov/api/v2/idvs/count/federal_account/CONT_IDV_NNK14MA74C_8000/'
Full reference and live console Contract
POSTIDV Funding Rollup/api/v2/idvs/funding_rollup/

This endpoint returns award metadata summing the total transaction obligations and counting awarding agencies, funding agencies, and federal accounts for an IDV's children and grandchildren.

award_id
curl -X POST 'https://api.usaspending.gov/api/v2/idvs/funding_rollup/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_IDV_TMHQ10C0040_2044"
}'
Full reference and live console Contract
POSTIDV Funding/api/v2/idvs/funding/

Used to populate the Federal Account Funding tab on the IDV summary page.

award_idpiidlimitpagesortorder
curl -X POST 'https://api.usaspending.gov/api/v2/idvs/funding/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_IDV_TMHQ10C0040_2044",
  "page": 1,
  "sort": "piid",
  "order": "asc",
  "limit": 15
}'
Full reference and live console Contract
POSTSubawards/api/v2/subawards/

This endpoint returns a list of data that is associated with the award profile page.

pagelimitsortorderaward_id
curl -X POST 'https://api.usaspending.gov/api/v2/subawards/' \
  -H 'Content-Type: application/json' \
  -d '{
  "page": 1,
  "limit": 15,
  "sort": "subaward_number",
  "order": "desc",
  "award_id": "25882628"
}'
Full reference and live console Contract
POSTTransactions/api/v2/transactions/

This endpoint is used to power the Transaction History tables on USAspending.gov's award summary pages.

award_idlimitpagesortorder
curl -X POST 'https://api.usaspending.gov/api/v2/transactions/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_AWD_N0001917C0015_9700_-NONE-_-NONE-",
  "page": 1,
  "sort": "federal_action_obligation",
  "order": "asc",
  "limit": 5000
}'
Full reference and live console Contract

Loading…