v1

latestOpenAPI 3.0.2GNU AGPLv32026-07-245983524.8 KB
Topic

All Topics

The topics API returns a list of JSON objects, with each object containing metadata for every topic in the Sefaria database. By default, responses are minified to reduce payload size. Use minify=0 to get the full topic data including images and all other fields.

get/api/topics

Query parameters

limitinteger

This parameter limits the number of topics returned. The default is 1000. If limit=0 then all topics will be returned.

minify0 | 1

When set to 1 (default), returns a minified response with only essential fields (slug, titles, primaryTitle, description, categoryDescription, displayOrder, pools, shouldDisplay). When set to 0, returns the full topic data including images and all other fields.

Response

A list of JSON objects, each object representing a topic in the Sefaria database. Please note, since this list is over 30,000 topics long, in the example we only presented the first several topics that are returned in the array. When minify=0 is specified, the full topic data is returned including images and all other fields.

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
    }
  }
]