USAspending API ReferenceIndependent
Try the API

List Federal Accounts

POST/api/v2/idvs/accounts/
Powers Award summaries on usaspending.gov How an award summary is built

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

Request

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
}'

Request body

  • award_idstringRequired

    IDV to return accounts for

    Example CONT_IDV_GS30FHA006_4732

  • pagenumber

    Page number to return

    Example 1

  • limitnumber

    Maximum number to return

    Example 10

  • orderstring

    Direction of sort

    Example desc

  • sortstring

    The field to sort on

    Example total_transaction_obligated_amount

Try it

Runs against the live API. Responses are real data.

POST/api/v2/idvs/accounts/

Response · 200

  • resultsarray of AccountListingRequired8 fields
    • total_transaction_obligated_amountnumberRequired
    • federal_accountstringRequired
    • account_titlestringRequired
    • funding_agency_abbreviationstringRequired
    • funding_agency_namestringRequired
    • funding_agency_idnumberRequired
    • funding_toptier_agency_idnumberRequiredNullable
    • funding_agency_slugstringRequiredNullable
  • page_metadataobject · PageMetadataRequired6 fields
    • pagenumberRequired
    • nextnumberRequiredNullable
    • countnumberRequired
    • previousnumberRequiredNullable
    • hasNextbooleanRequired
    • hasPreviousbooleanRequired
Example response
{
  "results": [
    {
      "total_transaction_obligated_amount": 1234.56,
      "federal_account": "075-1301",
      "account_title": "Bureau of Consumer Financial Protection Fund",
      "funding_agency_abbreviation": "NIH",
      "funding_agency_name": "National Institutes of Health",
      "funding_agency_id": 123,
      "funding_toptier_agency_id": 45,
      "funding_agency_slug": "national-institutes-of-health"
    }
  ],
  "page_metadata": {
    "page": 1,
    "next": 2,
    "count": 4,
    "previous": 1,
    "hasNext": true,
    "hasPrevious": false
  }
}

Recent changes

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

Loading…