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://gist.github.com/nmonga91/ba0e172b6d3f2aaf50f0ef1bb5d708bc#recipient-location
{
"fields": ['Award ID', 'Recipient Name']
"filters": {
"award_type_codes": ["A", "B", "C", "D", "IDV"],
"award_ids": [1, 2, 3],
"award_amounts": [
{
"lower_bound": 1000000.00,
"upper_bound": 25000000.00
},
{
"upper_bound": 1000000.00
},
{
"lower_bound": 500000000.00
}
]
},
"limit": 10,
"page": 1
}
The possible fields returned are split by contracts or assistace awards (loans, grants, etc.)
'Award ID': 'piid',
'Recipient Name': 'recipient__recipient_name',
'Start Date': 'period_of_performance_start_date',
'End Date': 'period_of_performance_current_end_date',
'Award Amount': 'total_obligation',
'Funding Agency': 'funding_agency__toptier_agency__name',
'Funding Sub Agency': 'funding_agency__subtier_agency__name',
'Contract Award Type': 'type_description',
'Contract Description': 'description',
'Signed Date': 'date_signed',
'Potential Award Amount': 'potential_total_value_of_award',
'Awarding Agency': 'awarding_agency__toptier_agency__name',
'Awarding Sub Agency': 'awarding_agency__subtier_agency__name',
'Awarding Office': 'awarding_agency__office_agency__name',
'Funding Office': 'funding_agency__office_agency__name',
'Recipient Address Line 1': 'recipient__location__address_line1',
'Recipient Address Line 2': 'recipient__location__address_line2',
'Recipient Address Line 3': 'recipient__location__address_line3',
'Recipient Country': 'recipient__location__country_name',
'Recipient State': 'recipient__location__state_code',
'Recipient Province': 'recipient__location__foreign_province',
'Recipient County': 'recipient__location__county_name',
'Recipient City': 'recipient__location__city_name',
'Recipient Zip Code': 'recipient__location__zip5',
'Place of Performance City': 'place_of_performance__city_name',
'Place of Performance Zip Code': 'place_of_performance__zip5',
'Place of Performance Country': 'place_of_performance__country_name',
'Place of Performance State': 'place_of_performance__state_name',
'Place of Performance Province': 'place_of_performance__foreign_province',
'Recipient DUNS Number': 'recipient__recipient_unique_id',
'Recipient Ultimate DUNS Number': 'recipient__parent_recipient_unique_id',
'Contract Pricing Type': 'latest_transaction__contract_data__type_of_contract_pricing',
'Recipient Congressional District': 'recipient__location__congressional_code',
'Recipient Phone Number': 'recipient__vendor_phone_number',
'Recipient Fax Number': 'recipient__vendor_fax_number',
'Place of Performance Congressional District': 'place_of_performance__congressional_code',
'Place of Performance County': 'place_of_performance__county_name',
'Parent Award ID': 'latest_transaction__contract_data__parent_award_id',
'IDV Type': 'latest_transaction__contract_data__idv_type',
'IDC Type': 'latest_transaction__contract_data__type_of_idc',
'IDV Agency Identifier': 'latest_transaction__contract_data__referenced_idv_agency_identifier',
'Multiple or Single Award IDV': 'latest_transaction__contract_data__multiple_or_single_award_idv',
'Solicitation ID': 'latest_transaction__contract_data__solicitation_identifier',
'Solicitation Procedures': 'latest_transaction__contract_data__solicitation_procedures',
'Number of Offers Received': 'latest_transaction__contract_data__number_of_offers_received',
'Extent Competed': 'latest_transaction__contract_data__extent_competed_description',
'Set-Aside Type': 'latest_transaction__contract_data__type_set_aside_description',
'Commercial Item Acquisition Procedures': 'latest_transaction__contract_data__commercial_item_acquisition_procedures_description',
'Commercial Item Test Program': 'latest_transaction__contract_data__commercial_item_test_program',
'Evaluated Preference': 'latest_transaction__contract_data__evaluated_preference_description',
'FedBizOpps': 'latest_transaction__contract_data__fed_biz_opps_description',
'Small Business Competitiveness Demonstration Program': 'latest_transaction__contract_data__small_business_competitiveness_demonstration_program',
'PSC Code': 'latest_transaction__contract_data__product_or_service_code',
'NAICS Code': 'latest_transaction__contract_data__naics',
'NAICS Description': 'latest_transaction__contract_data__naics_description',
'DoD Claimant Program Code': 'latest_transaction__contract_data__dod_claimant_program_code',
'Program, System, or Equipment Code': 'latest_transaction__contract_data__program_system_or_equipment_code',
'Information Technology Commercial Item Category': 'latest_transaction__contract_data__information_technology_commercial_item_category_description',
'Sea Transportation': 'latest_transaction__contract_data__sea_transportation_description',
'Clinger-Cohen Act Compliant': 'latest_transaction__contract_data__clinger_cohen_act_planning',
'Subject To Davis Bacon Act': 'latest_transaction__contract_data__davis_bacon_act_description',
'Subject To Service Contract Act': 'latest_transaction__contract_data__service_contract_act_description',
'Subject To Walsh Healey Act': 'latest_transaction__contract_data__walsh_healey_act',
'Consolidated Contract': 'latest_transaction__contract_data__consolidated_contract',
'Cost or Pricing Data': 'latest_transaction__contract_data__cost_or_pricing_data_description',
'Fair Opportunity Limited Sources': 'latest_transaction__contract_data__fair_opportunity_limited_sources_description',
'Foreign Funding': 'latest_transaction__contract_data__foreign_funding_description',
'Interagency Contracting Authority': 'latest_transaction__contract_data__interagency_contracting_authority_description',
'Major program': 'latest_transaction__contract_data__major_program',
'Multi Year Contract': 'latest_transaction__contract_data__multi_year_contract',
'Price Evaluation Adjustment Preference Percent Difference': 'latest_transaction__contract_data__price_evaluation_adjustment_preference_percent_difference',
'Program Acronym': 'latest_transaction__contract_data__program_acronym',
'Purchase Card as Payment Method': 'latest_transaction__contract_data__purchase_card_as_payment_method',
'Subcontracting Plan': 'latest_transaction__contract_data__subcontracting_plan_description'
'Award ID': 'fain',
'Recipient Name': 'recipient__recipient_name',
'Start Date': 'period_of_performance_start_date',
'End Date': 'period_of_performance_current_end_date',
'Award Amount': 'total_obligation',
'Funding Agency': 'funding_agency__toptier_agency__name',
'Funding Sub Agency': 'funding_agency__subtier_agency__name',
'Contract Award Type': 'type_description',
'Contract Description': 'description',
'Signed Date': 'date_signed',
'Potential Award Amount': 'potential_total_value_of_award',
'Awarding Agency': 'awarding_agency__toptier_agency__name',
'Awarding Sub Agency': 'awarding_agency__subtier_agency__name',
'Awarding Office': 'awarding_agency__office_agency__name',
'Funding Office': 'funding_agency__office_agency__name',
'Recipient Address Line 1': 'recipient__location__address_line1',
'Recipient Address Line 2': 'recipient__location__address_line2',
'Recipient Address Line 3': 'recipient__location__address_line3',
'Recipient Country': 'recipient__location__country_name',
'Recipient State': 'recipient__location__state_code',
'Recipient Province': 'recipient__location__foreign_province',
'Recipient County': 'recipient__location__county_name',
'Recipient City': 'recipient__location__city_name',
'Recipient Zip Code': 'recipient__location__zip5',
'Place of Performance City': 'place_of_performance__city_name',
'Place of Performance Zip Code': 'place_of_performance__zip5',
'Place of Performance Country': 'place_of_performance__country_name',
'Place of Performance State': 'place_of_performance__state_name',
'Place of Performance Province': 'place_of_performance__foreign_province',
'Recipient DUNS Number': 'recipient__recipient_unique_id',
'Recipient Ultimate DUNS Number': 'recipient__parent_recipient_unique_id',
'Contract Pricing Type': 'latest_transaction__contract_data__type_of_contract_pricing',
'Recipient Congressional District': 'recipient__location__congressional_code',
'Recipient Phone Number': 'recipient__vendor_phone_number',
'Recipient Fax Number': 'recipient__vendor_fax_number',
'Place of Performance Congressional District': 'place_of_performance__congressional_code',
'Place of Performance County': 'place_of_performance__county_name',
'Parent Award ID': 'latest_transaction__contract_data__parent_award_id',
'IDV Type': 'latest_transaction__contract_data__idv_type',
'IDC Type': 'latest_transaction__contract_data__type_of_idc',
'IDV Agency Identifier': 'latest_transaction__contract_data__referenced_idv_agency_identifier',
'Multiple or Single Award IDV': 'latest_transaction__contract_data__multiple_or_single_award_idv',
'Solicitation ID': 'latest_transaction__contract_data__solicitation_identifier',
'Solicitation Procedures': 'latest_transaction__contract_data__solicitation_procedures',
'Number of Offers Received': 'latest_transaction__contract_data__number_of_offers_received',
'Extent Competed': 'latest_transaction__contract_data__extent_competed_description',
'Set-Aside Type': 'latest_transaction__contract_data__type_set_aside_description',
'Commercial Item Acquisition Procedures': 'latest_transaction__contract_data__commercial_item_acquisition_procedures_description',
'Commercial Item Test Program': 'latest_transaction__contract_data__commercial_item_test_program',
'Evaluated Preference': 'latest_transaction__contract_data__evaluated_preference_description',
'FedBizOpps': 'latest_transaction__contract_data__fed_biz_opps_description',
'Small Business Competitiveness Demonstration Program': 'latest_transaction__contract_data__small_business_competitiveness_demonstration_program',
'PSC Code': 'latest_transaction__contract_data__product_or_service_code',
'NAICS Code': 'latest_transaction__contract_data__naics',
'NAICS Description': 'latest_transaction__contract_data__naics_description',
'DoD Claimant Program Code': 'latest_transaction__contract_data__dod_claimant_program_code',
'Program, System, or Equipment Code': 'latest_transaction__contract_data__program_system_or_equipment_code',
'Information Technology Commercial Item Category': 'latest_transaction__contract_data__information_technology_commercial_item_category_description',
'Sea Transportation': 'latest_transaction__contract_data__sea_transportation_description',
'Clinger-Cohen Act Compliant': 'latest_transaction__contract_data__clinger_cohen_act_planning',
'Subject To Davis Bacon Act': 'latest_transaction__contract_data__davis_bacon_act_description',
'Subject To Service Contract Act': 'latest_transaction__contract_data__service_contract_act_description',
'Subject To Walsh Healey Act': 'latest_transaction__contract_data__walsh_healey_act',
'Consolidated Contract': 'latest_transaction__contract_data__consolidated_contract',
'Cost or Pricing Data': 'latest_transaction__contract_data__cost_or_pricing_data_description',
'Fair Opportunity Limited Sources': 'latest_transaction__contract_data__fair_opportunity_limited_sources_description',
'Foreign Funding': 'latest_transaction__contract_data__foreign_funding_description',
'Interagency Contracting Authority': 'latest_transaction__contract_data__interagency_contracting_authority_description',
'Major program': 'latest_transaction__contract_data__major_program',
'Multi Year Contract': 'latest_transaction__contract_data__multi_year_contract',
'Price Evaluation Adjustment Preference Percent Difference': 'latest_transaction__contract_data__price_evaluation_adjustment_preference_percent_difference',
'Program Acronym': 'latest_transaction__contract_data__program_acronym',
'Purchase Card as Payment Method': 'latest_transaction__contract_data__purchase_card_as_payment_method',
'Subcontracting Plan': 'latest_transaction__contract_data__subcontracting_plan_description',
'Award Type': 'type'
{
"results": [
{'Award_ID': "test", 'Recipient Name': "Recipient_test"}
],
"page": 1,
"limit": 10
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