USAspending API ReferenceIndependent
Try the API

Transactions

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

This endpoint is used to power the Transaction History tables on USAspending.gov's award summary pages. This data can be used to better understand the details of specific transactions on a given award.

This endpoint returns a list of transactions, their amount, type, action date, action type, modification number, and description.

Request

curl -X POST 'https://api.usaspending.gov/api/v2/transactions/' \
  -H 'Content-Type: application/json' \
  -d '{
  "award_id": "CONT_AWD_N0001917C0015_9700_-NONE-_-NONE-",
  "page": 1,
  "sort": "federal_action_obligation",
  "order": "asc",
  "limit": 5000
}'

Request body

  • award_idstringRequired

    Either a "generated" natural award id (string) or a database surrogate award id (number). Generated award identifiers are preferred as they are effectively permanent. Surrogate award ids are retained for backward compatibility but are deprecated.

    Example ASST_NON_NNX17AJ96A_8000

  • limitnumber

    The desired page size of results. (Min: 1 / Max: 5000)

    Default 10

  • pagenumber

    The page of results to return based on the page size provided in limit.

    Default 1

  • sortenum (string)

    The field results are sorted by.

    Allowed values
    • modification_number
    • action_date
    • federal_action_obligation
    • face_value_loan_guarantee
    • original_loan_subsidy_cost
    • action_type_description
    • description

    Default action_date

  • orderenum (string)

    The direction results are sorted by. asc for ascending, desc for descending.

    Allowed values
    • desc
    • asc

    Default desc

Try it

Runs against the live API. Responses are real data.

POST/api/v2/transactions/

Response · 200

  • resultsarray of TransactionResult12 fields
    • action_datestringRequired

      Action date in the format YYYY-MM-DD.

    • action_typestringRequiredNullable

      Action type code

    • action_type_descriptionstringRequiredNullable
    • descriptionstringRequiredNullable
    • face_value_loan_guaranteenumberRequiredNullable

      Face value of the loan. Null for results with award type codes that do not correspond to loans.

    • federal_action_obligationnumberRequiredNullable

      Monetary value of the transaction. Null for results with award type codes that correspond to loans.

    • idstringRequired

      The internal transaction id.

    • modification_numberstringRequired
    • original_loan_subsidy_costnumberRequiredNullable

      Original subsidy cost of the loan. Null for results with award type codes that do not correspond to loans.

    • typestringRequired

      Award type code

    • type_descriptionstringRequiredNullable
    • cfda_numberstringNullable
  • page_metadataobject · PageMetaDataObject5 fields
    • pagenumberRequired
    • nextnumberRequiredNullable
    • previousnumberRequiredNullable
    • hasNextbooleanRequired
    • hasPreviousbooleanRequired
Example response
{
  "page_metadata": {
    "page": 1,
    "next": 2,
    "previous": null,
    "hasNext": true,
    "hasPrevious": false
  },
  "results": [
    {
      "id": "ASST_TX_7022_4337DRFLP00000001_01CPX2002005995_97.036_-NONE-",
      "type": "04",
      "type_description": "PROJECT GRANT (B)",
      "action_date": "2020-01-30",
      "action_type": "A",
      "action_type_description": "NEW",
      "modification_number": null,
      "description": "GRANT TO LOCAL GOVERNMENT FOR REPAIR OR REPLACEMENT OF DISASTER DAMAGED FACILITIES",
      "federal_action_obligation": 11041,
      "face_value_loan_guarantee": null,
      "original_loan_subsidy_cost": null,
      "cfda_number": "12.345"
    }
  ]
}

Recent changes

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

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

Loading…