Topic (v1)

get deprecated

https://www.sefaria.org/api/topics/{topic_slug}

When this endpoint is called with a specific topic_slug, it returns a JSON object containing the metadata for the topic.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

topic_slug

string

required

Defaults to rosh-hashanah

The slug of a topic in the Sefaria system. (To find all of the slugs, you can run api/topics without a path parameter to see the data for each topic in our database).

Query Params

with_links

integer

Input is 1 or 0. If 1, includes intra-topic links in the result field, under links.

annotate_links

integer

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

group_related

integer

Input is 1 or 0. If 1, groups link types with the groupRelated key set to true. This will simulate how the sidebar looks on the Sefaria site.

with_refs

integer

Input is 1 or 0. If 1, adds a list of Refs tagged with this topic under the refs key.

annotate_time_period

string

Input is 1 or 0. If 1, the response includes time period data under the timePeriod key.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200When this endpoint is called with a specific topic_slug, it returns a JSON object containing the metadata for the topic.