Your one-stop-shop for getting started with the NearbySchools API, enabling your website to dynamically display US K-12 school information and quality metrics from the most trusted source for parents.
\nWith the NearbySchools API, you can:
\nClick \"Run in Postman\" in the top right to import this collection into your Postman instance and try out the API with your API key. After importing, navigate to the \"Authorization\" tab and you can paste your API key, which will be used across the collection.
\nBy default, responses will be in the JSON format. If you'd like an XML response, set the Accept request header to application/xml.
For the /nearby-schools and /schools endpoints, you may provide the following query parameters to receive paginated results:
limit: maximum number of results that should be returned. Maximum value is 50.page: zero-indexed page value.Responses will contain the following properties with pagination metadata:
\ncur_page: the current zero-indexed page value.items_per_page: the current limit value that determines how many items (schools) are returned per page.max_page_num: the last page value for which items (schools) will be returned.total_count: the total number of items (schools) available for the query.links: object containing relevant endpoints and query parameters for paginated results.self: current page.prev: previous page (empty string when not applicable).next: next page (empty string when not applicable).first: first page, where page query parameter is 0.last: last page, where page query parameter is max_page_num.You may receive a 429 Too Many Requests error response if:
Check out our FAQs or contact us (api-support@greatschools.org) for any support you need to get started or resolve an issue.
\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27756678","collectionId":"68119f56-2b68-4fa2-84a5-c8c0107c8b74","publishedId":"2sA3s7hoDd","public":true,"customColor":{"top-bar":"FAFAFA","right-sidebar":"303030","highlight":"1A9DD1"},"publishDate":"2024-08-15T06:41:46.000Z"},"item":[{"name":"Schools","item":[{"name":"List nearby schools","event":[{"listen":"test","script":{"id":"0f5bccee-65e9-40fc-8b84-c429ce2e052d","exec":[""],"type":"text/javascript","packages":{}}}],"id":"6fe29f92-ca15-4110-91de-78831b6ec77a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"","description":"application/json or application/xml
\n"},{"key":"Content","value":"","description":"application/json or application/xml
\n"}],"url":"https://gs-api.greatschools.org/v2/nearby-schools","description":"Returns a list of K-12 schools nearest to the given coordinates. Includes directory & GreatSchools School Rating Band data.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"latitude (required)
\n","type":"text/plain"},"key":"lat","value":"longitude (required)
\n","type":"text/plain"},"key":"lon","value":"Type of school you wish to appear in the list. Valid values: public, charter, private.\nThe default is all.\nYou can combine queries using the following format\n(the parenthesis need to be included):\n(public or charter)
\n","type":"text/plain"},"key":"school_type","value":"Level of school you wish to appear in the list.\ne - elementary\nm - middle\nh - high
\n","type":"text/plain"},"key":"level_codes","value":"Miles radius to confine search to. Default 5. Max 50.
\n","type":"text/plain"},"key":"distance","value":"Maximum number of schools to return. Default 50. Max 50.
\n","type":"text/plain"},"key":"limit","value":"Zero indexed. Use in combination with limit. Default 0.
\n","type":"text/plain"},"key":"page","value":"application/json or application/xml
\n"},{"key":"Content","value":"","description":"application/json or application/xml
\n"}],"url":"https://gs-api.greatschools.org/v2/schools","description":"Returns a list of schools given the query parameters. Must provide either a zipcode OR city + state values.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"Zipcode (required if not providing city + state)
\n","type":"text/plain"},"key":"zip","value":"State name (required if providing city value)
\n","type":"text/plain"},"key":"state","value":"City name (required if providing state value)
\n","type":"text/plain"},"key":"city","value":"Type of school you wish to appear in the list. Valid values: public, charter, private.\nThe default is all.\nYou can combine queries using the following format\n(the parenthesis need to be included): (public or charter)
\n","type":"text/plain"},"key":"school_type","value":"Level of school you wish to appear in the list.\ne - elementary\nm - middle\nh - high
\n","type":"text/plain"},"key":"level_codes","value":"Maximum number of schools to return. Default 50. Max 50.
\n","type":"text/plain"},"key":"limit","value":"Zero indexed. Use in combination with limit. Default 0.
\n","type":"text/plain"},"key":"page","value":"application/json or application/xml
\n"},{"key":"Content","value":"","description":"application/json or application/xml
\n"}],"url":"https://gs-api.greatschools.org/v2/schools/:universal_id","description":"Returns a single school, identified by the :universal_id path variable.
The universal ID is a 7-digit unique identifier created by GreatSchools.
\n","type":"text/plain"},"type":"any","value":null,"key":"universal_id"}]}},"response":[{"id":"4adce5cd-f86e-471e-ae8f-ecd9fbd4c23b","name":"Get school directory info","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content","value":"application/json"},{"key":"X-API-Key","value":"YOUR_API_KEY"}],"url":{"raw":"https://gs-api.greatschools.org/v2/schools/0600001","protocol":"https","host":["gs-api","greatschools","org"],"path":["v2","schools","0600001"],"query":[{"key":"state","value":"Returns the usage details for a particular API key/account.
\n","urlObject":{"protocol":"https","path":["v2","usage"],"host":["gs-api","greatschools","org"],"query":[{"disabled":true,"description":{"content":"This is the API key you were issued when you signed up. It must be attached to a valid subscription.
\n","type":"text/plain"},"key":"api_key","value":"YOUR_API_KEY"}],"variable":[]}},"response":[{"id":"55149f7e-7736-4cfa-8880-a08941d2e45a","name":"Get current usage details","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gs-api.greatschools.org/v2/usage?api_key=YOUR_API_KEY","protocol":"https","host":["gs-api","greatschools","org"],"path":["v2","usage"],"query":[{"key":"api_key","value":"YOUR_API_KEY","description":"This is the API key you were issued when you signed up. It must be attached to a valid subscription."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 9 Jun 2023 09:00:00 EDT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"80"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a7016082-30bc-4f76-a0a2-42570e2e1456"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"GZaNRF9tIAMFyMw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6486d721-3e4824e21f1c15a3625670ca"}],"cookie":[],"responseTime":null,"body":"{\n \"current_usage\": {\n \"calls_made\": 9,\n \"remaining_calls\": 14991\n },\n \"metering_period\": {\n \"start_date\": \"2024-08-01\",\n \"end_date\": \"2024-08-31\"\n }\n}"}],"_postman_id":"66145af9-a87e-44b9-ad3b-22a5eef475e8"}],"id":"818dbc14-c173-4c44-b0f9-6cadfef3055b","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f31e17dd-3bc5-427c-b311-363230437b13","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eac38592-8d10-49c0-a0e3-aba14d7e5dd4","type":"text/javascript","exec":[""]}}],"_postman_id":"818dbc14-c173-4c44-b0f9-6cadfef3055b","description":""}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"