The library, in your application.
Structured access to the collections. Scoped keys, transparent quotas, and privacy-conscious analytics.
Request access
Tell us what you are building. Every application is reviewed.
Receive a scoped key
An administrator verifies your request and delivers a 90-day key securely.
Build and observe
Send authenticated requests and monitor your own usage.
Make your first request
Use server-side HTTPS requests. Never expose your key in frontend code or URLs.
GET /api/v1/collections HTTP/1.1
Authorization: Bearer YOUR_API_KEY
Accept: application/jsonResponses use { data: … }. Errors use { error: { message, status } }. Pagination: page and pageSize (maximum 100; search 50). Handle 401, 403, 429, and 503; honor Retry-After. No cross-origin browser API access is enabled.
Endpoints
All corpus and analytics endpoints require an approved key.
| GET endpoint | Response | Scope |
|---|---|---|
| /api/v1/collections | List published collections | corpus:read |
| /api/v1/collections/:id/books | Books in a collection | corpus:read |
| /api/v1/collections/:id/introductions | Introductions and Muqaddimah | corpus:read |
| /api/v1/introductions/:id | Read an introduction | corpus:read |
| /api/v1/books/:id | Book and its chapters | corpus:read |
| /api/v1/chapters/:id | Paginated narrations | corpus:read |
| /api/v1/hadiths/:id | Narration, text, and provenance | corpus:read |
| /api/v1/search?q=mercy | Search English text | search:read |
| /api/v1/analytics | Your last 30 days of usage | analytics:read |
Request API access
Access is granted after review, not automatically on submission.
Your usage
Look up aggregate usage for your key. Keys cannot view another developer’s analytics.