USAspending API ReferenceIndependent
Try the API

Treasury Account's Object Classes

GET/api/v2/agency/treasury_account/{tas}/object_class/
Powers Agency profiles on usaspending.gov How an agency profile is built

Returns a list of Object Classes for the specified Treasury Account Symbol (tas).

Request

curl 'https://api.usaspending.gov/api/v2/agency/treasury_account/001-X-0000-000/object_class/'

Path parameters

  • tasstringRequired

    The treasury account symbol (tas) of a treasury account. This endpoint supports TAS codes with 0 or 1 slashes in the code.

    Example 001-X-0000-000

Query parameters

  • fiscal_yearstring

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

  • filterstring

    This will filter the Object Classes 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
    • 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/treasury_account/001-X-0000-000/object_class/

Response · 200

  • treasury_account_symbolstringRequired
  • fiscal_yearnumberRequired
  • page_metadataobject · PageMetadataRequired7 fields

    Information used for pagination of results.

    • limitnumberRequired
    • pagenumberRequired
    • nextnumberRequiredNullable
    • previousnumberRequiredNullable
    • hasNextbooleanRequired
    • hasPreviousbooleanRequired
    • totalnumberRequired
  • resultsarray of ObjectClassRequired4 fields
    • namestringRequired
    • obligated_amountnumberRequired
    • gross_outlay_amountnumberRequired
    • childrenarray of ProgramActivityRequired3 fields
      • namestringRequired
      • 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
{
    "treasury_account_symbol": "001-X-0000-000",
    "fiscal_year": 2020,
    "page_metadata": {
        "hasNext": False,
        "hasPrevious": False,
        "limit": 10,
        "next": None,
        "page": 1,
        "previous": None,
        "total": 1,
    },
    "results": [
        {
            "name": "Tenant-Based Rental Assistance, Public and Indian Housing, Housing and Urban Development",
            "obligated_amount": 350.0,
            "gross_outlay_amount": 200.36
            "children": [
                {
                    "name": "EMPLOYEE RETENTION CREDIT",
                    "obligated_amount": 150.0,
                    "gross_outlay_amount": 100.26
                },
                {
                    "name": "BASIC HEALTH PROGRAM",
                    "obligated_amount": 200.0,
                    "gross_outlay_amount": 100.10
                }
            ]
        }
    ],
    "messages": []
}

Recent changes

No contract changes to this endpoint since October 2024. The changelog covers every endpoint.

Generated from contracts/v2/agency/treasury_account/tas/object_class.md in the USAspending API repo.

Loading…