- hover to see wizard
- hover to see wizard
- hover to see wizard
- hover to see wizard
- hover to see wizard
- hover to see wizard
Welcome to the BusinessUSA Developer Resources Page
In this section of the site, BusinessUSA gives developers access to authoritative information on U.S.
programs, events, services and more via APIs.
The data accessible here is curated with the goal of informing small businesses of the various different
resources available to help them grow and expand. We encourage you to explore our data and integrate
them into your applications and mash-ups to help small business owners gain access to the resources they need.
Additionally, you can learn more about BusinessUSA's APIs, the external data sources we use from other
government agencies, Github, and what else is possible with our resources.
As part of the Open Government Initiative , the BusinessUSA codebase is available on the BusinessUSA GitHub Open Source Repository. This repository will contain a downloadable instance of BusinessUSA with limited features and functionality. The availability of this feature allows the public to download and set up features that mimic the BusinessUSA website functions for their own purposes, thus leveraging the efforts spent on the creation of the website, as well as to suggest contributions to the repository. This BusinessUSA Open Source Repository will be updated as needed to reflect the latest versions of the features and elements which are publically available.
In partnership with various government agencies, BusinessUSA's APIs provide data intended for public use and dissemination. The data that can be downloaded using our APIs can be incredibly useful for developers looking to obtain data about specific topics, organizations, etc. and incorporating that data into other forums for business owners. Developers who work with, or are, small business owners will find this data particularly useful as it originates from authoritative, federal government sources.
The APIs also conform to President Obama's Open Data Policy that advances the management of Government information as an asset. The policy directs agencies to "Collect or create information in a way that supports downstream information processing and dissemination activities," which has four requirements:
The Keyword Searcn API allows you to view all entries in the business.usa.gov database that contain the input keywords(s) you specify. This API is useful when looking to access a variety of content we feature that relates to a specific subject.
http://api-business.usa.gov/{ReturnType}?keyword={KeyWordSearch}&size={SizeNumber}&offset={OffsetNumber}&api_key=YOUR_KEY_HERE
Return Types: CSV, XML, JSON
Size Limit: 100
http://api-business.usa.gov/XML?keyword=healthcare&size=50&offset=1&api_key=YOUR_KEY_HERE
| Field | Required? | Description |
|---|---|---|
| ReturnType | Yes | A parameter that specifies the format you receive your API call results in. |
| Keyword | Yes | Returns content that matches the word entered in this field. |
| Size | Yes | The size parameter allows you to configure the maximum amount of hits to be returned. |
| Offset | Yes | The offset parameter defines the offset from the first result you wish you retrieve. |
| Field | Description |
|---|---|
| content-type | Category for that content |
| title | Name of the given content |
| detail-description | Text describing the program |
| learn-more-url | External link for the program |
The Programs API provides data on the different programs that users can access through BusinessUSA. The programs shown on BusinessUSA serve entrepreneurs, veterans, minorities, and numerous other types of users.
http://api-business.usa.gov/program/[ReturnType]?size={SizeNumber}&offset={OffsetNumber}&api_key=YOUR_KEY_HERE
Return Types: CSV, XML, JSON
Size Limit: 100
http://api-business.usa.gov/program/JSON?size=25&offset=5&ownership=minority&api_key=YOUR_KEY_HERE
| Field | Required? | Description |
|---|---|---|
| ReturnType | Yes | A parameter that specifies the format you receive your API call results in. |
| Keyword | No | Returns content that matches the word entered in this field. |
| Size | Yes | The size parameter allows you to configure the maximum amount of hits to be returned. |
| Offset | Yes | The offset parameter defines the offset from the first result you wish you retrieve. |
| Title | No | A parameter where you can filter results by title. |
| Industry | No | A parameter where you can filter results for programs tagged to a specified industry |
| Ownership | No | A parameter where you can filter results for programs tagged to a specified ownership type. |
| Field | Description |
|---|---|
| title | Name of the given program |
| eligibility | Program eligibility |
| learn_more_url | A link to an external site that contains more information about this program |
| organization | The organization this program is associated with |
| poc_name | The name of the associated Point of Contact |
| poc_organization | The Organization the Point of Contact is associated with |
| poc_email | The E-Mail address of the associated Point of Contact |
| poc_phone_no | Phone number to the associated Point of Contact |
The Events API provides data on the events that users can view on BusinessUSA. These events cover a wide variety of different subjects related to starting and managing a business.
http://api-business.usa.gov/event/[ReturnType]?size={SizeNumber}&offset={OffsetNumber}&api_key=YOUR_KEY_HERE
Return Types: CSV, XML, JSON
Size Limit: 100
http://api-business.usa.gov/event/XML?size=25&offset=5&state=VA&api_key=YOU_KEY_HERE
| Field | Required? | Description |
|---|---|---|
| ReturnType | Yes | A parameter that specifies the format you receive your API call results in. |
| Keyword | No | Returns content that matches the word entered in this field. |
| Size | Yes | The size parameter allows you to configure the maximum amount of hits to be returned. |
| Offset | Yes | The offset parameter defines the offset from the first result you wish you retrieve. |
| Title | No | A parameter where you can filter results by title. |
| State | No | A parameter where you can filter results by state. |
| City | No | A parameter where you can filter results by city. |
| Zip_Code | No | A parameter where you can retrieve events with the specified zip-code. |
| Organization | No | A parameter where you can retrieve events tagged to the specified organization. |
| Start_Date (YYYY-M-D) | No | A parameter where you can retrieve events with the specified start date. |
| End_Date (YYYY-M-D) | No | A parameter where you can retrieve events with the specified end date. |
| Field | Description |
|---|---|
| title | Name of the given event |
| event_start_date | The start date and time for this event |
| event_end_date | The end date and time |
| detail_description | Description for this event |
| link_to_register_url | A link to the site in which one must go to in order to register for this event |
| address_line_1 | Street address for this event |
| address_line_2 | Additional address information |
| city | The city in which this event resides within |
| state | The state this event resides within |
| zip_code | The ZipCode this event resides within |
| organization | Associated organization to this event |
| poc_name | The name of the associated Point of Contact |
| poc_email | The E-Mail address of the associated Point of Contact |
| poc_phone_no | Phone number to the associated Point of Contact |
| learn_more_url | A link to an external website in which one can obtain more information about this event |
The Services API provides data on the services that users can access on BusinessUSA. These services can be utilized by prospective or current owners and can prove integral to running successful business.
http://api-business.usa.gov/services/[ReturnType]?size={SizeNumber}&offset={OffsetNumber}&api_key=YOUR_KEY_HERE
Return Types: CSV, XML, JSON
Size Limit: 100
http://api-business.usa.gov/services/JSON?size=10&offset=0&title=census&api_key=YOUR_KEY_HERE
| Field | Required? | Description |
|---|---|---|
| ReturnType | Yes | A parameter that specifies the format you receive your API call results in. |
| Keyword | No | Returns content that matches the word entered in this field. |
| Size | Yes | The size parameter allows you to configure the maximum amount of hits to be returned. |
| Offset | Yes | The offset parameter defines the offset from the first result you wish you retrieve. |
| Title | No | A parameter where you can filter results by title. |
| Industry | No | A parameter where you can filter results for services tagged to a specified industry. |
| Ownership | No | A parameter where you can filter results for services tagged to a specified ownership type. |
| Field | Description |
|---|---|
| title | Name of the given service |
| detail_description | Description for this service |
| eligibility | Services Eligibility |
| organization | Organization associated with the respective service |
| poc_name | The name of the associated Point of Contact |
| poc_organization | Organization of the Point of Contact |
| poc_phone_no | Phone number of the associated Point of Contact |
| poc_email | The Email Address of the associated Point of Contact |
| learn_more_url | A link to an external website in which one can obtain more information about this service. |
The Success Stories API provides a listing of all the success stories featured on BusinessUSA. The Success Stories detail personal stories of business owners and their achievements using the many resources BusinessUSA users can connect to.
http://api-business.usa.gov/success_story/[ReturnType]?size={SizeNumber}&offset={OffsetNumber}&api_key=YOUR_KEY_HERE
Return Types: CSV, XML, JSON
Size Limit: 100
http://api-business.usa.gov/success_story/json?size=50&offset=25&keyword=trade&api_key=YOUR_KEY_HERE
| Field | Required? | Description |
|---|---|---|
| ReturnType | Yes | A parameter that specifies the format you receive your API call results in. |
| Keyword | No | Returns content that matches the word entered in this field. |
| Size | Yes | The size parameter allows you to configure the maximum amount of hits to be returned. |
| Offset | Yes | The offset parameter defines the offset from the first result you wish you retrieve. |
| Title | No | A parameter where you can filter results by title. |
| Field | Description |
|---|---|
| title | Name of the given success story |
| detailed_text | The contents of this success story |
| publish_date | The date in which this success story was published |
| topic | The associated topic to this success story |
| learn_more_url | A link to an external site in which a user can learn more about this success story |
The Articles API provides data for all the articles available for users on BusinessUSA. The articles featured cover a wide variety of topics and news in the business world.
http://api-business.usa.gov/article/[ReturnType]?size={SizeNumber}&offset={OffsetNumber}&api_key=YOUR_KEY_HERE
Return Types: CSV, XML, JSON
Size Limit: 100
http://api-business.usa.gov/article/csv?size=50&offset=25&keyword=export&api_key=YOUR_KEY_HERE
| Field | Required? | Description |
|---|---|---|
| ReturnType | Yes | A parameter that specifies the format you receive your API call results in. |
| Keyword | No | Returns content that matches the word entered in this field. |
| Size | Yes | The size parameter allows you to configure the maximum amount of hits to be returned. |
| Offset | Yes | The offset parameter defines the offset from the first result you wish you retrieve. |
| Title | No | A parameter where you can filter results by title. |
| Publish_Date (YYYY-M-D) | No | A parameter where you can retrieve articles with the specified published date. |
| Field | Description |
|---|---|
| title | Name of the given articles |
| learn_more_url | A link to an external website in which one can obtain more information about this article. |
| publish_date | Date that the respective article was published. |
| detailed_text | Text within the respective article |
| topic | Subject matter of the respective article. |
The Data API provides information on all the different data assets users can access on BusinessUSA. The data featured on BusinessUSA can be a critical resource for business owners to become well versed in their respective industry.
http://api-business.usa.gov/data/[ReturnType]?size={SizeNumber}&offset={OffsetNumber}&api_key=YOUR_KEY_HERE
Return Types: CSV, XML, JSON
Size Limit: 100
http://api-business.usa.gov/data/XML?size=50&offset=1&organization=DOC_Program&api_key=YOUR_KEY_HERE
| Field | Required? | Description |
|---|---|---|
| ReturnType | Yes | A parameter that specifies the format you receive your API call results in. |
| Keyword | No | Returns content that matches the word entered in this field. |
| Size | Yes | The size parameter allows you to configure the maximum amount of hits to be returned. |
| Offset | Yes | The offset parameter defines the offset from the first result you wish you retrieve. |
| Title | No | A parameter where you can filter results by title. |
| Industry | No | A parameter where you can filter results for programs tagged to a specified industry |
| Ownership | No | A parameter where you can filter results for programs tagged to a specified ownership type. |
| Field | Description |
|---|---|
| title | Name of the given data item |
| detail_description | Information on the respective data |
| eligibility | Data Eligibility |
| organization | Organization owner of the data |
| poc_email | The Email Address of the associated Point of Contact |
| poc_name | The name of the associated Point of Contact |
| poc_organization | Organization of the Point of Contact |
| poc_phone_no | Telephone number of the Point of Contact |
| learn_more_url | A link to an external website in which one can obtain more information about this article. |
The Tools API provides information on all the tools featured on BusinessUSA. The Tools that are accessible through BusinessUSA can assist business owners in their understanding of demographics, markets, and more.
http://api-business.usa.gov/tools/[ReturnType]?size={SizeNumber}&offset={OffsetNumber}&api_key=YOUR_KEY_HERE
Return Types: CSV, XML, JSON
Size Limit: 100
http://api-business.usa.gov/tools/XML?size=50&offset=5&organization=USDA_Program&api_key=YOUR_KEY_HERE
| Field | Required? | Description |
|---|---|---|
| ReturnType | Yes | A parameter that specifies the format you receive your API call results in. |
| Keyword | No | Returns content that matches the word entered in this field. |
| Size | Yes | The size parameter allows you to configure the maximum amount of hits to be returned. |
| Offset | Yes | The offset parameter defines the offset from the first result you wish you retrieve. |
| Title | No | A parameter where you can filter results by title. |
| Organization | No | A parameter where you can retrieve events tagged to the specified organization. |
| Field | Description |
|---|---|
| title | Name of the given tool |
| organization | Organization who owns the respective tool. |
| learn_more_url | A link to an external website in which one can obtain more information about the respective tool. |
| detailed_text | Text describing the respective tool. |
BusinessUSA pulls its content from external data sources that a wide range of government agencies
maintain, in order to provide the most current and relevant information for our users. Navigating the
business landscape in the information age can prove difficult when considering how much content is
out there, as well as where to find it. BusinessUSA provides a centralized location for this content,
and gives users the ability to seek out resources that fit their business needs.
In accordance with that purpose, where we obtain our content from is as important as the content itself.
The government agencies we cultivate our content from are trusted experts in their related fields and
the resources they provide are essential to the different aspects of owning a business. BusinessUSA
pulls content from the following agencies
BusinessUSA undertook an audit of its digital services program against the Digital Services Playbook as developed by the US Digital Service (USDS). The document and presentation attached are the findings from that audit. In the spirit of government transparency, BusinessUSA has published these findings publicly that were last updated in December 2014.
BusinessUSA APIs generally have a large number of fields that can be sorted and filtered in any number of ways, allowing for maximum customizability and allowing API users to drill down to the results they need. Considering the amount of data that is available on BusinessUSA, being able to access the data we have in this manner can help users unearth data pertaining to a certain type of event, find programs/services for a certain eligibility, or gather all data that relates to a specific topic you have in mind.
For a more in-depth developer resource, please visit our Github repository. There you will find the architectural code for BusinessUSA as part of our open source initiative. We encourage users to view our code and be active in giving us feedback, to help us improve in order to better serve you.
Business.USA.gov is an official website of the U.S. Government.