The API Sandbox provides complete API functionality with a limited data set. API developers can use this site to prototype software for demonstrations or in anticipation of becoming a paid subscriber to the full-data version of Guidestar's APIs. Developers should note that this data is not guaranteed to be current and is refreshed only on occasion.
The interfaces and functionality, however, are identical to the production versions.
GuideStar Sandbox APIs are free to use. However, a license and authentication keys are required.
Use this link to signup for GuideStar Sandbox API licenses.
Description of API keys and how to use them for authentication
GuideStar Charity Check API
GuideStar Charity Check is the only pre-grant due-diligence tool that is 100% compliant with IRS requirements. The GuideStar Charity Check API provides this essential data via our RESTful API in XML or JSON formats.
The default return format for Guidestar APIs is JSON.
Request Charity Check information for EIN 54-1774039 (GuideStar) with results in XML. (GuideStar Charity Check API Sandbox - XML Sample Results)
Request Charity Check information for 54-1774039 (GuideStar) with results in JSON format. (GuideStar Charity Check API Sandbox - JSON Sample Results)
GuideStar Exchange API
The default return format for Guidestar APIs is JSON. Append ".xml" to the request to receive the results in XML.
Use the Search API with an EIN to find the organization ID.
Request GuideStar Exchange data for organization ID 7831216 and give me the result in well-formedXML.
Request GuideStar Exchange data for organization ID 7831216 and give me the result in JSON format.
GuideStar Search API
Search data about nonprofits and quickly find organizations most relevant to your needs. You can use those results to get more data from our other APIs.
|q||The q parameter is the main query for the request.|
|p||The p parameter is used to paginate results from a query where each page has “r” NPOs (see r parameter). The p parameter specifies which “page” of “r” NPOs should returned. The default value is 1 and returns NPOs 1..r. A query with p=2&r=5 returns NPOs 6-10 from the overall return set for the query. This allows users to obtain as many return results for a particular query as desired results.|
|r||The r parameter specifies the number of NPOs returned on each page for values of 1 through 25. The default is 10 NPOs per page.|
|https://Sandboxdata.guidestar.org/v1_1/search?q=ein:54-1774039||Searc for an organization with an EIN = 54-1774039|
Search for all organizations with an IRS Foundation Code = 15
|https://Sandboxdata.guidestar.org/v1_1/search?q=irs_foundation_code:15&p=2||Search for IRS Foundation Code = 15 and return "page" 2 of the result|
|https://Sandboxdata.guidestar.org/v1_1/search?q=irs_foundation_code:15&r=5||Search for IRS Foundation Code = 15 and return 5 results|
|https://Sandboxdata.guidestar.org/v1_1/search?q=irs_foundation_code:15&p=2&r=5||Search for IRS Foundation Code = 15 and return 5 results of "page" 2|
Search for IRS Foundation Code = 15 and return JSON format
Search API Code Lists
- GuideStar Search API Sandbox MSA Code List (Metropolitan Statistical Area)
- GuideStar Search API Sandbox Subsection Code List (IRS Subsection Codes)
GuideStar Detail API
Request data for organization Id 7831216 and get the result in well-formed XML. (GuideStar Detail API Sandbox - XML Sample Results)
Request data for organization Id 7831216 and give me the result in JSON format. (GuideStar Detail API Sandbox - JSON Sample Results)
|200||OK, all went through!|
|401||Unauthorized, returned when the request requires user authentication. The response header will include WWW-Authenticate header realm "GuideStar Middleware API"|
|403||Forbidden, returned when the API understood the request, but is refusing to fulfill it. Most commonly, this means that the user has exceeded their request limit or does not have permissions to access this API.|
|404||There is an error in the URL string or the requested organization Id is not available.|
|500||Server Error, returned when the API encountered an unexpected condition which prevented it from fulfilling the request. A generic message (security reasons) will be displayed to the consumer but a detailed exception will be logged on API side.|
|503||Service Unavailable, returned when the API is unavailable to handle the request due to a temporary overloading or maintenance of the server. The existence of the 503 status code does not imply that we will be using it on a regular basis. It is here to cover rare cases only so that we can message and inform consumers if needed.|