Skip to main content

Get the Qira'at matrix for a chapter​

Get the Qira'at matrix for a chapter: the approved junctures in the chapter with their readings and reader/transmitter attributions, paginated by juncture, together with all readers and transmitters. Unlike the by-verse matrix, readings here carry the translation but not explanations, and a chapter with no variations returns 200 with an empty junctures array. Requires the qiraat.read scope (or the parent qiraat scope); a token with only the content scope receives 403 with type: insufficient_scope. Qira'at endpoints are available in production only; they are not available in the prelive environment.

Path Parameters
    chapter_number integer required

    Possible values: >= 1 and <= 114

    Chapter (surah) number, from 1 to 114.

Query Parameters
    text_field string

    Possible values: [text_uthmani, text_imlaei, text_qpc_hafs, uthmani, imlaei, qpc_hafs]

    Default value: text_uthmani

    Script used for verse, juncture, and reading text. The text_ prefix is optional (imlaei is the same as text_imlaei). Any other value resolves to text_uthmani.

    page integer

    Possible values: >= 1

    Default value: 1

    1-based page number. Defaults to 1.

    per_page integer

    Possible values: >= 1 and <= 100

    Default value: 20

    Number of junctures per page. Defaults to 20; values above 100 are capped at 100.

    language string

    Default value: en

    Language ISO code for translated names, translations, and explanations. Defaults to en. An unknown code resolves to en. Content that is missing in a language other than en or ar falls back to English; ar does not fall back.

Responses

Successful response


Schema
    chapter object required
    id integer
    chapter_number integer
    name_simple string
    readers object[] required
  • Array [
  • id integer required
    name string required
    abbreviation string required
    position integer required
  • ]
  • transmitters object[] required
  • Array [
  • id integer required
    name string required
    abbreviation string required
    reader_id integer required
    position integer required
    is_primary boolean
  • ]
  • junctures object[] required
  • Array [
  • id integer required
    verse_key string required
    position integer required
    word_id integer nullable
    word_position integer nullable
    start_word_position integer nullable
    end_word_position integer nullable
    text string nullable
    category string nullable

    Possible values: [A, B, C]

    A meaning difference, B orthographic difference with the same meaning, C phonetic difference only.

    readings object[] required
  • Array [
  • id integer required
    text string required
    text_uthmani string
    text_imlaei string nullable
    translation string
    matrix object required

    Attribution of the reading to the readers and transmitters axes.

    readers integer[] required

    Reader identifiers attributed to the reading.

    transmitters integer[] required

    Transmitter identifiers attributed to the reading.

    cells object[] required
  • Array [
  • reader_id integer required
    transmitter_id integer nullable
    type string required

    Possible values: [reader, transmitter]

  • ]
  • ]
  • ]
  • pagination object required
    current_page integer required
    total_pages integer required
    total_count integer required
    per_page integer required
    meta object required
    language string required
    direction string required

    Possible values: [ltr, rtl]

    text_field string required
    generated_at date-time required
Loading...