USAspending API ReferenceIndependent
Try the API

Federal account profiles

Spending, object classes, and program activities for each federal account.

POST3GET10Open on usaspending.gov

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

POSTFederal Accounts Landing Page/api/v2/federal_accounts/

This endpoint supports the federal account landing page, which provides a list of all federal accounts for which individual federal accounts pages are available on USAspending.gov.

filterssortlimitpagekeyword
curl -X POST 'https://api.usaspending.gov/api/v2/federal_accounts/' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": {
    "agency_identifier": "339",
    "fy": "2018"
  },
  "sort": {
    "direction": "asc",
    "field": "account_name"
  }
}'
Full reference and live console Contract
GETFederal Accounts Landing Page/api/v2/federal_accounts/{account_number}/

This endpoint supports the federal account landing page, which provides a list of all federal accounts for which individual federal accounts pages are available on USAspending.gov.

{account_number} *?fiscal_year
curl 'https://api.usaspending.gov/api/v2/federal_accounts/011/'
Full reference and live console Contract
POSTObject Classes Total/api/v2/federal_accounts/{federal_account_code}/object_classes/total

This endpoint returns an array of object classes obligation, code, and name for the specified federal account

{federal_account_code} *filterslimitpage
curl -X POST 'https://api.usaspending.gov/api/v2/federal_accounts/431-0500/object_classes/total' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": {
    "time_period": [
      {
        "start_date": "2019-10-01",
        "end_date": "2020-09-30"
      }
    ],
    "program_activity": [
      "001"
    ]
  }
}'
Full reference and live console Contract
GETProgram Activities/api/v2/federal_accounts/{federal_account_code}/program_activities/

This route returns program activities that the specified federal account has allotted money toward.

{federal_account_code} *?limit?page?sort?order
curl 'https://api.usaspending.gov/api/v2/federal_accounts/431-0500/program_activities/'
Full reference and live console Contract
POSTProgram Activities Total/api/v2/federal_accounts/{federal_account_code}/program_activities/total

This endpoint returns an array of each program activity's obligation, code, name, and type for the specified federal account

{federal_account_code} *filterslimitpage
curl -X POST 'https://api.usaspending.gov/api/v2/federal_accounts/431-0500/program_activities/total' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": {
    "time_period": [
      {
        "start_date": "2019-10-01",
        "end_date": "2020-09-30"
      }
    ],
    "program_activity": [
      "0001"
    ]
  }
}'
Full reference and live console Contract
GETAvailable Object Classes/api/v2/federal_accounts/{federal_account_id}/available_object_classes

This route returns object classes that the specified federal account has allotted money toward.

{federal_account_id} *
curl 'https://api.usaspending.gov/api/v2/federal_accounts/5/available_object_classes'
Full reference and live console Contract
GETList of Available Program Activities/api/v2/federal_accounts/{federal_account_id}/available_program_activities

This endpoint supports the Federal Account page and allows for listing all Program Activities with activity by the Federal Account.

{federal_account_id} *
curl 'https://api.usaspending.gov/api/v2/federal_accounts/5/available_program_activities'
Full reference and live console Contract
GETFiscal Year Snapshot/api/v2/federal_accounts/{federal_account_id}/fiscal_year_snapshot/

This route sends a request to the backend to retrieve budget information for a federal account.

{federal_account_id} *
curl 'https://api.usaspending.gov/api/v2/federal_accounts/6000/fiscal_year_snapshot/'
Full reference and live console Contract
GETFiscal Year Snapshot/api/v2/federal_accounts/{federal_account_id}/fiscal_year_snapshot/{fiscal_year}/

This route sends a request to the backend to retrieve budget information for a federal account.

{federal_account_id} *{fiscal_year} *
curl 'https://api.usaspending.gov/api/v2/federal_accounts/6000/fiscal_year_snapshot/2018/'
Full reference and live console Contract
GETFederal Obligations/api/v2/federal_obligations/

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

?fiscal_year *?funding_agency_id *?limit?page
curl 'https://api.usaspending.gov/api/v2/federal_obligations/?fiscal_year=2017&funding_agency_id=456'
Full reference and live console Contract
GETAgency Profile/api/v2/financial_balances/agencies/

These endpoints are used to power USAspending.gov's agency profile pages.

?fiscal_year *?funding_agency_id *
curl 'https://api.usaspending.gov/api/v2/financial_balances/agencies/?fiscal_year=2017&funding_agency_id=456'
Full reference and live console Contract
GETMajor Object Classes/api/v2/financial_spending/major_object_class/

These endpoints are used to power USAspending.gov's agency profile pages.

?fiscal_year *?funding_agency_id *
curl 'https://api.usaspending.gov/api/v2/financial_spending/major_object_class/?fiscal_year=2017&funding_agency_id=456'
Full reference and live console Contract
GETMinor Object Classes/api/v2/financial_spending/object_class/

These endpoints are used to power USAspending.gov's agency profile pages.

?fiscal_year *?funding_agency_id *?major_object_class_code *
curl 'https://api.usaspending.gov/api/v2/financial_spending/object_class/?fiscal_year=2017&funding_agency_id=456&major_object_class_code=30'
Full reference and live console Contract

Loading…