Browse Schools
Returns a list of schools in a city. All calls for a Browse Schools are in this format:http://api.greatschools.org/schools/[components]?[parameters]
Components
Components of the url describe what type of data you would like. They are separated by forward slashes.| Name | Description | Sample Values |
| state* | Two letter state abbreviation | ak CA |
| city* | Name of city, with spaces replaced with hyphens. If the city name has hyphens, replace those with underscores. | San Francisco becomes "San-Francisco"
Cardiff-By-The-Sea becomes "Cardiff_By_The_Sea" |
| school type | Type of school you wish to appear in the list | Valid values: "public", "charter", "private", or any combination separated by hyphens, like "public-charter" |
| level | Level of school you wish to appear in the list | Valid values: "elementary-schools", "middle-schools", "high-schools" |
*required
Parameters
The "key" parameter is what you use to send us your API key. Other parameters are optional and used to describe how you would like to receive the data.| Name | Description | Sample Values |
| key* | Your API key | myAPIkey |
| sort | How to sort the results, either by name (ascending), by GS rating (descending), or by overall parent rating (descending). The default sort is name (ascending). When sorted by rating, schools without a rating will appear last. | Valid values: "name", "gs_rating", "parent_rating" |
| limit | Maximum number of schools to return. This defaults to 200.
To get all results, use -1. | 10 |
*required
Examples of usage:
http://api.greatschools.org/schools/CA/Alameda?key=[yourAPIkey]
Returns up to 200 schools in the city of Alameda, CA
http://api.greatschools.org/schools/CA/Alameda?key=[yourAPIkey]&limit=-1
Returns all schools in the city of Alameda, CA
http://api.greatschools.org/schools/CA/San-Francisco/private/middle-schools?key=[yourAPIkey]&sort=parent_rating&limit=5
Returns 5 private middle schools in San Francisco, CA, sorting by parent rating
Sample Request
http://api.greatschools.org/schools/CA/Truckee?key=[yourAPIkey]&limit=2
Returns 2 schools in Truckee, CA
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.