API Documentation
We are pleased to announce the availability of fedspending.org data in an Application Programming Interface (API). This API is intended for non-commercial use only; you should not use it if you charge anyone to access your site. In addition, parent company identification information for contractors is data provided by Eagle Eye Publishing, and should not be bulk copied and resold.
The API consists of three methods, fpds.php, faads.php, and rcv.php, which allow access to the data to the Federal contracts, Federal assistance, and Federal recovery databases respectively. All data present on fedspending.org is available through the API, except for pie charts and end-of-search totals.
HOW TO USE THE API
The API is reached via an http request and URL variables. To call the API, prefix the methods below with "http://www.fedspending.org/fpds/" for contracts, "http://www.fedspending.org/faads/" for assistance, or "http://www.fedspending.org/rcv/" for recovery. i.e.
- Summary for contracts for the state of Alabama:
http://www.fedspending.org/fpds/fpds.php?datype=X&detail=-1&state=AL - List of assistance transactions to entities with "Smith" in their name for FY 2006:
http://www.fedspending.org/faads/faads.php?datype=X&detail=2&recipient_name=Smith&fiscal_year=2006
IMPORTANT: API calls will retrieve a maximum of 1000 records per call, in order to save bandwidth. Please don't attempt to retrieve large subsections of the database through repeated calls to the API.
API REFERENCE
- Contracts (fpds.php) Method API Reference
- Assistance (faads.php) Method API Reference
- Recovery (rcv.php) Method API Reference
For meanings of specific data fields, consult the data dictionary
html_trailer(); ?>