v1

latestSwagger 2.02026-07-1362046.5 KB
Schools

Returns a list of schools

Search the SchoolDigger database for schools. You may use any combination of criteria as query parameters.

get/v1/schools

Query parameters

ststring required

Two character state (e.g. 'CA') - required

qstring

Search term - note: will match school name or city (optional)

qSearchSchoolNameOnlyboolean

For parameter 'q', only search school names instead of school and city (optional)

districtIDstring

Search for schools within this district (7 digit district id) (optional)

levelstring

Search for schools at this level. Valid values: 'Elementary', 'Middle', 'High', 'Alt', 'Public', 'Private' (optional). 'Public' returns all Elementary, Middle, High and Alternative schools

citystring

Search for schools in this city (optional)

zipstring

Search for schools in this 5-digit zip code (optional)

isMagnetboolean

True = return only magnet schools, False = return only non-magnet schools (optional) (Pro, Enterprise API levels only)

isCharterboolean

True = return only charter schools, False = return only non-charter schools (optional) (Pro, Enterprise API levels only)

isVirtualboolean

True = return only virtual schools, False = return only non-virtual schools (optional) (Pro, Enterprise API levels only)

isTitleIboolean

True = return only Title I schools, False = return only non-Title I schools (optional) (Pro, Enterprise API levels only)

isTitleISchoolwideboolean

True = return only Title I school-wide schools, False = return only non-Title I school-wide schools (optional) (Pro, Enterprise API levels only)

nearLatitudenumber double

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.)

nearLongitudenumber double

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.)

boundaryAddressstring

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

distanceMilesinteger

Search for schools within (distanceMiles) of (nearLatitude)/(nearLongitude) (Default 5 miles) (optional) (Pro, Enterprise API levels only)

isInBoundaryOnlyboolean

Return only the schools that include given location (nearLatitude/nearLongitude) or (boundaryAddress) in its attendance boundary (Enterprise API level only)

boxLatitudeNWnumber double

Search for schools within a 'box' defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)

boxLongitudeNWnumber double

Search for schools within a 'box' defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)

boxLatitudeSEnumber double

Search for schools within a 'box' defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)

boxLongitudeSEnumber double

Search for schools within a 'box' defined by (boxLatitudeNW/boxLongitudeNW) to (boxLongitudeSE/boxLatitudeSE) (optional)

pageinteger

Page number to retrieve (optional, default: 1)

perPageinteger

Number of schools to retrieve on a page (50 max) (optional, default: 10)

sortBystring

Sort list. Values are: schoolname, distance, rank. For descending order, precede with '-' i.e. -schoolname (optional, default: schoolname)

includeUnrankedSchoolsInRankSortboolean

If sortBy is 'rank', this boolean determines if schools with no rank are included in the result (optional, default: false)

appIDstring required

Your API app id

appKeystring required

Your API app key

Response

OK

numberOfSchoolsinteger

The total count of schools that match your query

numberOfPagesinteger

The total count of pages in your query list based on given per_page value