Export your school’s classes, homework, and student scores.
A Solfy school contains classes, and each class has homeworks assigned to its students. This API lets you walk that tree and extract score per student for each homework — so you can sync results into a gradebook, dashboard, or school information system. Authenticated extract calls share a quota of 60 requests per UTC minute per school.
Paste your school API key and call the live extract from this page. These requests count toward the 60/min quota.
Send the school API key as a Bearer token. The secret is shown once when a school admin creates or rotates it.
Authorization: Bearer $PUBLIC_API_KEY
Missing or invalid key returns 401 with WWW-Authenticate: Bearer.
All extract responses are wrapped as {"data": ...}.
/public/v1/school
School bound to the API key.
curl -H "Authorization: Bearer $PUBLIC_API_KEY" "$HOST/public/v1/school"
{
"data": {
"short_name": "Lycée Ada",
"full_name": "Lycée Ada Lovelace",
"school_code": "ABC123",
"url": "https://solfy.education/schools/ABC123"
}
}
/public/v1/classes
Active, non-archived classes, sorted by name.
curl -H "Authorization: Bearer $PUBLIC_API_KEY" "$HOST/public/v1/classes"
{
"data": [
{
"name": "4e A",
"description": "Solfège",
"class_code": "XYZ789",
"url": "https://solfy.education/schools/ABC123/classes/XYZ789"
}
]
}
/public/v1/classes/{class_code}/homeworks
Homeworks of a class, sorted by homework_order.
curl -H "Authorization: Bearer $PUBLIC_API_KEY" \ "$HOST/public/v1/classes/$CLASS_CODE/homeworks"
{
"data": [
{
"homework_order": 1,
"started_at": "2026-09-01T08:00:00+00:00",
"expired_at": "2026-09-08T08:00:00+00:00",
"memo": "Week 1"
}
]
}
/public/v1/classes/{class_code}/homeworks/{homework_order}/results
One average score per current student (0–100): the rounded mean
of their exercise progress on that class homework. Students with no work appear with score: 0.
curl -H "Authorization: Bearer $PUBLIC_API_KEY" \ "$HOST/public/v1/classes/$CLASS_CODE/homeworks/$HOMEWORK_ORDER/results"
{
"data": {
"homework_order": 1,
"started_at": "2026-09-01T08:00:00+00:00",
"expired_at": "2026-09-08T08:00:00+00:00",
"memo": "Week 1",
"students": [
{ "user_id": "e55d4931-fcd6-443a-9df8-06d2a1f869cb", "pseudo": "Ada", "score": 73 }
]
}
}
All authenticated /public/v1 extract routes share 60 requests per UTC minute per school. This documentation page is not counted.
| Header | Meaning |
|---|---|
RateLimit-Limit | 60 |
RateLimit-Remaining | Requests left in the current minute |
RateLimit-Reset | Unix timestamp when the window resets |
Retry-After | Seconds to wait (on 429 only) |
Errors always use this JSON format:
{
"detail": {
"message": "Invalid API key",
"domain": "public_api",
"code": 260001
}
}
| HTTP | Code | When |
|---|---|---|
| 401 | 260000 | Missing API key |
| 401 | 260001 | Invalid API key |
| 404 | 260002 | Unknown or foreign class_code |
| 404 | 260003 | Unknown homework_order |
| 429 | 260006 | Quota exceeded |