API Documentation

Comprehensive documentation for the SchoolView API. Get started quickly with our guides and examples.

Interactive API Explorer Download OpenAPI Spec

Quick Start

Get up and running with the SchoolView API in minutes. Learn the basics and make your first request.

Get Started

School Data

Learn how to search for schools, get detailed information, and access ratings and metrics.

Explore Schools

SDKs & Libraries

Use our official SDKs for TypeScript and Python to integrate SchoolView into your applications.

View SDKs

Quick Start

1. Get Your API Key

Get API Key

2. Make Your First Request

Test the API with a simple health check:

curl -X GET "https://api.schoolview.com/v1/health" \
  -H "X-API-Key: your-api-key-here"

3. Search for Schools

Find schools near a location:

curl -X GET \
  "https://api.schoolview.com/v1/schools/search?lat=37.7749&lng=-122.4194&radius_km=10" \
  -H "X-API-Key: your-api-key-here"

School Data Endpoints

Search Schools

Find schools by location with optional filters for state, grade levels, and more.

GET /v1/schools/search

Get School Details

Retrieve comprehensive information about a specific school including ratings and metrics.

GET /v1/schools/{ncesId}

School Ratings

Access detailed ratings and performance scores for schools across different metrics.

GET /v1/ratings/schools/{ncesId}

Data Sources

Explore the data sources and methodologies behind our school information.

GET /v1/sources

SDKs & Libraries

TypeScript SDK

Official TypeScript client with full type safety and IntelliSense support.

npm install @schoolview/sdk-ts

import { SchoolViewClient } from '@schoolview/sdk-ts';

const client = new SchoolViewClient({
    apiKey: 'your-api-key'
});

View on NPM

Python SDK

Official Python client with clean interface and comprehensive error handling.

pip install schoolview-sdk

from schoolview_sdk import SchoolViewClient

client = SchoolViewClient(api_key='your-api-key')

View on PyPI

Need Help?

Our documentation is comprehensive, but if you need additional support, we're here to help.