Index

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

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

Response

Successful Request

titlestring

Title of the work.

categoriesstring[]

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.

default_structstring

Which structure of the available structures is default.

exclude_structsstring[]
orderinteger[]
enDescstring

A longer English description of the index.

enShortDescstring

A short English description of the index.

heShortDescstring

A short description of the text in Hebrew.

pubDateinteger[]

Date(s) of publication. Note: A negative value indicates the work was published BCE.

hasErrorMarginboolean

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.

compDateinteger[]

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.
compPlacestring

Location of composition

pubPlacestring

Location of publication

erastring

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_citedboolean

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.

corporastring[]

Example response

{
  "title": "Pesachim",
  "categories": [
    "Talmud",
    "Bavli",
    "Seder Moed"
  ],
  "schema": {
    "nodeType": "JaggedArrayNode",
    "depth": 2,
    "addressTypes": [
      "Talmud",
      "Integer"
    ],
    "sectionNames": [
      "Daf",
      "Line"
    ],
    "match_templates": [
      {
        "term_slugs": [
          "talmud",
          "bavli",
          "pesachim"
        ]
      },
      {
        "term_slugs": [
          "talmud",
          "bavli",
          "tractate",
          "pesachim"
        ]
      },
      {
        "term_slugs": [
          "talmud",
          "pesachim"
        ]
      },
      {
        "term_slugs": [
          "bavli",
          "pesachim"
        ]
      },
      {
        "term_slugs": [
          "gemara",
          "pesachim"
        ]
      },
      {
        "term_slugs": [
          "bavli",
          "tractate",
          "pesachim"
        ]
      },
      {
        "term_slugs": [
          "gemara",
          "tractate",
          "pesachim"
        ]
      },
      {
        "term_slugs": [
          "tractate",
          "pesachim"
        ]
      },
      {
        "term_slugs": [
          "pesachim"
        ]
      }
    ],
    "lengths": [
      242,
      3519
    ],
    "referenceableSections": [
      true,
      false
    ],
    "titles": [
      {
        "text": "Masekhet Pesachim",
        "lang": "en"
      },
      {
        "text": "Talmud Pesachim",
        "lang": "en"
      },
      {
        "text": "Tractate Pesachim",
        "lang": "en"
      },
      {
        "text": "Pesahim",
        "lang": "en"
      },
      {
        "text": "Pes.",
        "lang": "en"
      },
      {
        "text": "P’saḥim",
        "lang": "en"
      },
      {
        "text": "Pessachim",
        "lang": "en"
      },
      {
        "text": "BT Pesachim",
        "lang": "en"
      },
      {
        "text": "Psachim",
        "lang": "en"
      },
      {
        "text": "Pesaḥim ",
        "lang": "en"
      },
      {
        "text": "פסחי'",
        "lang": "he"
      },
      {
        "text": "פסחי׳",
        "lang": "he"
      },
      {
        "text": "פסחים",
        "lang": "he",
        "primary": true
      },
      {
        "text": "Pesachim",
        "lang": "en",
        "primary": true
      }
    ],
    "key": "Pesachim",
    "checkFirst": {
      "he": "משנה פסחים",
      "en": "Mishnah Pesachim"
    }
  },
  "alt_structs": {
    "Chapters": {
      "nodes": [
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 2a:1-21a:7",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-129"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "first"
              ]
            },
            {
              "term_slugs": [
                "chapter-129"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "first"
              ]
            }
          ],
          "numeric_equivalent": 1,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 1",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "אור לארבעה עשר",
              "lang": "he"
            }
          ]
        },
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 21a:8-42a:14",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-224"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "second"
              ]
            },
            {
              "term_slugs": [
                "chapter-224"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "second"
              ]
            }
          ],
          "numeric_equivalent": 2,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 2",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "כל שעה",
              "lang": "he"
            }
          ]
        },
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 42a:15-50a:22",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-324"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "third"
              ]
            },
            {
              "term_slugs": [
                "chapter-324"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "third"
              ]
            }
          ],
          "numeric_equivalent": 3,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 3",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "אלו עוברין",
              "lang": "he"
            }
          ]
        },
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 50a:23-57b:3",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-420"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "fourth"
              ]
            },
            {
              "term_slugs": [
                "chapter-420"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "fourth"
              ]
            }
          ],
          "numeric_equivalent": 4,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 4",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "מקום שנהגו",
              "lang": "he"
            }
          ]
        },
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 58a:1-65b:9",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-518"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "fifth"
              ]
            },
            {
              "term_slugs": [
                "chapter-518"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "fifth"
              ]
            }
          ],
          "numeric_equivalent": 5,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 5",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "תמיד נשחט",
              "lang": "he"
            }
          ]
        },
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 65b:10-73b:16",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-616"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "sixth"
              ]
            },
            {
              "term_slugs": [
                "chapter-616"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "sixth"
              ]
            }
          ],
          "numeric_equivalent": 6,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 6",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "אלו דברים",
              "lang": "he"
            }
          ]
        },
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 74a:1-86b:13",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-714"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "seventh"
              ]
            },
            {
              "term_slugs": [
                "chapter-714"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "seventh"
              ]
            }
          ],
          "numeric_equivalent": 7,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 7",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "כיצד צולין",
              "lang": "he"
            }
          ]
        },
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 87a:1-92b:3",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-814"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "eighth"
              ]
            },
            {
              "term_slugs": [
                "chapter-814"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "eighth"
              ]
            }
          ],
          "numeric_equivalent": 8,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 8",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "האשה",
              "lang": "he"
            }
          ]
        },
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 92b:4-99a:5",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-914"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "ninth"
              ]
            },
            {
              "term_slugs": [
                "chapter-914"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "ninth"
              ]
            }
          ],
          "numeric_equivalent": 9,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 9",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "מי שהיה טמא",
              "lang": "he"
            }
          ]
        },
        {
          "nodeType": "ArrayMapNode",
          "depth": 0,
          "wholeRef": "Pesachim 99b:1-121b:3",
          "includeSections": true,
          "match_templates": [
            {
              "term_slugs": [
                "perek",
                "chapter-109"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "perek",
                "tenth"
              ]
            },
            {
              "term_slugs": [
                "chapter-109"
              ],
              "scope": "any"
            },
            {
              "term_slugs": [
                "tenth"
              ]
            },
            {
              "term_slugs": [
                "perek",
                "last"
              ]
            },
            {
              "term_slugs": [
                "last"
              ]
            }
          ],
          "numeric_equivalent": 10,
          "titles": [
            {
              "primary": true,
              "text": "Chapter 10",
              "lang": "en"
            },
            {
              "primary": true,
              "text": "ערבי פסחים",
              "lang": "he"
            }
          ]
        }
      ]
    }
  },
  "default_struct": "Chapters",
  "exclude_structs": [
    "schema"
  ],
  "order": [
    4,
    3
  ],
  "authors": [],
  "enDesc": "Pesachim (“Passover Festivals”) is the third tractate in Seder Moed (“Festivals”). Its ten chapters discuss laws relating to Passover: the consumption of matzah (unleavened bread) and maror (bitter herbs), the prohibitions against owning or consuming chametz (leavened bread) on the festival, the paschal lamb that used to be offered at the Temple in Jerusalem, and the order of the seder (ritual feast) held on the first evening of the holiday.\n.",
  "enShortDesc": "Passover: ridding of chametz, the Paschal lamb offering, matzah, maror, and the Seder.",
  "heShortDesc": "דינים הקשורים לחג הפסח: איסור חמץ, קורבן הפסח, מצה, מרור וליל הסדר.",
  "pubDate": [
    1523
  ],
  "hasErrorMargin": true,
  "compDate": [
    450,
    550
  ],
  "compPlace": "Talmudic Babylon",
  "pubPlace": "Venice",
  "era": "A",
  "is_cited": true,
  "corpora": [
    "Bavli"
  ]
}

Changes