USAspending API ReferenceIndependent
Try the API

List Federal Accounts

GET/api/v2/agency/{toptier_code}/federal_account/
Powers Agency profiles on usaspending.gov How an agency profile is built

Returns a list of Federal Accounts and Treasury Accounts in the Agency's appropriations for a single fiscal year

Request

curl 'https://api.usaspending.gov/api/v2/agency/086/federal_account/'

Path parameters

  • toptier_codestringRequired

    The toptier code of an agency (could be a CGAC or FREC) so only numeric character strings of length 3-4 are accepted.

    Example 086

Query parameters

  • fiscal_yearstring

    The desired appropriations fiscal year. Defaults to the current FY.

  • filterstring

    This will filter the Federal Account by their name to those matching the text.

  • orderenum (string)

    Indicates what direction results should be sorted by. Valid options include asc for ascending order or desc for descending order.

    Allowed values
    • desc
    • asc

    Default desc

  • sortenum (string)

    Optional parameter indicating what value results should be sorted by.

    Allowed values
    • name
    • total_budgetary_resources
    • obligated_amount
    • gross_outlay_amount

    Default obligated_amount

  • pagestring

    The page number that is currently returned.

    Default 1

  • limitstring

    How many results are returned.

    Default 10

Try it

Runs against the live API. Responses are real data.

GET/api/v2/agency/086/federal_account/

Response · 200

  • toptier_codestringRequired
  • fiscal_yearnumberRequired
  • page_metadataobject · PageMetadataRequired7 fields

    Information used for pagination of results.

    • pagenumberRequired
    • totalnumberRequired
    • limitnumberRequired
    • nextnumberRequiredNullable
    • previousnumberRequiredNullable
    • hasNextbooleanRequired
    • hasPreviousbooleanRequired
  • totalsobject · TotalsRequired3 fields
    • total_budgetary_resourcesnumberRequired
    • obligated_amountnumberRequired
    • gross_outlay_amountnumberRequired
  • resultsarray of FederalAccountRequired6 fields
    • namestringRequired
    • codestringRequired
    • total_budgetary_resourcesnumberRequired
    • obligated_amountnumberRequired
    • gross_outlay_amountnumberRequired
    • childrenarray of TreasuryAccountRequired5 fields
      • namestringRequired
      • codestringRequired
      • total_budgetary_resourcesnumberRequired
      • obligated_amountnumberRequired
      • gross_outlay_amountnumberRequired
  • messagesarray of stringRequired

    An array of warnings or instructional directives to aid consumers of this endpoint with development and debugging.

Example response
{
    "toptier_code": "086",
    "fiscal_year": 2018,
    "page_metadata": {
        "page": 1,
        "total": 1,
        "limit": 2,
        "next": 2,
        "previous": null,
        "hasNext": true,
        "hasPrevious": false,
    },
    "totals": {
        "total_budgetary_resources": 66846596521.0,
        "obligated_amount": 56046596521.0,
        "gross_outlay_amount": 49589399932.2,
    },
    "results": [
        "code": "086-0302",
        "name": "Tenant-Based Rental Assistance, Public and Indian Housing, Housing and Urban Development",
        "children": [
            {
                "name": "Tenant-Based Rental Assistance, Public and Indian Housing, Housing and Urban Development",
                "code": "086-X-0302-000",
                "total_budgetary_resources": 65926391527.0,
                "obligated_amount": 55926391527.0,
                "gross_outlay_amount": 49506649058.15
            },
            {
                "name": "Tenant-Based Rental Assistance, Public and Indian Housing, Housing and Urban Development",
                "code": "086-2019/2020-0302-000",
                "total_budgetary_resources": 920204994.0,
                "obligated_amount": 120204994.0,
                "gross_outlay_amount": 82750874.0
            }
        ],
        "total_budgetary_resources": 66846596521.0,
        "obligated_amount": 56046596521.0,
        "gross_outlay_amount": 49589399932.2
    ],
    "messages": []
}

Recent changes

Generated from contracts/v2/agency/toptier_code/federal_account.md in the USAspending API repo.

Loading…