v1

latestSwagger 2.02026-07-1362046.5 KB
Districts

Returns a list of districts

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

get/v1/districts

Query parameters

ststring required

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

qstring

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

citystring

Search for districts in this city (optional)

zipstring

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

nearLatitudenumber double

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

nearLongitudenumber double

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

boundaryAddressstring

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)

distanceMilesinteger

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

isInBoundaryOnlyboolean

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

boxLatitudeNWnumber double

Search for districts within a 'box' defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)

boxLongitudeNWnumber double

Search for districts within a 'box' defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)

boxLatitudeSEnumber double

Search for districts within a 'box' defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)

boxLongitudeSEnumber double

Search for districts within a 'box' defined by (BoxLatitudeNW/BoxLongitudeNW) to (BoxLongitudeSE/BoxLatitudeSE) (optional)

pageinteger

Page number to retrieve (optional, default: 1)

perPageinteger

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

sortBystring

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

includeUnrankedDistrictsInRankSortboolean

If sortBy is 'rank', this boolean determines if districts 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

numberOfDistrictsinteger

The total count of districts that match your query

numberOfPagesinteger

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

All 6 operations