HomeAboutDocumentationContact
Log inStart free trial
Developer docs

API
Documentation

Build with BLearner. Powerful, FERPA-compliant APIs for schools, districts, and EdTech platforms looking to integrate personalized learning.

Base URL

https://api.blearner.site/v1
AuthenticationEndpointsWebhooksRate LimitsIntegrationBest Practices
Overview

Getting started

The BLearner API allows schools and EdTech platforms to integrate personalized learning experiences into their existing systems. Access student profiles, progress data, lesson recommendations, and more.

Current version
v1.4.2
Protocol
REST / HTTPS
Response format
JSON
Authentication

API keys

All API requests require authentication using API keys. Include your key in the Authorization header on every request.

Header format
Authorization: Bearer YOUR_API_KEY

Keep your API key secure

Never share your API key publicly. If compromised, regenerate it immediately from your dashboard.

Endpoints

API endpoints

GET/student1

Retrieve a list of all students in your school or district.

Example response▼
{
  "students": [
    {
      "id": "student_123",
      "name": "Emma Johnson",
      "age": 9,
      "grade": 4,
      "learning_style": "visual",
      "subjects": ["math", "reading"]
    }
  ],
  "total": 150,
  "page": 1
}
POST/student2

Create a new student profile and enroll them in BLearner.

Example response▼
{
  "name": "Emma Johnson",
  "age": 9,
  "grade": 4,
  "email": "emma@school.edu",
  "parent_email": "parent@example.com"
}
GET/student3/{student_id}/progress

Get detailed progress and performance data for a specific student.

Example response▼
{
  "student_id": "student_123",
  "subjects": {
    "math": { "mastery": 78, "lessons_completed": 24, "hours_spent": 12.5 },
    "reading": { "mastery": 85, "lessons_completed": 18, "hours_spent": 9.2 }
  },
  "overall_progress": 82
}
GET/lessons/recommendations

Fetch AI-generated lesson recommendations tailored to a student.

Webhooks

Webhooks & events

Receive real-time notifications when important events occur in your account.

student.enrolled
lesson.completed
milestone.achieved
progress.updated
brain_report.generated
alert.triggered
Rate Limits

Rate limits

Standard
100 req/min
Professional
1,000 req/min
Enterprise
Custom limits
Rate limit headers
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1714000000
Integration

School district integration

Full district-wide integration with roster management, single sign-on, and compliance features built in.

Features

Roster sync from SIS systems
Single Sign-On (SSO) support
District-level analytics
FERPA & privacy compliance

Supported systems

PowerSchool
Infinite Campus
Skyward
Google Workspace
Microsoft 365
Aeries
Best Practices

Best practices

Use pagination for large datasets

Limit requests with page and limit parameters to improve performance.

Implement retry logic with exponential backoff

Handle temporary failures gracefully with proper retry strategies.

Cache responses appropriately

Use Cache-Control headers and ETags to reduce unnecessary requests.

Monitor rate limits and quota usage

Check rate limit headers and adjust request frequency as needed.

Need help integrating?

Our API team is ready to help with integration, troubleshooting, and custom enterprise solutions.