School Search
Returns a list of schools based on a search string. All calls for School Search are in this format:http://api.greatschools.org/search/schools/?[parameters]
Parameters
The "key" parameter is what you use to send us your API key.| Name | Description | Sample Values |
| key* | Your API key | myAPIkey |
| state* | State to search in | CA |
| q* | Search query string. The query string must be properly URL-encoded. | Alameda High School |
| levelCode | Level of school you wish to appear in the list | Valid values: "elementary-schools", "middle-schools", "high-schools" |
| sort | This call by default sorts the results by relevance. If you'd prefer the results in alphabetical order, then use this parameter with a value of "alpha". | Valid values: "alpha" |
| limit | Maximum number of schools to return. This defaults to 200 and must be at least 1. | 10 |
*required
Examples of usage:
http://api.greatschools.org/search/schools?key=[yourAPIKey]&state=CA&q=Alameda
Searches for schools using the query string "Alameda" in California
http://api.greatschools.org/search/schools?key=[yourAPIKey]&state=CA&q=Alameda&sort=alpha&levelCode=elementary-schools&limit=10
Searches for no more than 10 elementary schools using the query string "Alameda" in California,
returned in alphabetical order
Sample Request
http://api.greatschools.org/search/schools?key=[yourAPIKey]&state=CA&q=Alameda+Christian&limit=2
Returns 2 search results for "Alameda Christian" in California
Sample Response
Have Questions?
To ask questions or to report bugs please email
api-support@greatschools.org. Please do not abuse our API. Review the
Terms of Use.