---
title: "Index (v2)"
method: GET
path: "/api/v2/raw/index/{index_title}"
tags: ["Index"]
---

# Index (v2)

`GET /api/v2/raw/index/{index_title}`

## Request

- Base URL: `https://www.sefaria.org`
- URL: `https://www.sefaria.org/api/v2/raw/index/{index_title}`
- Auth: none declared

This API endpoint will retrieve the full mongo record of the given `Index` as it appears in the database.

## Response `200`

Successful Request

- RawIndexJSON: The full mongo record JSON from the database for a given Sefaria `Index`.
  - `title` string: Title of the work.
  - `categories` string[]: The categories within which this text falls. *Note:* The order of the strings in the array is significant. The categories should go from most general at position `0`, to most specific.
  - `schema` RawIndexSchemaJSON: Schema JSON for an Index.
    - `nodeType` 'JaggedArrayNode' | 'SchemaNode': The type of node. Nodes can either be `SchemaNodes` or `JaggedArray` nodes. A `JaggedArray` is a nested array (2D or 3D), whereas a `SchemaNode` is a node with children of either type. All tree leaves in the Sefaria text tree must be `JaggedArray` nodes.
    - `depth` integer: The depth of a text. For example, a book of Tanakh with chapters and verses has a depth 2, whereas a commentary on that book of Tanakh, with multiple comments on each verse (so a chapter-verse-comment structure) would have a depth of 3.
    - `addressTypes` string[]: A list which length reflects the depth of the text structure, with string values indicating class names for address types for each level.
    - `sectionNames` string[]: An array containing the type names of the sections of this text. The length of `sectionNames` gives the depth of the structure of this text. For example, Kohelet (`["Chapter", "Verse"]`) has depth 2, while Mishneh Torah (`["Book", "Topic", "Section", "Law"]`) has depth 4. Comparing this depth to the depth of sections will show if the request was for the lowest level, or a higher level, of the text.
    - `match_templates` unknown[]: This data is used for the linker.
      - unknown
    - `lengths` integer[]: The lengths of the text at each level of depth. For example, a text of depth 2 will have an array with two values, the first representing the number of sections, and the second value representing the number of verses. So, if Genesis has lengths, it's array will look like this `[50, 1533]`. This is interpreted to mean the Genesis Index has 50 chapters (sections) and 1533 verses (segments). A depth-3 text (a commentary, for example) will have three values, representing the number of super sections, sections, and segments.
    - `referenceableSections` boolean[]
    - `titles` TitlesJSON[]: Titles for the index.
      - `text` string: The text of the title
      - `lang` string: The language of the title, either `en` or `he`.
      - `Primary` boolean: A field depicting whether or not the title is the primary title. Note: For any given topics, one should expect two titles with this field present and set to `true`, an English and a Hebrew primary title. The English value with `primary` set to `true` will match the string value of the `primaryTitle` field on topic.
    - `key` string: Unique key for the text, usually matches the `Index` title.
    - `checkFirst` object
      - `he` string
      - `en` string
  - `alt_structs` RawIndexAltStructsJSON: The JSON returned for the alt structs of an Index.
    - `Chapters` RawIndexNodesJSON
      - `nodes` RawIndexAltStructNodeJSON[]
        - `nodeType` string: The type of node
        - `depth` integer: The depth of the Node.
        - `wholeRef` string: A string representing a citation to a Jewish text. A valid `Ref` consists of a title string followed optionally by a section string or a segment string. A title string is any one of the known text titles or title variants in the Sefaria Database.
        - `includeSections` boolean
        - `match_templates` object[]: Data used for linker purposes.
          - `term_slugs` string[]
          - `scope` string
        - `numeric_equivalent` integer: The numeric equivalent of the section. So for example, if chapter two of Masechet Pesachim is referred to as `כל שעה`, the `numeric_equivalent` is 2.
        - `titles` TitlesJSON[]: Titles for this section of text.
          - `text` string: The text of the title
          - `lang` string: The language of the title, either `en` or `he`.
          - `Primary` boolean: A field depicting whether or not the title is the primary title. Note: For any given topics, one should expect two titles with this field present and set to `true`, an English and a Hebrew primary title. The English value with `primary` set to `true` will match the string value of the `primaryTitle` field on topic.
  - `default_struct` string: Which structure of the available structures is default.
  - `exclude_structs` string[]
  - `order` integer[]
  - `authors` unknown[]: Author(s) of the text.
    - unknown
  - `enDesc` string: A longer English description of the index.
  - `enShortDesc` string: A short English description of the index.
  - `heShortDesc` string: A short description of the text in Hebrew.
  - `pubDate` integer[]: Date(s) of publication. *Note:* A negative value indicates the work was published BCE.
  - `hasErrorMargin` boolean: This field tells you if `compDate` is list of 2 integers (i.e. is a range) because much of the time `compDate` will be a range only when there's an error margin in our knowledge of the completion date.
  - `compDate` integer[]: Date(s) of text composition. **Notes:** - A negative value indicates BCE. - The integers are Gregorian years. - If it has 2 values, that is the range of years it was composed. - If has 1 value, that is the year it was composed. - If it has 0, we don’t know the year it was composed.
  - `compPlace` string: Location of composition
  - `pubPlace` string: Location of publication
  - `era` string: Era of the text. The value will be represented by one of the following codes. ``` "Gaonim": "GN", "Rishonim": "RI", "Achronim": "AH", "Tannaim": "T", "Amoraim": "A", "Contemporary": "CO" ```
  - `is_cited` boolean: Indicator of whether ot not this text is cited by others in our library. Functionally, this means we will pick up links to this text when cited in other texts.
  - `corpora` string[]

## Changes

- **2026-11-03** `753d03eda972`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sefaria/apis/sefaria-api/changes/api/v2/raw/index/:index_title/get.md)

---

[API](https://skmtc.dev/sefaria/apis/sefaria-api.md) - [All operations](https://skmtc.dev/sefaria/apis/sefaria-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sefaria/apis/sefaria-api/revisions/753d03eda972?raw)