The Sefaria API

The Sefaria API allows live access to Sefaria's structured database of Jewish texts and their interconnections. It is designed to make getting a new web or mobile app up-and-running as simple as possible.

Welcome to the Sefaria API Reference.

Here you will find documentation and interactive playgrounds for many of our most important API endpoints. Our reference is powered by our OpenAPI spec, which you can seehere.

🚧

Work-In-Progress

Please note, this reference is a work-in-progress. We are always striving to refine and improve our API itself, as well as our documentation. We are looking forward to documenting additional endpoints here in the future. Looking for something you can't find?Contact us, we'd love to hear from you.

For additional documentation, check out our technical docshere.

Getting Started

There isn't much needed to get started with our API; all of our currently documented endpoints can be reached without needing any API keys, tokens or authorization.

Need a Simple Example? In thistutorial, we guide you step-by-step through a very simple script that uses a handful of our endpoints.

Looking to Dive Deep? You can jump right into our API Referencehere

Still Puzzled? - You can see whatothers have asked orcontact us for help!

API Pathways

Below are a few different pathways through the Sefaria API for individuals seeking to acquaint themselves with specific aspects of our data. Organized by use case, these entry points can assist you in navigating to the data you need as you're learning the API.

Where are the books?

At its core, Sefaria is an open-source digital library of Jewish books. To see all of the books available right now on Sefaria, see theTable of Contents. To retrieve all of the metadata related to a specific book, try out theIndex (v2) endpoint.

Ready to dive into some text data?

Start withTexts (v3) to retrieve text editions, along with all of the metadata for that given version. Dive into theVersions endpoint to see all available editions of a given book.

Links, Links, Links

One of the most powerful aspects of Sefaria's data is the links, and other relations, between various texts. To get started with seeing all of the links, check out our very powerfulRelated API. This is your ticket to retrieve related commentaries on a verse, parallel passages, and more.

Trying to build something based on a learning schedule?

Explore ourCalendars API to find data about all of the different study schedules tracked on Sefaria.

Topics

Interested in our Sefaria curation of Topics, and the associated texts? Check out theTopic Graph endpoint to retrieve interrelated topics, and theRef-Topic-Links endpoint to retrieve all of the topics associated with a given text.

Interested in Images?

Use ourSocial Media Image endpoint to generate nice graphics based on a segment of text of your choosing.

Alternatively, if you are looking for a manuscript image, see theManuscripts endpoint to retrieve correlating manuscript pages for a given text.

Need a dictionary?

Check out theLexicon endpoint andWord Completion endpoint to get started.

Building something for non-English speakers?

Use ourLanguages API to see all of the various languages on Sefaria, and queryTranslations to see all text editions available for that language. Then, head over to theTexts (v3) to query the specific text you need.

Random

Need a random text? SeeRandom Text andRandom By Topic endpoints.