USAspending API ReferenceIndependent
Try the API

Availability Type Code

POST/api/v2/autocomplete/accounts/a/
Powers Search filter pickers on usaspending.gov How Advanced Search works

This endpoint powers the USAspending.gov Availability Type Code (A) autocomplete in the Advanced Search -> Program Source -> Treasury Account filter.

List of potential Availability Type Codes

Request

curl -X POST 'https://api.usaspending.gov/api/v2/autocomplete/accounts/a/' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": {
    "aid": "000"
  },
  "limit": 3
}'

Request body

The filters object is shared by every search endpoint. The filter object explains each filter with examples.

  • filtersobject · ComponentFiltersRequired

    Each component listed here may be omitted, null, or a string value. If omitted, no filtering will be performed on that component. If null, the filter will include account numbers missing that component. If a string, the filter will perform an exact match on account numbers where that component matches the string provided.

    • ata (optional, string, nullable) Allocation Transfer Agency Identifier (3 characters). TAS only.

    • aid (optional, string, nullable) Agency Identifier (3 characters).

    • bpoa (optional, string, nullable) Beginning Period of Availability (4 characters). TAS only.

    • epoa (optional, string, nullable) Ending Period of Availability (4 characters). TAS only.

    • a (optional, string, nullable) Availability Type Code (1 character). Will either be 'X' or null. TAS only.

    • main (optional, string, nullable) Main Account Code (4 characters).

    • sub (optional, string, nullable) Sub Account Code (3 characters). TAS only.

  • limitnumber

    Number of results to return (min: 1, max: 500)

    Default 10

Try it

Runs against the live API. Responses are real data.

POST/api/v2/autocomplete/accounts/a/

Response · 200

  • resultsarray of stringRequired
Example response
{
  "results": [
    "X",
    null
  ]
}

Recent changes

Generated from contracts/v2/autocomplete/accounts/a.md in the USAspending API repo.

Loading…