{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"68119f56-2b68-4fa2-84a5-c8c0107c8b74","name":"NearbySchools API v2 by GreatSchools","description":"**Your one-stop-shop for getting started with the** [NearbySchools API](https://www.greatschools.org/solutions/k12-data-solutions/nearbyschools-api), enabling your website to dynamically display US K-12 school information and quality metrics from the most trusted source for parents.\n\nWith the NearbySchools API, you can:\n\n- List schools that are near a set of coordinates or zipcode/city.\n- Get GreatSchools School Rating Band values for a school.\n    \n\n### Try it out\n\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](https://learning.postman.com/docs/sending-requests/authorization/authorization/)\" tab and you can paste your API key, which will be used across the collection.\n\n### Response types\n\nBy default, responses will be in the JSON format. If you'd like an XML response, set the `Accept` request header to `application/xml`.\n\n### Pagination\n\nFor the `/nearby-schools` and `/schools` endpoints, you may provide the following query parameters to receive paginated results:\n\n- `limit`: maximum number of results that should be returned. Maximum value is `50`.\n- `page`: zero-indexed page value.\n    \n\nResponses will contain the following properties with pagination metadata:\n\n- `cur_page`: the current zero-indexed page value.\n- `items_per_page`: the current `limit` value that determines how many items (schools) are returned per page.\n- `max_page_num`: the last page value for which items (schools) will be returned.\n- `total_count`: the total number of items (schools) available for the query.\n- `links`: object containing relevant endpoints and query parameters for paginated results.\n    - `self`: current page.\n    - `prev`: previous page (empty string when not applicable).\n    - `next`: next page (empty string when not applicable).\n    - `first`: first page, where `page` query parameter is `0`.\n    - `last`: last page, where `page` query parameter is `max_page_num`.\n\n### Error responses\n\nYou may receive a `429 Too Many Requests` error response if:\n\n- Your requests exceed the request and burst limits\n- You attempt to access an endpoint that is not included in your [plan](https://www.greatschools.org/api)\n    \n\n### Questions?\n\n[Check out our FAQs](https://www.greatschools.org/gk/api-developer-resources/) or contact us ([api-support@greatschools.org](https://mailto:api-support@greatschools.org)) for any support you need to get started or resolve an issue.\n\n[<b>Terms of Service</b>](https://www.greatschools.org/gk/api-terms-of-service/)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"27756678","team":5189475,"collectionId":"68119f56-2b68-4fa2-84a5-c8c0107c8b74","publishedId":"2sA3s7hoDd","public":true,"publicUrl":"https://documenter-api.postman.tech/view/27756678/2sA3s7hoDd","privateUrl":"https://go.postman.co/documentation/27756678-68119f56-2b68-4fa2-84a5-c8c0107c8b74","customColor":{"top-bar":"FAFAFA","right-sidebar":"303030","highlight":"1A9DD1"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"This is the go-to resource for developers using the NearbySchools API v2 by GreatSchools. Learn how to fully utilize the NearbySchools API v2 today."},{"name":"title","value":"NearbySchools API v2 Documentation"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/00eb2ef1-fb3e-42ee-bf3b-fc2bf6e07e0c/R1MtZmF2aWNvbi10cmFuc3BhcmVudC0xNDR4MTQ0LnBuZw==","colors":{"top-bar":"0E2B44","right-sidebar":"303030","highlight":"1A9DD1"}},{"name":"light","logo":"https://content.pstmn.io/00eb2ef1-fb3e-42ee-bf3b-fc2bf6e07e0c/R1MtZmF2aWNvbi10cmFuc3BhcmVudC0xNDR4MTQ0LnBuZw==","colors":{"top-bar":"FAFAFA","right-sidebar":"303030","highlight":"1A9DD1"}}]}},"version":"8.10.0","publishDate":"2024-08-15T06:41:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"NearbySchools API v2 Documentation","description":"This is the go-to resource for developers using the NearbySchools API v2 by GreatSchools. Learn how to fully utilize the NearbySchools API v2 today."},"logos":{"logoLight":"https://content.pstmn.io/00eb2ef1-fb3e-42ee-bf3b-fc2bf6e07e0c/R1MtZmF2aWNvbi10cmFuc3BhcmVudC0xNDR4MTQ0LnBuZw==","logoDark":"https://content.pstmn.io/00eb2ef1-fb3e-42ee-bf3b-fc2bf6e07e0c/R1MtZmF2aWNvbi10cmFuc3BhcmVudC0xNDR4MTQ0LnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1be6511cad6be3173796bc9ed25c18dcd9bd21e0a252b0cb3fde800eee4e7f13","favicon":"https://res.cloudinary.com/postman/image/upload/v1686865935/team/v08anzqxsl30o9hynd24.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3s7hoDd"}