School Search API

Document created by deltaechobravo Employee on Jan 23, 2018
Version 1Show Document
  • View in full screen mode

The School Search API was originally an experimental effort. This document is just to provide a quick reference in the absence of more thorough documentation.

 

The School Search end point is https://data.guidestar.org/v1/schoolsearch .

 

Using Lucene Query Syntax, criteria are provided using the q parameter. Each of the returned fields are searchable. Below is a sample call using the school name:

 

https://data.guidestar.org/v1/schoolsearch.json?q=school_name:Bruton 

 

More complex queries can be constructed to meet most needs

https://data.guidestar.org/v1/schoolsearch.json?q=school_name:Bruton%20AND%20city:williamsburg 

 

Authentication is handled via API key (passed in as the User using Basic Authentication) as with the other Gen I REST APIs.

 

I hope this is helpful.

Attachments

    Outcomes