Route: /api/v2/search/spending_by_award/
Method: POST
This route takes award filters and fields, and returns the fields of the filtered awards.
field: Defines what award variables are returned.
filter: Defines how the awards are filtered. The filter object is defined here.
https://github.com/fedspendingtransparency/usaspending-api/wiki/Search-Filters-v2-Documentation
limit(OPTIONAL): how many results are returned
page (OPTIONAL): what page of results are returned
sort (OPTIONAL): Optional parameter indicating what value results should be sorted by. Valid options are any of the fields in the JSON objects in the response. Defaults to the first field provided.
order (OPTIONAL): Optional parameter indicating what direction results should be sorted by. Valid options include asc for ascending order or desc for descending order. Defaults to asc.
subawards (OPTIONAL): If true, include subaward data for each award. Defaults to false.
{
"filters": {
"award_type_codes": ["10"],
"agencies": [
{
"type": "awarding",
"tier": "toptier",
"name": "Social Security Administration"
},
{
"type": "awarding",
"tier": "subtier",
"name": "Social Security Administration"
},
{
"type": "funding",
"tier": "toptier",
"name": "Social Security Administration"
},
{
"type": "funding",
"tier": "subtier",
"name": "Social Security Administration"
}
],
"legal_entities": [779928],
"recipient_scope": "domestic",
"recipient_locations": [650597],
"recipient_type_names": ["Individual"],
"place_of_performance_scope": "domestic",
"place_of_performance_locations": [60323],
"award_amounts": [
{
"lower_bound": 1500000.00,
"upper_bound": 1600000.00
}
],
"award_ids": [1018950]
},
"fields": ["Award ID", "Recipient Name", "Start Date", "End Date", "Award Amount", "Awarding Agency", "Awarding Sub Agency", "Award Type", "Funding Agency", "Funding Sub Agency"],
"sort": "Recipient Name",
"order": "desc",
"subawards": True
}
The possible fields returned are split by contracts or assistace awards (loans, grants, etc.)
'Award ID': 'piid',
'Recipient Name': 'recipient_name',
'Start Date': 'period_of_performance_start_date',
'End Date': 'period_of_performance_current_end_date',
'Award Amount': 'total_obligation',
'Contract Award Type': 'type_description',
'Awarding Agency': 'awarding_toptier_agency_name',
'Awarding Sub Agency': 'awarding_subtier_agency_name',
'Funding Agency': 'funding_toptier_agency_name',
'Funding Sub Agency': 'funding_subtier_agency_name'
'Award ID': 'fain',
'Recipient Name': 'recipient_name',
'Start Date': 'period_of_performance_start_date',
'End Date': 'period_of_performance_current_end_date',
'Award Amount': 'total_obligation',
'Awarding Agency': 'awarding_toptier_agency_name',
'Awarding Sub Agency': 'awarding_subtier_agency_name',
'Award Type': 'type_description',
'Funding Agency': 'funding_toptier_agency_name',
'Funding Sub Agency': 'funding_subtier_agency_name'
'Award ID': 'fain',
'Recipient Name': 'recipient_name',
'Issued Date': 'action_date',
'Loan Value': 'face_value_loan_guarantee',
'Subsidy Cost': 'original_loan_subsidy_cost',
'Awarding Agency': 'awarding_toptier_agency_name',
'Awarding Sub Agency': 'awarding_subtier_agency_name',
'Funding Agency': 'funding_toptier_agency_name',
'Funding Sub Agency': 'funding_subtier_agency_name'
'Award ID': 'fain',
'Recipient Name': 'recipient_name',
'Start Date': 'period_of_performance_start_date',
'End Date': 'period_of_performance_current_end_date',
'Award Amount': 'total_obligation',
'Awarding Agency': 'awarding_toptier_agency_name',
'Awarding Sub Agency': 'awarding_subtier_agency_name',
'Award Type': 'type_description',
'Funding Agency': 'funding_toptier_agency_name',
'Funding Sub Agency': 'funding_subtier_agency_name'
'Award ID': 'fain',
'Recipient Name': 'recipient_name',
'Start Date': 'period_of_performance_start_date',
'End Date': 'period_of_performance_current_end_date',
'Award Amount': 'total_obligation',
'Awarding Agency': 'awarding_toptier_agency_name',
'Awarding Sub Agency': 'awarding_subtier_agency_name',
'Award Type': 'type_description',
'Funding Agency': 'funding_toptier_agency_name',
'Funding Sub Agency': 'funding_subtier_agency_name'
{
"limit": 10,
"results": [
{
"internal_id": 1018950,
"Award ID": null,
"Recipient Name": "MULTIPLE RECIPIENTS",
"Start Date": null,
"End Date": null,
"Award Amount": 1573663,
"Awarding Agency": "Social Security Administration",
"Awarding Sub Agency": "Social Security Administration",
"Award Type": "10",
"Funding Agency": "Social Security Administration",
"Funding Sub Agency": "Social Security Administration",
"Subawards": [
{
"Sub-Award ID": "PO156759",
"Recipient Name": "HONEYWELL INTERNATIONAL INC",
"Action Date": "2015-03-23",
"Amount": 54630,
"Description": "electrical components"
}
]
}
],
"page_metadata": {
"page": 1,
"count": 1,
"next": null,
"previous": null,
"hasNext": false,
"hasPrevious": false
}
}
Possible HTTP Status Codes:
- 400 : Missing parameters or limit is not a valid, positive integer
- 500 : All other errors
{
"detail": "Sample error message"
}
https://github.com/fedspendingtransparency/usaspending-website/wiki/Award-Search-Visualizations