The Recovery API allows you to request Recovery data through REST API calls and to create customized datasets that are returned in XML format.
The API Definition document provides details on various query parameters and definitions for logical operators. A sample call and sample output are included below.
You can also create a REST API call using the Advanced Recipient Data Search Widget to automatically generate a custom feed URL through an easy-to-use interface.
Recovery REST API Documentation (PDF 140 KB)
Sample Call
In this example, the results are related to State of MD or VA Grants with an award value between $0 and $500 million, a specific Award Number, a specific DUNS number, and a specified date range.
- award_type=G indicating award reports for Grants only
- award_amount=[bt]0,500000000 indicating all awards between $0 and $500 million
- award_date = [bt]1/1/2009,5/1/2009 search criteria with an award date range
- award_number=0901VACCD7
- recipient_duns_number=015571326
- calendar_year=2009
- calendar_qtr=4
- carry_forward_flag=1
- pop_state_cd=MD,VA
- start=1&numberOfEntries=15
Sample Call URL:
http://data.recovery.gov/presto/edge/api/rest/RecoveryGovAdvancedSearch/Invoke?award_type=G&recipient_name=&pop_postal_cd=&funding_agency_name=&award_amount=[bt]0,500000000&project_status=&award_date=[bt]1/1/2009,5/1/2009&award_number=0901VACCD7&recipient_duns_number=015571326& calendar_year=2009&calendar_qtr=4&carry_forward_flag=1&pop_state_cd=MD,VA& start=1&number_of_entries=15
Sample Output
<records>
<record>
<recipient_name>CTA INC.</recipient_name>
<order_number />
<award_number>80181RY373</award_number>
<award_type>C</award_type>
<pop_postal_cd>972324181</pop_postal_cd>
<funding_agency_name>U.S. Fish and Wildlife Service</funding_agency_name>
<award_amount>199832.02</award_amount>
<project_status>More than 50% Completed</project_status>
<award_date>2009-09-01 00:00:00.0</award_date>
<recipient_duns_number>148068018</recipient_duns_number>
<fiscal_year>2009</ fiscal_year>
< fiscal_qtr>4</ fiscal_qtr>
<carry_forward_flag>1</carry_forward_flag>
<pop_state_cd>OR</pop_state_cd>
<award_amount_net>199832.02</award_amount_net>
<recipient_role>P</recipient_role>
</record>
<start_record>1</start_record>
<total_records_returned>101</total_records_returned>
<total_records_current_search>22593</total_records_current_search>
</records>