{"swagger":"2.0","info":{"version":"v1","title":"SchoolDigger API V1","description":"Get detailed data on over 120,000 schools and 18,500 districts in the U.S.","termsOfService":"https://developer.schooldigger.com/termsofservice","contact":{"name":"SchoolDigger","email":"api@schooldigger.com"}},"host":"api.schooldigger.com","schemes":["https"],"paths":{"/v1/districts":{"get":{"tags":["Districts"],"summary":"Returns a list of districts","description":"Search the SchoolDigger database for districts. You may use any combination of criteria as query parameters.","operationId":"Districts_GetAllDistricts","consumes":[],"produces":["application/json"],"parameters":[{"name":"st","in":"query","description":"Two character state (e.g. 'CA') - required","required":true,"type":"string"},{"name":"q","in":"query","description":"Search term - note: will match district name or city (optional)","required":false,"type":"string"},{"name":"city","in":"query","description":"Search for districts in this city (optional)","required":false,"type":"string"},{"name":"zip","in":"query","description":"Search for districts in this 5-digit zip code (optional)","required":false,"type":"string"},{"name":"nearLatitude","in":"query","description":"Search for districts within (distanceMiles) of (nearLatitude)/(nearLongitude) (e.g. 44.982560) (optional) (Pro, Enterprise API levels only. Enterprise API level will flag districts that include lat/long in its attendance boundary.)","required":false,"type":"number","format":"double"},{"name":"nearLongitude","in":"query","description":"Search for districts within (distanceMiles) of (nearLatitude)/(nearLongitude) (e.g. -124.289185) (optional) (Pro, Enterprise API levels only. Enterprise API level will flag districts that include lat/long in its attendance boundary.)","required":false,"type":"number","format":"double"},{"name":"boundaryAddress","in":"query","description":"Full U.S. address: flag returned districts that include this address in its attendance boundary. Example: '123 Main St. AnyTown CA 90001' (optional) (Enterprise API level only)","required":false,"type":"string"},{"name":"distanceMiles","in":"query","description":"Search for districts within (distanceMiles) of (nearLatitude)/(nearLongitude) (Default 50 miles) (optional) (Pro, Enterprise API levels only)","required":false,"type":"integer","format":"int32"},{"name":"isInBoundaryOnly","in":"query","description":"Return only the districts that include given location (nearLatitude/nearLongitude) or (boundaryAddress) in its attendance boundary (Enterprise API level only)","required":false,"type":"boolean"},{"name":"boxLatitudeNW","in":"query","description":"Search for districts within a 'box' defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)","required":false,"type":"number","format":"double"},{"name":"boxLongitudeNW","in":"query","description":"Search for districts within a 'box' defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)","required":false,"type":"number","format":"double"},{"name":"boxLatitudeSE","in":"query","description":"Search for districts within a 'box' defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)","required":false,"type":"number","format":"double"},{"name":"boxLongitudeSE","in":"query","description":"Search for districts within a 'box' defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)","required":false,"type":"number","format":"double"},{"name":"page","in":"query","description":"Page number to retrieve (optional, default: 1)","required":false,"type":"integer","format":"int32"},{"name":"perPage","in":"query","description":"Number of districts to retrieve on a page (50 max) (optional, default: 10)","required":false,"type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"Sort list. Values are: districtname, distance, rank. For descending order, precede with '-' i.e. -districtname (optional, default: districtname)","required":false,"type":"string"},{"name":"includeUnrankedDistrictsInRankSort","in":"query","description":"If sortBy is 'rank', this boolean determines if districts with no rank are included in the result (optional, default: false)","required":false,"type":"boolean"},{"name":"appID","in":"query","description":"Your API app id","required":true,"type":"string","x-data-threescale-name":"app_ids"},{"name":"appKey","in":"query","description":"Your API app key","required":true,"type":"string","x-data-threescale-name":"app_keys"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/APIDistrictList"}}}}},"/v1/districts/{id}":{"get":{"tags":["Districts"],"summary":"Returns a detailed record for one district","description":"Retrieve a single district record from the SchoolDigger database","operationId":"Districts_GetDistrict","consumes":[],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"The 7 digit District ID (e.g. 0642150)","required":true,"type":"string"},{"name":"appID","in":"query","description":"Your API app id","required":true,"type":"string","x-data-threescale-name":"app_ids"},{"name":"appKey","in":"query","description":"Your API app key","required":true,"type":"string","x-data-threescale-name":"app_keys"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/APIDistrict"}}}}},"/v1/rankings/schools/{st}":{"get":{"tags":["Rankings"],"summary":"Returns a SchoolDigger school ranking list","operationId":"Rankings_GetRank","consumes":[],"produces":["application/json"],"parameters":[{"name":"st","in":"path","description":"Two character state (e.g. 'CA')","required":true,"type":"string"},{"name":"year","in":"query","description":"The ranking year (leave blank for most recent year)","required":false,"type":"integer","format":"int32"},{"name":"level","in":"query","description":"Level of ranking: 'Elementary', 'Middle', or 'High'","required":false,"type":"string"},{"name":"page","in":"query","description":"Page number to retrieve (optional, default: 1)","required":false,"type":"integer","format":"int32"},{"name":"perPage","in":"query","description":"Number of schools to retrieve on a page (50 max) (optional, default: 10)","required":false,"type":"integer","format":"int32"},{"name":"appID","in":"query","description":"Your API app id","required":true,"type":"string","x-data-threescale-name":"app_ids"},{"name":"appKey","in":"query","description":"Your API app key","required":true,"type":"string","x-data-threescale-name":"app_keys"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/APISchoolListRank"}}}}},"/v1/rankings/districts/{st}":{"get":{"tags":["Rankings"],"summary":"Returns a SchoolDigger district ranking list","operationId":"Rankings_GetRank_District","consumes":[],"produces":["application/json"],"parameters":[{"name":"st","in":"path","description":"Two character state (e.g. 'CA')","required":true,"type":"string"},{"name":"year","in":"query","description":"The ranking year (leave blank for most recent year)","required":false,"type":"integer","format":"int32"},{"name":"page","in":"query","description":"Page number to retrieve (optional, default: 1)","required":false,"type":"integer","format":"int32"},{"name":"perPage","in":"query","description":"Number of districts to retrieve on a page (50 max) (optional, default: 10)","required":false,"type":"integer","format":"int32"},{"name":"appID","in":"query","description":"Your API app id","required":true,"type":"string","x-data-threescale-name":"app_ids"},{"name":"appKey","in":"query","description":"Your API app key","required":true,"type":"string","x-data-threescale-name":"app_keys"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/APIDistrictListRank"}}}}},"/v1/schools":{"get":{"tags":["Schools"],"summary":"Returns a list of schools","description":"Search the SchoolDigger database for schools. You may use any combination of criteria as query parameters.","operationId":"Schools_GetAllSchools","consumes":[],"produces":["application/json"],"parameters":[{"name":"st","in":"query","description":"Two character state (e.g. 'CA') - required","required":true,"type":"string"},{"name":"q","in":"query","description":"Search term - note: will match school name or city (optional)","required":false,"type":"string"},{"name":"qSearchSchoolNameOnly","in":"query","description":"For parameter 'q', only search school names instead of school and city (optional)","required":false,"type":"boolean"},{"name":"districtID","in":"query","description":"Search for schools within this district (7 digit district id) (optional)","required":false,"type":"string"},{"name":"level","in":"query","description":"Search for schools at this level. Valid values: 'Elementary', 'Middle', 'High', 'Alt', 'Public', 'Private' (optional). 'Public' returns all Elementary, Middle, High and Alternative schools","required":false,"type":"string"},{"name":"city","in":"query","description":"Search for schools in this city (optional)","required":false,"type":"string"},{"name":"zip","in":"query","description":"Search for schools in this 5-digit zip code (optional)","required":false,"type":"string"},{"name":"isMagnet","in":"query","description":"True = return only magnet schools, False = return only non-magnet schools (optional) (Pro, Enterprise API levels only)","required":false,"type":"boolean"},{"name":"isCharter","in":"query","description":"True = return only charter schools, False = return only non-charter schools (optional) (Pro, Enterprise API levels only)","required":false,"type":"boolean"},{"name":"isVirtual","in":"query","description":"True = return only virtual schools, False = return only non-virtual schools (optional) (Pro, Enterprise API levels only)","required":false,"type":"boolean"},{"name":"isTitleI","in":"query","description":"True = return only Title I schools, False = return only non-Title I schools (optional) (Pro, Enterprise API levels only)","required":false,"type":"boolean"},{"name":"isTitleISchoolwide","in":"query","description":"True = return only Title I school-wide schools, False = return only non-Title I school-wide schools (optional) (Pro, Enterprise API levels only)","required":false,"type":"boolean"},{"name":"nearLatitude","in":"query","description":"Search for schools within (distanceMiles) of (nearLatitude)/(nearLongitude) (e.g. 44.982560) (optional) (Pro, Enterprise API levels only. Enterprise API level will flag schools that include lat/long in its attendance boundary.)","required":false,"type":"number","format":"double"},{"name":"nearLongitude","in":"query","description":"Search for schools within (distanceMiles) of (nearLatitude)/(nearLongitude) (e.g. -124.289185) (optional) (Pro, Enterprise API levels only. Enterprise API level will flag schools that include lat/long in its attendance boundary.)","required":false,"type":"number","format":"double"},{"name":"boundaryAddress","in":"query","description":"Full U.S. address: flag returned schools that include this address in its attendance boundary. Example: '123 Main St. AnyTown CA 90001' (optional) (Enterprise API level only) IMPORTANT NOTE: If you have the lat/long of the address, use nearLatitude and nearLongitude instead for much faster response times","required":false,"type":"string"},{"name":"distanceMiles","in":"query","description":"Search for schools within (distanceMiles) of (nearLatitude)/(nearLongitude) (Default 5 miles) (optional) (Pro, Enterprise API levels only)","required":false,"type":"integer","format":"int32"},{"name":"isInBoundaryOnly","in":"query","description":"Return only the schools that include given location (nearLatitude/nearLongitude) or (boundaryAddress) in its attendance boundary (Enterprise API level only)","required":false,"type":"boolean"},{"name":"boxLatitudeNW","in":"query","description":"Search for schools within a 'box' defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)","required":false,"type":"number","format":"double"},{"name":"boxLongitudeNW","in":"query","description":"Search for schools within a 'box' defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)","required":false,"type":"number","format":"double"},{"name":"boxLatitudeSE","in":"query","description":"Search for schools within a 'box' defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)","required":false,"type":"number","format":"double"},{"name":"boxLongitudeSE","in":"query","description":"Search for schools within a 'box' defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)","required":false,"type":"number","format":"double"},{"name":"page","in":"query","description":"Page number to retrieve (optional, default: 1)","required":false,"type":"integer","format":"int32"},{"name":"perPage","in":"query","description":"Number of schools to retrieve on a page (50 max) (optional, default: 10)","required":false,"type":"integer","format":"int32"},{"name":"sortBy","in":"query","description":"Sort list. Values are: schoolname, distance, rank. For descending order, precede with '-' i.e. -schoolname (optional, default: schoolname)","required":false,"type":"string"},{"name":"includeUnrankedSchoolsInRankSort","in":"query","description":"If sortBy is 'rank', this boolean determines if schools with no rank are included in the result (optional, default: false)","required":false,"type":"boolean"},{"name":"appID","in":"query","description":"Your API app id","required":true,"type":"string","x-data-threescale-name":"app_ids"},{"name":"appKey","in":"query","description":"Your API app key","required":true,"type":"string","x-data-threescale-name":"app_keys"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/APISchoolList"}}}}},"/v1/schools/{id}":{"get":{"tags":["Schools"],"summary":"Returns a detailed record for one school","description":"Retrieve a school record from the SchoolDigger database","operationId":"Schools_GetSchool10","consumes":[],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"The 12 digit School ID (e.g. 064215006903)","required":true,"type":"string"},{"name":"appID","in":"query","description":"Your API app id","required":true,"type":"string","x-data-threescale-name":"app_ids"},{"name":"appKey","in":"query","description":"Your API app key","required":true,"type":"string","x-data-threescale-name":"app_keys"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/APISchool10Full"}}}}}},"definitions":{"APIDistrictList":{"type":"object","properties":{"numberOfDistricts":{"format":"int32","description":"The total count of districts that match your query","type":"integer","readOnly":false},"numberOfPages":{"format":"int32","description":"The total count of pages in your query list based on given per_page value","type":"integer","readOnly":false},"districtList":{"type":"array","items":{"$ref":"#/definitions/APIDistrict1Summary"}}}},"APIDistrict1Summary":{"type":"object","properties":{"districtID":{"description":"SchoolDigger District ID Number (7 digits). Use /districts/{districtID} to retrieve the entire district record","type":"string","readOnly":false},"districtName":{"description":"District name","type":"string"},"phone":{"description":"District phone number","type":"string"},"url":{"description":"SchoolDigger URL for this district","type":"string","readOnly":false},"address":{"$ref":"#/definitions/APILocation","description":"District's physical address","readOnly":false},"locationIsWithinBoundary":{"description":"Indicates whether this school's boundary includes the specified location from nearLatitude/nearLongitude or boundaryAddress (Enterprise API level)","type":"boolean","readOnly":false},"hasBoundary":{"description":"Indicates that an attendance boundary is available for this district. (To retrieve, look up district with /districts/{id})","type":"boolean","readOnly":false},"distance":{"format":"double","description":"Distance from nearLatitude/nearLongitude (if supplied)","type":"number"},"isWithinBoundary":{"description":"Indicates whether this district's boundary includes the specified location from nearLatitude/nearLongitude","type":"boolean","readOnly":false},"county":{"$ref":"#/definitions/APICounty","description":"County where district is located","readOnly":false},"lowGrade":{"description":"The low grade served by this district (PK = Prekindergarten, K = Kindergarten)","type":"string","readOnly":false},"highGrade":{"description":"The high grade served by this district","type":"string","readOnly":false},"numberTotalSchools":{"format":"int32","description":"Count of schools in the district","type":"integer","readOnly":false},"numberPrimarySchools":{"format":"int32","description":"Count of schools designated as primary schools","type":"integer","readOnly":false},"numberMiddleSchools":{"format":"int32","description":"Count of schools designated as middle schools","type":"integer","readOnly":false},"numberHighSchools":{"format":"int32","description":"Count of schools designated as high schools","type":"integer","readOnly":false},"numberAlternativeSchools":{"format":"int32","description":"Count of schools designated as other/alternative schools","type":"integer","readOnly":false},"rankHistory":{"description":"SchoolDigger yearly rank history of the district","type":"array","items":{"$ref":"#/definitions/APILEARankHistory"},"readOnly":false},"districtYearlyDetails":{"description":"District yearly metrics","type":"array","items":{"$ref":"#/definitions/APILEAYearlyDetail"},"readOnly":false}}},"APILocation":{"type":"object","properties":{"latLong":{"$ref":"#/definitions/APILatLong","description":"Latitude/longitude of school address (Pro and Enterprise API levels only)","readOnly":false},"street":{"description":"Street address of the school or district (e.g. '18500 37th Avenue N.E.')","type":"string"},"city":{"description":"City where the school or district is located","type":"string"},"state":{"description":"Two-letter state abbreviation (e.g. 'WA')","type":"string"},"stateFull":{"description":"Full state name (WA = Washington)","type":"string","readOnly":false},"zip":{"description":"5-digit ZIP code","type":"string"},"zip4":{"description":"ZIP+4 suffix (4 digits, may be empty)","type":"string"},"cityURL":{"description":"SchoolDigger URL for schools in this city","type":"string","readOnly":false},"zipURL":{"description":"SchoolDigger URL for schools in this zip code","type":"string","readOnly":false},"html":{"description":"HTML formatted address","type":"string","readOnly":false}}},"APICounty":{"type":"object","properties":{"countyName":{"description":"County in which the school or district is located","type":"string"},"countyURL":{"description":"SchoolDigger URL for all schools in this county","type":"string","readOnly":false}}},"APILEARankHistory":{"type":"object","properties":{"year":{"format":"int32","description":"School year (2017 - 2016-17)","type":"integer","readOnly":false},"rank":{"format":"int32","description":"Statewide rank of this district","type":"integer","readOnly":false},"rankOf":{"format":"int32","description":"Count of district ranked in this state","type":"integer","readOnly":false},"rankStars":{"format":"int32","description":"The number of stars SchoolDigger awarded in the ranking of the district (0-5, 5 is best)","type":"integer","readOnly":false},"rankStatewidePercentage":{"format":"double","description":"Percentile of this district's rank (e.g. this district performed better than (x)% of this state's districts)","type":"number","readOnly":false},"rankScore":{"format":"double","description":"The rank score calculated by SchoolDigger (see https://www.schooldigger.com/aboutranking.aspx)","type":"number","readOnly":false}}},"APILEAYearlyDetail":{"type":"object","properties":{"year":{"format":"int32","description":"School year (2018 = 2017-18)","type":"integer"},"numberOfStudents":{"format":"int32","description":"Number of students enrolled in the district","type":"integer"},"numberOfSpecialEdStudents":{"format":"int32","description":"The number of students having a written Individualized Education Program (IEP) under the Individuals With Disabilities Education Act (IDEA)","type":"integer"},"numberOfEnglishLanguageLearnerStudents":{"format":"int32","description":"The number of English language learner (ELL) students served in appropriate programs","type":"integer"},"numberOfTeachers":{"format":"double","description":"Number of full-time equivalent teachers employed by the district","type":"number"},"numberOfTeachersPK":{"format":"double","description":"Number of full-time equivalent pre-kindergarten teachers employed by the district","type":"number"},"numberOfTeachersK":{"format":"double","description":"Number of full-time equivalent kindergarten teachers employed by the district","type":"number"},"numberOfTeachersElementary":{"format":"double","description":"Number of full-time equivalent elementary teachers employed by the district","type":"number"},"numberOfTeachersSecondary":{"format":"double","description":"Number of full-time equivalent secondary teachers employed by the district","type":"number"},"numberOfAids":{"format":"double","description":"Number of full-time equivalent instructional aids employed by the district","type":"number"},"numberOfCoordsSupervisors":{"format":"double","description":"Number of full-time equivalent instructional coordinators/supervisors employed by the district","type":"number"},"numberOfGuidanceElem":{"format":"double","description":"Number of full-time equivalent elementary guidance counselors employed by the district","type":"number"},"numberOfGuidanceSecondary":{"format":"double","description":"Number of full-time equivalent secondary guidance counselors employed by the district","type":"number"},"numberOfGuidanceTotal":{"format":"double","description":"Total number of full-time equivalent guidance counselors employed by the district","type":"number"},"numberOfLibrarians":{"format":"double","description":"Number of full-time equivalent librarians/media specialists employed by the district","type":"number"},"numberOfLibraryStaff":{"format":"double","description":"Number of full-time equivalent librarians/media support staff employed by the district","type":"number"},"numberOfLEAAdministrators":{"format":"double","description":"Number of full-time equivalent LEA administrators employed by the district (LEA)","type":"number"},"numberOfLEASupportStaff":{"format":"double","description":"Number of full-time equivalent LEA administrative support staff employed by the district (LEA)","type":"number"},"numberOfSchoolAdministrators":{"format":"double","description":"Number of full-time equivalent school administrators employed by the district (LEA)","type":"number"},"numberOfSchoolAdminSupportStaff":{"format":"double","description":"Number of full-time equivalent school administrative support staff employed by the district (LEA)","type":"number"},"numberOfStudentSupportStaff":{"format":"double","description":"Number of full-time equivalent student support services staff employed by the district (LEA)","type":"number"},"numberOfOtherSupportStaff":{"format":"double","description":"Number of full-time equivalent all other support staff employed by the district (LEA)","type":"number"}}},"APILatLong":{"type":"object","properties":{"latitude":{"format":"double","description":"Latitude coordinate of the school or district address (WGS84 decimal degrees)","type":"number"},"longitude":{"format":"double","description":"Longitude coordinate of the school or district address (WGS84 decimal degrees, negative for Western Hemisphere)","type":"number"}}},"APIDistrict":{"type":"object","properties":{"districtID":{"description":"SchoolDigger District ID Number (7 digits)","type":"string","readOnly":false},"districtName":{"description":"District name","type":"string"},"phone":{"description":"District phone number","type":"string"},"url":{"description":"SchoolDigger URL for this district","type":"string","readOnly":false},"address":{"$ref":"#/definitions/APILocation","description":"District's physical address","readOnly":false},"boundary":{"$ref":"#/definitions/APIBoundary","readOnly":false},"isWithinBoundary":{"description":"Indicates whether this district's boundary includes the specified location from nearLatitude/nearLongitude","type":"boolean","readOnly":false},"county":{"$ref":"#/definitions/APICounty","description":"County where district is located","readOnly":false},"lowGrade":{"description":"The low grade served by this district (PK = Prekindergarten, K = Kindergarten)","type":"string","readOnly":false},"highGrade":{"description":"The high grade served by this district","type":"string","readOnly":false},"numberTotalSchools":{"format":"int32","type":"integer","readOnly":false},"numberPrimarySchools":{"format":"int32","type":"integer","readOnly":false},"numberMiddleSchools":{"format":"int32","type":"integer","readOnly":false},"numberHighSchools":{"format":"int32","type":"integer","readOnly":false},"numberAlternativeSchools":{"format":"int32","type":"integer","readOnly":false},"rankHistory":{"description":"SchoolDigger yearly rank history for this district, sorted most recent year first. Districts are ranked statewide regardless of level.","type":"array","items":{"$ref":"#/definitions/APILEARankHistory"},"readOnly":false},"districtYearlyDetails":{"description":"Yearly enrollment and staffing details for this district. Array is sorted most recent year first. Includes detailed FTE staffing breakdowns by role (teachers by level, administrators, counselors, librarians, support staff).","type":"array","items":{"$ref":"#/definitions/APILEAYearlyDetail"},"readOnly":false},"testScores":{"description":"Standardized test score results with district and state comparisons. Each entry represents one test/subject/grade/year combination. District-level records do not include schoolTestScore. Requires Pro or Enterprise API subscription.","type":"array","items":{"$ref":"#/definitions/APITestScoreWrapper"},"readOnly":false}}},"APIBoundary":{"type":"object","properties":{"polylineCollection":{"description":"Collection of one or more polylines that can be used to create the boundary on a map. NOTE: this value is JSON encoded. Specifically, backslashes will be returned escaped (two backslashes). Make sure to decode the polyline before you use it","type":"array","items":{"$ref":"#/definitions/APIPolyline"},"readOnly":false},"hasBoundary":{"description":"States whether there is a boundary available","type":"boolean","readOnly":false}}},"APITestScoreWrapper":{"type":"object","properties":{"test":{"description":"The name of the state-administered test","type":"string","readOnly":false},"subject":{"description":"Test subject","type":"string","readOnly":false},"year":{"format":"int32","description":"Year test was administered (2018 = 2017-18)","type":"integer","readOnly":false},"grade":{"description":"Grade level for which this test score applies (e.g. '3', '5', '8', '10', 'HS')","type":"string","readOnly":false},"schoolTestScore":{"$ref":"#/definitions/APITestScore","description":"School level test score","readOnly":false},"districtTestScore":{"$ref":"#/definitions/APITestScore","description":"District level test score","readOnly":false},"stateTestScore":{"$ref":"#/definitions/APITestScore","description":"State level text score","readOnly":false},"tier1":{"description":"Label for the lowest performance tier on this test (e.g. 'Below Basic', 'Level 1'). Tier labels are state-specific. Enterprise API level only.","type":"string","readOnly":false},"tier2":{"description":"Label for the second performance tier (e.g. 'Basic', 'Level 2'). Enterprise API level only.","type":"string","readOnly":false},"tier3":{"description":"Label for the third performance tier (e.g. 'Proficient', 'Level 3'). Enterprise API level only.","type":"string","readOnly":false},"tier4":{"description":"Label for the fourth performance tier (e.g. 'Advanced', 'Level 4'). Enterprise API level only.","type":"string","readOnly":false},"tier5":{"description":"Label for the fifth performance tier, if applicable (e.g. 'No Score'). Not all states use 5 tiers. Enterprise API level only.","type":"string","readOnly":false}}},"APIPolyline":{"type":"object","properties":{"polylineOverlayEncodedPoints":{"description":"Google Maps encoded polyline string for rendering the boundary on a map. Compatible with google.maps.geometry.encoding.decodePath() and similar libraries. IMPORTANT: Backslashes are JSON-escaped (appear as \\\\). Unescape to single backslashes before decoding.","type":"string"},"numberEncodedPoints":{"format":"int32","description":"Number of encoded points in polyline","type":"integer"}}},"APITestScore":{"type":"object","properties":{"studentsEligible":{"format":"int32","description":"Count of students eligible to take test","type":"integer","readOnly":false},"studentsTested":{"format":"int32","description":"Count of students tested","type":"integer","readOnly":false},"meanScaledScore":{"format":"float","description":"Mean scale score","type":"number","readOnly":false},"percentMetStandard":{"format":"float","description":"Percent of students meeting state standard","type":"number","readOnly":false},"numberMetStandard":{"format":"float","description":"Count of students meeting state standard","type":"number","readOnly":false},"numTier1":{"format":"int32","description":"Count of students performing at tier 1 (Enterprise API level only)","type":"integer","readOnly":false},"numTier2":{"format":"int32","description":"Count of students performing at tier 2 (Enterprise API level only)","type":"integer","readOnly":false},"numTier3":{"format":"int32","description":"Count of students performing at tier 3 (Enterprise API level only)","type":"integer","readOnly":false},"numTier4":{"format":"int32","description":"Count of students performing at tier 4 (Enterprise API level only)","type":"integer","readOnly":false},"numTier5":{"format":"int32","description":"Count of students performing at tier 5 (Enterprise API level only)","type":"integer","readOnly":false},"percentTier1":{"format":"float","description":"Percent of students performing at tier 1 (Enterprise API level only)","type":"number","readOnly":false},"percentTier2":{"format":"float","description":"Percent of students performing at tier 2 (Enterprise API level only)","type":"number","readOnly":false},"percentTier3":{"format":"float","description":"Percent of students performing at tier 3 (Enterprise API level only)","type":"number","readOnly":false},"percentTier4":{"format":"float","description":"Percent of students performing at tier 4 (Enterprise API level only)","type":"number","readOnly":false},"percentTier5":{"format":"float","description":"Percent of students performing at tier 5 (Enterprise API level only)","type":"number","readOnly":false}}},"APISchoolListRank":{"type":"object","properties":{"rankYear":{"format":"int32","description":"Year this ranking list represents (2018 = 2017-18)","type":"integer"},"rankYearCompare":{"format":"int32","description":"Year rankings returned for comparison (2018 = 2017-18)","type":"integer"},"rankYearsAvailable":{"description":"The years for which SchoolDigger rankings are available for this state and level","type":"array","items":{"format":"int32","type":"integer"}},"numberOfSchools":{"format":"int32","description":"The total count of schools in this ranking list","type":"integer","readOnly":false},"numberOfPages":{"format":"int32","description":"The total count of pages this ranking list based on given per_page value","type":"integer","readOnly":false},"schoolList":{"description":"The schools in the ranking list","type":"array","items":{"$ref":"#/definitions/APISchool1Summary"},"readOnly":false}}},"APISchool1Summary":{"description":"APISchool1Summary: A summary of a school record. For the full school record, call /schools/{id}","type":"object","properties":{"schoolid":{"description":"SchoolDigger School ID Number (12 digits). Use /schools/{schoolID} to retrieve the full school record","type":"string","readOnly":false},"schoolName":{"description":"School name","type":"string"},"phone":{"description":"School phone number","type":"string"},"url":{"description":"SchoolDigger URL for this school","type":"string","readOnly":false},"urlCompare":{"description":"SchoolDigger URL for comparing this school to others","type":"string","readOnly":false},"address":{"$ref":"#/definitions/APILocation","description":"School's physical address","readOnly":false},"distance":{"format":"double","description":"Distance from nearLatitude/nearLongitude (if supplied)","type":"number","readOnly":false},"lowGrade":{"description":"The low grade served by this school (PK = Prekindergarten, K = Kindergarten)","type":"string","readOnly":false},"highGrade":{"description":"The high grade served by this school","type":"string","readOnly":false},"schoolLevel":{"description":"The level of school (Elementary, Middle, High, Private, Alternative)","type":"string","readOnly":false},"isCharterSchool":{"description":"Indicates if school is a charter school (Yes/No/n-a)","type":"string","readOnly":false},"isMagnetSchool":{"description":"Indicates if school is a magnet school (Yes/No/n-a)","type":"string","readOnly":false},"isVirtualSchool":{"description":"Indicates if school is a virtual school (Yes/No/n-a)","type":"string","readOnly":false},"isTitleISchool":{"description":"Indicates if school is a Title I school (Yes/No/n-a)","type":"string","readOnly":false},"isTitleISchoolwideSchool":{"description":"Indicates if a school-wide Title I school (Yes/No/n-a)","type":"string","readOnly":false},"district":{"$ref":"#/definitions/APIDistrictSum","description":"District of school (public schools only)","readOnly":false},"county":{"$ref":"#/definitions/APICounty","description":"County where school is located","readOnly":false},"rankHistory":{"description":"SchoolDigger yearly rank history of the school. To retrieve all years, call /schools/{id}.","type":"array","items":{"$ref":"#/definitions/APIRankHistory"},"readOnly":false},"rankMovement":{"format":"int32","description":"Returns the movement of rank for this school between current and previous year","type":"integer","readOnly":false},"hasBoundary":{"description":"Indicates that an attendance boundary is available for this school.","type":"boolean","readOnly":false},"locationIsWithinBoundary":{"description":"Indicates whether this school's boundary includes the specified location from nearLatitude/nearLongitude or boundaryAddress. (Enterprise API level only)","type":"boolean","readOnly":false},"schoolYearlyDetails":{"description":"School Yearly metrics. To retrieve all years, call /schools/{id}.","type":"array","items":{"$ref":"#/definitions/APIYearlyDemographics"},"readOnly":false},"isPrivate":{"description":"Indicates if school is a private school (Yes/No)","type":"boolean"},"privateDays":{"format":"int32","description":"Days in the school year (private schools only)","type":"integer"},"privateHours":{"format":"double","description":"Hours in the school day (private schools only)","type":"number"},"privateHasLibrary":{"description":"Indicates if the school has a library (private schools only)","type":"boolean"},"privateCoed":{"description":"Coed/Boys/Girls (private schools only)","type":"string"},"privateOrientation":{"description":"Affiliation of the school (private schools only)","type":"string"}}},"APIDistrictSum":{"description":"District Summary","type":"object","properties":{"districtID":{"description":"The 7 digit SchoolDigger District id number","type":"string","readOnly":false},"districtName":{"type":"string"},"url":{"description":"The URL to see the district details on SchoolDigger","type":"string","readOnly":false},"rankURL":{"description":"The URL to see the district in the SchoolDigger ranking list","type":"string","readOnly":false}}},"APIRankHistory":{"type":"object","properties":{"year":{"format":"int32","description":"School year (2017 - 2016-17)","type":"integer","readOnly":false},"rank":{"format":"int32","description":"Statewide rank of this School","type":"integer","readOnly":false},"rankOf":{"format":"int32","description":"Count of schools ranked at this state/level","type":"integer","readOnly":false},"rankStars":{"format":"int32","description":"The number of stars SchoolDigger awarded in the ranking of the school (0-5, 5 is best)","type":"integer","readOnly":false},"rankLevel":{"description":"The level for which this school is ranked (Elementary, Middle, High)","type":"string","readOnly":false},"rankStatewidePercentage":{"format":"double","description":"Percentile of this school's rank (e.g. this school performed better than (x)% of this state's elementary schools)","type":"number","readOnly":false},"averageStandardScore":{"format":"double","description":"The Average Standard score calculated by SchoolDigger (see: https://www.schooldigger.com/aboutrankingmethodology.aspx)","type":"number"}}},"APIYearlyDemographics":{"type":"object","properties":{"year":{"format":"int32","description":"School year (2018 = 2017-18)","type":"integer","readOnly":false},"numberOfStudents":{"format":"int32","description":"Count of students attending the school","type":"integer","readOnly":false},"percentFreeDiscLunch":{"format":"double","description":"Percent of students receiving a free or discounted lunch in the National School Lunch Program","type":"number","readOnly":false},"percentofAfricanAmericanStudents":{"format":"double","description":"Percentage of students who are Black or African American (NCES definition: a person having origins in any of the black racial groups of Africa)","type":"number","readOnly":false},"percentofAsianStudents":{"format":"double","description":"Percentage of students who are Asian (NCES definition: a person having origins in any of the original peoples of the Far East, Southeast Asia, or the Indian subcontinent)","type":"number","readOnly":false},"percentofHispanicStudents":{"format":"double","description":"Percentage of students who are Hispanic or Latino (NCES definition: a person of Cuban, Mexican, Puerto Rican, South or Central American, or other Spanish culture or origin, regardless of race)","type":"number","readOnly":false},"percentofIndianStudents":{"format":"double","description":"Percentage of students who are American Indian or Alaska Native (NCES definition: a person having origins in any of the original peoples of North and South America who maintains tribal affiliation or community attachment)","type":"number","readOnly":false},"percentofPacificIslanderStudents":{"format":"double","description":"Percentage of students who are Native Hawaiian or Other Pacific Islander (NCES definition: a person having origins in any of the original peoples of Hawaii, Guam, Samoa, or other Pacific Islands)","type":"number","readOnly":false},"percentofWhiteStudents":{"format":"double","description":"Percentage of students who are White (NCES definition: a person having origins in any of the original peoples of Europe, the Middle East, or North Africa)","type":"number","readOnly":false},"percentofTwoOrMoreRaceStudents":{"format":"double","description":"Percentage of students reporting two or more races (not Hispanic/Latino)","type":"number","readOnly":false},"percentofUnspecifiedRaceStudents":{"format":"double","description":"Percentage of students whose race/ethnicity was not specified or reported","type":"number","readOnly":false},"teachersFulltime":{"format":"double","description":"Number of full-time equivalent teachers employed at the school","type":"number"},"pupilTeacherRatio":{"format":"double","description":"Number of students / number of full-time equivalent teachers","type":"number"},"numberofAfricanAmericanStudents":{"format":"int32","description":"NCES definition: A person having origins in any of the black racial groups of Africa.  (https://nces.ed.gov/statprog/2002/std1_5.asp)","type":"integer"},"numberofAsianStudents":{"format":"int32","description":"NCES definition: A person having origins in any of the original peoples of the Far East, Southeast Asia, or the Indian subcontinent, including, for example, Cambodia, China, India, Japan, Korea, Malaysia, Pakistan, the Philippine Islands, Thailand, and Vietnam.  (https://nces.ed.gov/statprog/2002/std1_5.asp)","type":"integer"},"numberofHispanicStudents":{"format":"int32","description":"NCES definition: A person of Cuban, Mexican, Puerto Rican, South or Central American, or other Spanish culture or origin, regardless of race. (https://nces.ed.gov/statprog/2002/std1_5.asp)","type":"integer"},"numberofIndianStudents":{"format":"int32","description":"Count of American Indian or Alaska Native students (NCES definition: a person having origins in any of the original peoples of North and South America who maintains tribal affiliation or community attachment)","type":"integer"},"numberofPacificIslanderStudents":{"format":"int32","description":"NCES definition: A person having origins in any of the original peoples of Hawaii, Guam, Samoa, or other Pacific Islands. (https://nces.ed.gov/statprog/2002/std1_5.asp)","type":"integer"},"numberofWhiteStudents":{"format":"int32","description":"NCES definition: A person having origins in any of the original peoples of Europe, the Middle East, or North Africa. (https://nces.ed.gov/statprog/2002/std1_5.asp)","type":"integer"},"numberofTwoOrMoreRaceStudents":{"format":"int32","description":"NCES definition: Includes any combination of two or more races and not Hispanic/Latino ethnicity. (https://nces.ed.gov/statprog/2002/std1_5.asp)","type":"integer"},"numberofUnspecifiedRaceStudents":{"format":"int32","description":"Count of students whose race/ethnicity was not specified or reported","type":"integer"}}},"APIDistrictListRank":{"type":"object","properties":{"rankYear":{"format":"int32","description":"Year this ranking list represents (2018 = 2017-18)","type":"integer"},"rankYearCompare":{"format":"int32","description":"Year rankings returned for comparison (2018 = 2017-18)","type":"integer"},"rankYearsAvailable":{"description":"The years for which SchoolDigger district rankings are available for this state","type":"array","items":{"format":"int32","type":"integer"}},"numberOfDistricts":{"format":"int32","description":"The total count of districts in the entire rank list","type":"integer","readOnly":false},"numberOfPages":{"format":"int32","description":"The total count of pages in your query list based on given per_page value","type":"integer","readOnly":false},"districtList":{"type":"array","items":{"$ref":"#/definitions/APIDistrict1Summary"}},"rankCompareYear":{"format":"int32","type":"integer"}}},"APISchoolList":{"type":"object","properties":{"numberOfSchools":{"format":"int32","description":"The total count of schools that match your query","type":"integer","readOnly":false},"numberOfPages":{"format":"int32","description":"The total count of pages in your query list based on given per_page value","type":"integer","readOnly":false},"schoolList":{"type":"array","items":{"$ref":"#/definitions/APISchool1Summary"}}}},"APISchool10Full":{"type":"object","properties":{"schoolid":{"description":"SchoolDigger School ID Number (12 digits)","type":"string","readOnly":false},"schoolName":{"description":"School name","type":"string"},"phone":{"description":"School phone number","type":"string"},"url":{"description":"SchoolDigger URL for this school","type":"string","readOnly":false},"urlCompare":{"description":"SchoolDigger URL for comparing this school to nearby schools","type":"string","readOnly":false},"address":{"$ref":"#/definitions/APILocation","description":"School's physical address","readOnly":false},"locale":{"description":"NCES urban-centric locale classification (e.g. 'City: Large', 'Suburb: Midsize', 'Rural: Fringe'). Categories: City (Large/Midsize/Small), Suburb (Large/Midsize/Small), Town (Fringe/Distant/Remote), Rural (Fringe/Distant/Remote). See https://nces.ed.gov/ccd/rural_locales.asp","type":"string","readOnly":false},"lowGrade":{"description":"The low grade served by this school (PK = Prekindergarten, K = Kindergarten)","type":"string","readOnly":false},"highGrade":{"description":"The high grade served by this school","type":"string","readOnly":false},"schoolLevel":{"description":"The level of school (Elementary, Middle, High, Private, Alternative)","type":"string","readOnly":false},"isCharterSchool":{"description":"Indicates if school is a charter school (Yes/No/n-a)","type":"string","readOnly":false},"isMagnetSchool":{"description":"Indicates if school is a magnet school (Yes/No/n-a)","type":"string","readOnly":false},"isVirtualSchool":{"description":"Indicates if school is a virtual school (Yes/No/n-a)","type":"string","readOnly":false},"isTitleISchool":{"description":"Indicates if school is a Title I school (Yes/No/n-a)","type":"string","readOnly":false},"isTitleISchoolwideSchool":{"description":"Indicates if a school-wide Title I school (Yes/No/n-a)","type":"string","readOnly":false},"isPrivate":{"description":"Indicates if school is a private school (Yes/No)","type":"boolean","readOnly":false},"privateDays":{"format":"int32","description":"Days in the school year (private schools only)","type":"integer","readOnly":false},"privateHours":{"format":"double","description":"Hours in the school day (private schools only)","type":"number","readOnly":false},"privateHasLibrary":{"description":"Indicates if the school has a library (private schools only)","type":"boolean","readOnly":false},"privateCoed":{"description":"Coed/Boys/Girls (private schools only)","type":"string","readOnly":false},"privateOrientation":{"description":"Affiliation of the school (private schools only)","type":"string","readOnly":false},"boundary":{"$ref":"#/definitions/APIBoundary","readOnly":false},"district":{"$ref":"#/definitions/APIDistrictSum","description":"District of school (public schools only)","readOnly":false},"county":{"$ref":"#/definitions/APICounty","description":"County where school is located","readOnly":false},"rankHistory":{"description":"SchoolDigger yearly rank history for this school, sorted most recent year first. Schools are ranked within their state and level (Elementary, Middle, or High). Includes all available years — the full record returns more years than the summary in search results.","type":"array","items":{"$ref":"#/definitions/APIRankHistory"},"readOnly":false},"rankMovement":{"format":"int32","description":"Returns the movement of rank for this school between current and previous year","type":"integer","readOnly":false},"testScores":{"description":"Standardized test score results with school, district, and state comparisons. Each entry represents one test/subject/grade/year combination. Includes percent meeting standard and optional tier breakdowns (Enterprise level). Tests are state-specific (e.g. SBA, WCAS in WA; CAASPP in CA). Requires Pro or Enterprise API subscription.","type":"array","items":{"$ref":"#/definitions/APITestScoreWrapper"},"readOnly":false},"schoolYearlyDetails":{"description":"Yearly enrollment, demographics, and staffing for this school. Array is sorted most recent year first and includes all available years (back to 1988 for some schools). The full record returns more years than the summary in search results.","type":"array","items":{"$ref":"#/definitions/APIYearlyDemographics"},"readOnly":false}}}}}