Skip to main content

Official Python SDK for the SchoolDigger K-12 School Data API

Project description

SchoolDigger Python SDK

Official Python client for the SchoolDigger API — K-12 school data for 120,000+ U.S. schools.

Installation

pip install schooldigger

Quick Start

import schooldigger

config = schooldigger.Configuration()
config.api_key["appID"] = "YOUR_APP_ID"
config.api_key["appKey"] = "YOUR_APP_KEY"

client = schooldigger.ApiClient(config)

# Search schools
api = schooldigger.SchoolsApi(client)
result = api.search_schools(st="WA", q="Lincoln")
for school in result.school_list:
    print(f"{school.school_name}{school.address.city}, {school.address.state}")

# Get a specific school by SchoolDigger ID
school = api.get_school("530966001632")
print(f"Enrollment: {school.school_yearly_details[0].number_of_students}")

API Classes

Class Methods
SchoolsApi search_schools(), get_school()
DistrictsApi search_districts(), get_district()
RankingsApi get_school_rankings(), get_district_rankings()
AutocompleteApi autocomplete_schools(), autocomplete_districts()

Authentication

All API calls require an appID and appKey. Get your free API key at developer.schooldigger.com.

Documentation

Plans

Plan Price Highlights
DEV/TEST Free Enterprise-level access, 20 calls/day
Basic $19.90/mo 1 year of data
Pro $89/mo Boundaries, geo search, finance
Enterprise $189/mo Full depth, boundary containment

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

schooldigger-1.0.0.tar.gz (55.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

schooldigger-1.0.0-py3-none-any.whl (93.8 kB view details)

Uploaded Python 3

File details

Details for the file schooldigger-1.0.0.tar.gz.

File metadata

  • Download URL: schooldigger-1.0.0.tar.gz
  • Upload date:
  • Size: 55.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for schooldigger-1.0.0.tar.gz
Algorithm Hash digest
SHA256 50d751a3500dfa863f9f0261a8d76377079093b107870f456477e34f71d14fca
MD5 b4716593e4b5bbb65d0e303071d4a5aa
BLAKE2b-256 a2880b9885ebaac305c680e9126aea446d9a889611f06663dce53299fd34fbe6

See more details on using hashes here.

File details

Details for the file schooldigger-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: schooldigger-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 93.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for schooldigger-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 27cb900d014386aa59a1481cccdf5193acf1e1aee2475055286ffc8ecd1d824d
MD5 10c907fee1be32592eb9c7be1b8abffe
BLAKE2b-256 b642b03cd9b35fb70f90479d3fe50cc652043c4794dde2336e52b8f7860d1d50

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page