USAspending API ReferenceIndependent
Try the API

Spending By Transaction Grouped

POST/api/v2/search/spending_by_transaction_grouped/
Powers Keyword search on usaspending.gov

Searches for transaction records based on a provided set of filters and groups them by their prime award.

Request

curl -X POST 'https://api.usaspending.gov/api/v2/search/spending_by_transaction_grouped/' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": {
    "award_type_codes": [
      "A",
      "B",
      "C",
      "D"
    ]
  },
  "page": 1,
  "limit": 35,
  "sort": "award_id",
  "order": "desc"
}'

Request body

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

  • filtersobject · AdvancedFilterObjectRequired

    These filters are applied at the Transaction level. They will not affect the Prime Awards themselves. Must at least provide award_type_codes in the filters object.

  • limitnumber

    The number of results (Prime Awards) to include per page.

    Default 10

    Example 5

  • pagenumber

    The page of results (Prime Awards) to return based on limit.

    Default 1

    Example 1

  • sortenum (string)

    The field on which to order results objects (Prime Awards) in the response.

    Allowed values
    • award_generated_internal_id
    • award_id
    • transaction_count
    • transaction_obligation

    Default transaction_obligation

  • orderenum (string)

    The direction in which to order results (Prime Awards). asc for ascending or desc for descending.

    Allowed values
    • asc
    • desc

    Default desc

Try it

Runs against the live API. Responses are real data.

POST/api/v2/search/spending_by_transaction_grouped/

Response · 200

  • resultsarray of AwardGroupResponseRequired4 fields
    • award_idstringRequired
    • transaction_countnumberRequired
    • transaction_obligationnumberRequired
    • award_generated_internal_idnumberRequired
  • page_metadataobject · PageMetaDataObjectRequired5 fields
    • pagenumberRequired

      Example 1

    • hasNextbooleanRequired

      Example false

    • hasPreviousbooleanRequired

      Example false

    • nextnumberRequiredNullable
    • previousnumberRequiredNullable
  • limitnumberRequired

    Example 10

Example response
{
  "limit": 10,
  "page_metadata": {
    "page": 1,
    "hasPrevious": false,
    "hasNext": true,
    "previous": null,
    "next": 2
  },
  "results": [
    {
      "award_id": "HSSCCG10J00265",
      "transaction_count": 32,
      "transaction_obligation": 55276481.77,
      "award_generated_internal_id": "CONT_AWD_HSSCCG10J00265_7003_HSHQDC06D00026_7001"
    },
    {
      "award_id": "HHSM500201600013U",
      "transaction_count": 42,
      "transaction_obligation": 92960295,
      "award_generated_internal_id": "CONT_AWD_HHSM500201600013U_7530_GS00Q09BGD0039_4735"
    }
  ]
}

Recent changes

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

Loading…