Skip to main content

APIs By Runtime

Purpose: Map API families to runtimes.
Use this when: You want a yes or no answer for a specific API family.
Do not use this when: You need endpoint-specific examples.
Backend required: Often yes.
Allowed runtimes: Server and public runtimes.
Required credentials: Depends on API family.
Minimal import: @quranjs/api/server or @quranjs/api/public.

API familyserverpublic
ContentYesNo
Content hadith referencesYesNo
Content answersYesNo
SearchYesNo
User APIs with existing sessionYesYes
QuranReflect post mutationsYesYes, with an existing user session
OAuth2 authorize URLYesYes
OAuth2 code exchange for confidential clientsYesNo
OAuth2 code exchange for approved public clientsNo needYes
OAuth2 token introspectionYesNo

For the post payload shape, see QuranReflect Posts.