Recipient Spending Disaster/Emergency Funding
/api/v2/disaster/recipient/spending/This endpoint provides insights on the Recipients which received disaster/emergency funding per the requested filters.
Returns spending details of Recipients receiving supplemental funding budgetary resources
Request
curl -X POST 'https://api.usaspending.gov/api/v2/disaster/recipient/spending/' \
-H 'Content-Type: application/json' \
-d '{
"filter": {
"def_codes": [
"L",
"M",
"N",
"O",
"P",
"U"
],
"award_type_codes": [
"02",
"03",
"04",
"05",
"07",
"08",
"10",
"06",
"09",
"11",
"A",
"B",
"C",
"D",
"IDV_A",
"IDV_B",
"IDV_B_A",
"IDV_B_B",
"IDV_B_C",
"IDV_C",
"IDV_D",
"IDV_E",
"-1"
]
},
"pagination": {
"limit": 10,
"page": 1,
"sort": "award_count",
"order": "desc"
},
"spending_type": "total"
}'Request body
filterobject · FilterRequired3 fieldsdef_codesarray of DEFCRequiredList of Disaster Emergency Fund (DEF) Codes (DEFC) defined by legislation at the time of writing. When filtering on
award_type_codesthis will filter on File D records that have at least one File C with the provided DEFC and belong to CARES Act DEFC. A list of current DEFC can be found here.querystringA "keyword" or "search term" to filter down results based on this text snippet
award_type_codesarray of AwardTypeCodesDefaults to all Award Type Codes.
02030405060708091011ABCDIDV_AIDV_B_AIDV_B_BIDV_B_CIDV_BIDV_CIDV_DIDV_E-1F001F002F003F004F005F006F007F008F009F010
paginationobject · Pagination4 fieldspagenumberRequested page of results
limitnumberPage Size of results
orderenum (string)Indicates what direction results should be sorted by. Valid options include asc for ascending order or desc for descending order.
descasc
sortenum (string)Optional parameter indicating what value results should be sorted by
descriptionaward_countobligationoutlay
Try it
Runs against the live API. Responses are real data.
/api/v2/disaster/recipient/spending/Response · 200
totalsobject · TotalsRequired3 fieldsaward_countnumberRequiredobligationnumberRequiredoutlaynumberRequired
resultsarray of ResultRequired6 fieldsidarray of stringRequiredcodestringRequireddescriptionstringRequiredaward_countnumberRequiredobligationnumberRequiredNullableoutlaynumberRequiredNullable
page_metadataobject · PageMetadataRequired7 fieldspagenumberRequirednextnumberRequiredNullablepreviousnumberRequiredNullablehasNextbooleanRequiredhasPreviousbooleanRequiredtotalnumberRequiredlimitnumberRequired
{
"totals": {
"award_count": 4574,
"obligation": 364037369840.58,
"outlay": 290416885040.71
},
"results": [
{
"code": "987654321",
"award_count": 2,
"description": "RECIPIENT 3",
"id": [
"d2894d22-67fc-f9cb-4005-33fa6a29ef86-C",
"d2894d22-67fc-f9cb-4005-33fa6a29ef86-R"
],
"obligation": 2200,
"outlay": 1100
},
{
"code": "456789123",
"award_count": 1,
"description": "RECIPIENT 2",
"id": [
"3c92491a-f2cd-ec7d-294b-7daf91511866-R"
],
"obligation": 20,
"outlay": 0
}
],
"page_metadata": {
"page": 1,
"next": 2,
"previous": null,
"hasNext": true,
"hasPrevious": false,
"total": 23,
"limit": 2
}
}Recent changes
- DEV-15240: Update API contracts with new Assistance Type codes
- Mentioned in the September 21, 2020 release notes
- Mentioned in the August 07, 2020 release notes
Generated from contracts/v2/disaster/recipient/spending.md in the USAspending API repo.