← Back to Platform

API Changelog

Track API changes, deprecation notices, and migration guides. Stay current with versioned releases and breaking updates.

Stay Updated: Get notified when we ship API changes, new endpoints, and breaking updates via email or RSS feed.

Subscribe to Updates

📋 Quick Navigation

Latest Releases

v1.0.0 Major Launch

🚀 Public API Launch

ThinkKits API is now publicly available! Our REST API provides programmatic access to school profiles, funding data, AI tools, and analytics across all 50 states plus DC.

Core School Intelligence Endpoints Added

  • GET /schools/search — Autocomplete school search by name with filters
  • GET /schools/{nces_id} — Complete school profiles with intelligence scores
  • GET /schools/{nces_id}/peers — Demographically similar school analysis
  • GET /schools/{nces_id}/health — Composite 0-100 health scoring
  • GET /schools/{nces_id}/needs — AI-powered comprehensive needs assessment
  • GET /schools/{nces_id}/equity — Equity profile with CRDC indicators
  • GET /bright-spots — Schools outperforming demographics

Funding & Grants Intelligence Added

  • GET /schools/{nces_id}/funding — Federal funding program eligibility
  • POST /purchase/qualify — Funding compliance checker for purchases
  • GET /grants/programs — Available grant programs database
  • POST /grants/write — AI grant narrative generation (.docx output)
  • POST /reports/justification — Audit-ready funding justification reports

Data & Analytics Stack Added

  • GET /query/ask — Natural language data queries
  • GET /export/schools — Bulk school data export (CSV/JSON)
  • GET /districts/{leaid}/spending — F-33 district finance breakdowns
  • GET /spending/compare — Cross-district spending comparisons
  • GET /equity/gaps — Largest equity gaps by state/metric

Vendor & Sales Intelligence Added

  • POST /leads/from-purchase — Targeted lead list generation
  • GET /market/summary — TAM analysis and lead tier distribution
  • GET /vendors/erate — E-Rate vendor rankings by commitment volume
  • GET /vendors/erate/{vendor_name} — Detailed vendor procurement history
  • GET /shortages — Teacher shortage areas by state

Geographic Intelligence Added

  • GET /states/{abbr}/profile — Comprehensive state-level aggregates
  • GET /districts/search — Autocomplete district search
  • POST /reports/district — AI district intelligence reports (.docx)

AI Tools & Automation Added

  • POST /agent/chat — Conversational AI with full platform access
  • POST /extract/document — AI document extraction (images/text)

Account & Marketplace Management Added

  • GET /marketplace/tiers — Available API tiers and pricing
  • GET /marketplace/usage — Usage statistics and quota monitoring
  • GET /standards/certify — Curriculum standards coverage data

Authentication & Security Added

  • API key authentication via X-API-Key header
  • Tier-based rate limiting: Explorer (3/day), Starter (25/day), Professional (100/day), Business (unlimited)
  • Comprehensive rate limit headers (X-RateLimit-*) on all responses
  • RFC 7807 compliant error responses with structured problem details

Response Format Standards Added

  • Consistent JSON structure with predictable field naming conventions
  • Cursor-based pagination for large result sets
  • Comprehensive metadata in response headers
  • OpenAPI 3.0 specification available at /docs endpoint
Coverage Statistics

Launch dataset includes schools, districts, $78B+ in federal education funding tracked, 450K+ grant opportunities, and real-time E-Rate procurement intelligence.

Planned Releases

v1.1.0 Feature Release

Enhanced Analytics & Intelligence Planned

  • POST /analytics/compare-schools — Bulk school comparison with custom metrics
  • GET /analytics/trends — Multi-year demographic and performance trend analysis
  • GET /funding/gap-analysis — District-level funding adequacy analysis
  • POST /reports/custom — Custom report generation with dynamic templates

Real-Time Notifications Planned

  • POST /webhooks/subscribe — Webhook subscription management
  • Real-time notifications for school data changes and updates
  • Grant deadline alerts and E-Rate filing period notifications
  • Funding opportunity alerts based on school eligibility changes

Advanced Search & Filtering Planned

  • Geographic search with radius-based filtering
  • Advanced demographic filters with statistical operators
  • Saved search templates and result subscriptions
  • AI-powered search suggestions and autocomplete

Enhanced AI Capabilities Planned

  • Multi-language support for Spanish-speaking districts
  • Improved grant writing with ESSA evidence integration
  • Predictive analytics for funding opportunity scoring
  • Custom AI agent training on district-specific data
Backwards Compatibility

v1.1.0 will be fully backwards compatible with v1.0.0. All existing integrations will continue to work without modification.

v2.0.0 Breaking Changes

GraphQL API Introduction Planned

  • Unified GraphQL endpoint at /graphql for all data types
  • Real-time subscriptions via WebSocket for live data updates
  • Advanced filtering, sorting, and aggregation capabilities
  • Client-driven field selection for optimal bandwidth usage

REST API Modernization Breaking

  • URL Structure: All endpoints moved to /api/v2/* namespace
  • Authentication: OAuth 2.0 with PKCE required, API keys deprecated
  • Response Format: JSON:API specification compliance
  • Pagination: Cursor-based pagination becomes mandatory

Enhanced Data Model Breaking

  • Standardized field naming conventions (snake_case → camelCase)
  • Expanded metadata with data lineage and freshness indicators
  • Hierarchical relationship modeling for districts, schools, and programs
  • Support for historical data snapshots and versioning
Breaking Changes Notice

v2.0.0 includes significant breaking changes that require client updates. REST API v1.x will remain supported until Q4 2027. Migration tools and automated conversion utilities will be provided.

v2.0 Migration Checklist

  1. Authentication: Implement OAuth 2.0 flow and update API key usage
  2. URLs: Update all endpoint URLs to include /api/v2/ prefix
  3. Response Parsing: Adapt JSON parsing for JSON:API format changes
  4. Field Names: Update field references from snake_case to camelCase
  5. Pagination: Implement cursor-based pagination handlers
  6. Error Handling: Update error response parsing for new format
  7. Testing: Use sandbox environment at api-v2-sandbox.thinkkits.com
GraphQL Benefits

GraphQL adoption enables more efficient data fetching, reduced over-fetching, and improved developer experience with strong typing and introspection capabilities.

Migration Policy

Version Support Lifecycle

ThinkKits API follows semantic versioning (SemVer) with clear support windows:

  • Major versions (x.0.0): Supported for 2 years after release
  • Minor versions (1.x.0): Automatically updated, no breaking changes
  • Patch versions (1.1.x): Bug fixes and security updates only

Breaking Change Process

  1. Advance Notice (90+ days): Breaking changes announced via changelog, email, and API headers
  2. Deprecation Headers: Affected endpoints return Sunset and Deprecation headers
  3. Migration Tools: Automated migration utilities and conversion scripts provided
  4. Sandbox Testing: Pre-release versions available in sandbox environment
  5. Developer Support: Migration assistance for Business tier customers
  6. Gradual Rollout: Phased deployment with rollback capabilities
Deprecation Headers HTTP/1.1 200 OK Content-Type: application/json Sunset: "Sun, 01 Jan 2028 00:00:00 GMT" Deprecation: "Sat, 01 Jul 2027 00:00:00 GMT" Link: <https://thinkkits.com/help-center/api/changelog.html#v2-migration>; rel="sunset" { "data": [...], "deprecated": true, "deprecation_notice": "This endpoint will be removed on Jan 1, 2028. Migrate to /api/v2/schools.", "migration_url": "https://thinkkits.com/help-center/api/changelog.html#v2-migration" }

Deprecation Process

When we need to deprecate API features, we follow a structured process to minimize impact:

Standard Deprecation Timeline

  1. T-90 days: Deprecation announcement via changelog and email notifications
  2. T-60 days: Deprecation headers added to affected endpoints
  3. T-30 days: Final migration reminder and usage analytics shared
  4. T-7 days: Read-only mode for deprecated endpoints (writes blocked)
  5. T-0 days: Endpoint removal with HTTP 410 Gone responses

Emergency Deprecations

In cases of security vulnerabilities or critical issues, we may accelerate this timeline with minimum 14-day notice for security-related deprecations.

Migration Assistance

  • Documentation: Detailed migration guides with code examples
  • Tools: Automated migration scripts and validation utilities
  • Support: Priority assistance for affected Business tier customers
  • Monitoring: Usage analytics to identify high-impact deprecations

Change Classification

We classify all API changes to help you understand compatibility impact:

Change Types

  • Added — New features, endpoints, or fields (backwards compatible)
  • Changed — Modified behavior that may require client updates
  • Deprecated — Features marked for future removal
  • Removed — Previously deprecated features now removed
  • Fixed — Bug fixes and error corrections
  • Security — Security-related updates and patches

Breaking vs. Non-Breaking Changes

Non-Breaking Changes: New fields, new endpoints, additional optional parameters, bug fixes that restore documented behavior.

Breaking Changes: Field removal/renaming, required parameter changes, response format modifications, authentication requirement changes, URL structure changes.

Integration Best Practices

Future-Proof Your Integration

  1. Version Pinning: Always specify API version in requests using X-API-Version header
  2. Graceful Degradation: Handle unknown fields and response formats gracefully
  3. Header Monitoring: Watch for deprecation and sunset headers in automated monitoring
  4. Sandbox Testing: Test against sandbox environment before production deployment
  5. Error Handling: Implement robust retry logic with exponential backoff
  6. Rate Limit Awareness: Monitor rate limit headers and implement client-side throttling
Version Header Example curl -H "X-API-Key: tk_live_abc123" \ -H "X-API-Version: 1.0" \ "https://api.thinkkits.com/schools/search?q=Lincoln"

Questions about API changes? Contact our API team at api@thinkkits.com or join our developer Discord.

← Full API Documentation · Rate Limits · Back to Platform

Was this article helpful?

← Back to Help Center