Sign in

v1

latestOpenAPI 3.0.2GNU AGPLv32026-07-245983524.8 KB
Topic

Topic (v2)

Retrieve a specific topic from the v2 version of the topics API.

get/api/v2/topics/{topic_slug}

Query parameters

annotate_linksinteger

Values can be 1 or 0.

If 1, adds the following fields to each intra-topic link: title, titleIsTransliteration, shouldDisplay, and order.

Response

v2 Specific Topic API

slugstring required

The unique slug for a given topic.

displayOrderinteger

The order in which topics are displayed on the Sefaria website, relative to other topics within their same category.

numSourcesinteger

The number of text sources associated with a topic.

description_publishedboolean

A boolean representing whether or not the description was published.

data_sourcestring

How the topic was generated, whether by Sefaria, a user on a source sheet, or some other source.

Example response

{
  "slug": "sukkot",
  "titles": [
    {
      "text": "Tabernacles",
      "lang": "en"
    },
    {
      "text": "Succot",
      "lang": "en"
    },
    {
      "text": "Sukkos",
      "lang": "en"
    },
    {
      "text": "Succos",
      "lang": "en"
    },
    {
      "text": "Booths",
      "lang": "en"
    },
    {
      "text": "sukkot",
      "lang": "en"
    },
    {
      "text": "succot",
      "lang": "en"
    },
    {
      "text": "Succoth",
      "lang": "en"
    },
    {
      "text": "Sukkoth",
      "lang": "en"
    },
    {
      "text": "חג הסוכות",
      "lang": "he"
    },
    {
      "text": "סכות",
      "lang": "he"
    },
    {
      "text": "Sukkot",
      "lang": "en",
      "primary": true
    },
    {
      "text": "סוכות",
      "lang": "he",
      "primary": true
    }
  ],
  "alt_ids": {
    "_temp_id": "סוכות"
  },
  "properties": {
    "heNliLink": {
      "value": "https://www.nli.org.il/he/discover/judaism/holidays/sukkot",
      "dataSource": "sefaria"
    },
    "enNliLink": {
      "value": "https://www.nli.org.il/en/discover/judaism/holidays/sukkot",
      "dataSource": "sefaria"
    }
  },
  "description": {
    "en": "Sukkot is a weeklong celebration of the harvest in early fall. It is celebrated by the building of temporary booths — that is, sukkot — outside homes in which people eat their meals and sometimes even sleep. The booths are reminders of the transience of life and the sheltering presence of God.",
    "he": "חג הסוכות, הוא חג האסיף, נמשך שבעה ימים ומצוין בחודש תשרי על-ידי בניית סוכה מחוץ לבית, בה  אוכלים וחלק גם ישנים. הסוכה היא תזכורת לסוכות שבנו בני ישראל ביציאת מצרים, ומסמלת את ארעיות החיים ואת נוכחותו המגוננת של ה'"
  },
  "categoryDescription": {},
  "displayOrder": 4,
  "numSources": 831,
  "description_published": true,
  "data_source": "sefaria",
  "image": {
    "image_uri": "https://storage.googleapis.com/img.sefaria.org/topics/sukkot.jpg",
    "image_caption": {
      "en": "Detail of a painting of a sukkah. Image taken from f. 316v of Forli Siddur. 1383, Italian rite. The British Library",
      "he": "פרט ציור של סוכה עם שולחן פרוש ושלוש דמויות. דימוי מתוך סידור פורלי, 1383 איטליה"
    }
  },
  "primaryTitle": {
    "en": "Sukkot",
    "he": "סוכות"
  },
  "primaryTitleIsTransliteration": {
    "en": false,
    "he": false
  }
}