Provides data about Bible versions and their content. Use these endpoints to get passage text, as well as metadata about available Bibles and their structure.
Get a Bible collection
Retrieves a paginated list of Bible versions available. When multiple language_ranges parameters are specified, the set of Bibles returned will be from the first language range which has available Bibles.
query Parameters
language_ranges[]An ordered list of language ranges using bracket notation. Use repeated parameters like language_ranges[]=en&language_ranges[]=es to supply multiple ranges, and use the wildcard * to match all languages. A language range is much like a language tag but may contain wildcards. See RFC 4647 section 2 for the full definition: https://www.rfc-editor.org/rfc/rfc4647.html#section-2
Language ranges in this parameter may only be of the Basic Range format.
all_availableThis parameter is used on some collections to modify the resources returned. For example, it modifies whether all Bibles in the Platform should be included in the Bibles collection regardless of licensing of the provided app key. It modified the Licenses collection so that the response will include every license, regardless of whether the developer has agreed to it yet. The default for this field in all cases is false. If a developer wants to include all resources for a collection that implements this query parameter, the client must specifically pass it as true.
license_idFilter Bibles by a license identifier
page_sizeThe number of items to return in the collection. Numeric values must be between 1 and 100.
Special value "" is supported only when used in combination with the fields parameter and
when the client requests three or fewer fields (see fields parameter). When "" is used the
server will return all matching items for the requested resource (no numeric page limit).
fields[]A list of top-level fields to include in each resource object. Use bracket notation to pass
multiple values, for example: fields[]=id&fields[]=name&fields[]=language.
When provided, page_size=* is allowed only if the number of fields requested is three (3) or fewer.
page_tokenThe page token to retrieve results from.
Get a Bible collection › Responses
Indicates that the request was successful. Returns a JSON array of Bible resources in the response body, each containing metadata about a specific translation.
next_page_tokenToken to send to server when retrieving the next page of results.
total_sizeTotal number of bibles in collection matching parameters.
Get a Bible's data
Get a Bible resource for a single Bible version. This does not include the Bible's text content; use the Passages endpoint for that.
path Parameters
bible_id_pathThe Bible version identifier
Get a Bible's data › Responses
Indicates that the Bible resource was found and returned successfully. The response body contains a JSON object describing the requested translation in detail.
idBible version identifier
abbreviationBible version abbreviation
promotional_contentLonger form of copyright text provided by the publisher for the given Bible version.
copyrightShort version of the copyright text provided by the publisher for the given Bible version.
infoAdditional information about the Bible text version. This is commonly displayed in the reader footer for the Bible.
publisher_urlURL to link to publisher page from the reader's footer
language_tagBCP47 canonical language tag for this Bible version
localized_abbreviationLocalized Bible version abbreviation
localized_titleLocalized title of Bible version
titleEnglish title of Bible version
booksyouversion_deep_linkA deep link to this Bible version inside YouVersion
organization_idGet the index for a Bible
Retrieves the indexing structure for the specified Bible version. This includes the full hierarchy of books, chapters, and verse counts.
path Parameters
bible_id_pathThe Bible version identifier
Get the index for a Bible › Responses
The index resource was returned successfully. You will receive a JSON object detailing the organization of books, chapters, and verse counts for the requested Bible version.
text_directionGet a passage of Bible text
Returns the specified scripture passage in the requested format. You may include headings and notes in the output based on query parameters. The response includes content text and metadata such as verse ranges and formatting details.
path Parameters
passage_id_pathThe passage identifier (verse or chapter USFM format)
bible_id_pathThe Bible version identifier
query Parameters
formatThe desired Bible content format (text or html)
include_headingsWhether or not headings should be included in the Bible content. The default for this field is false unless the reference is a chapter or introduction (GEN.1 or GEN.INTRO1) in which case it would be true.
include_notesWhether or not notes should be included in the Bible content. The default for this field is false unless the reference is a chapter or introduction (GEN.1 or GEN.INTRO1) in which case it would be true.
Get a passage of Bible text › Responses
The passage was retrieved successfully in the desired format. The response body contains a JSON object with verse text, optional headings and notes, and formatting metadata.
idA canonical representation of the passage returned
contentThe Bible text of the requested passage in either text or html format.
referenceA human-readable reference
Get a Book collection for a Bible
Retrieves the list of books (e.g. Genesis, Exodus) for the specified Bible version.
path Parameters
bible_id_pathThe Bible version identifier
query Parameters
canonThe Canon to filter results by
Get a Book collection for a Bible › Responses
The collection of books was returned successfully. The JSON array in the response body details book identifiers, names, and order within the Bible version.
Get a Book's data
Get a Book resource. This does not include the text content; use the Passages endpoint for that.
path Parameters
bible_id_pathThe Bible version identifier
book_idThe Bible Book identifier which is commonly the first 3 characters of the USFM reference
Get a Book's data › Responses
Successful request
idBook identifier
titleBook title
full_titleFull book title if available
abbreviationBook name abbreviation if provided by the publisher
canonCanon identifier
Chapters in the book
introGet a Chapter collection for a Book
Get a collection of Chapters for the given Bible and Book
path Parameters
bible_id_pathThe Bible version identifier
book_idThe Bible Book identifier which is commonly the first 3 characters of the USFM reference
Get a Chapter collection for a Book › Responses
Successful request
Get a Chapter's data
Get a Chapter resource. This does not include the text content; use the Passages endpoint for that.
path Parameters
bible_id_pathThe Bible version identifier
book_idThe Bible Book identifier which is commonly the first 3 characters of the USFM reference
chapter_idThe Bible Chapter identifier which is part of the USFM reference.
Get a Chapter's data › Responses
Successful request
idChapter identifier
passage_idPassage identifier
titleChapter title
Verses in the chapter
Get a Verse collection for a Chapter
Get a collection of Verses for a Chapter.
path Parameters
bible_id_pathThe Bible version identifier
book_idThe Bible Book identifier which is commonly the first 3 characters of the USFM reference
chapter_idThe Bible Chapter identifier which is part of the USFM reference.
Get a Verse collection for a Chapter › Responses
Successful request
Get a Verse's data
Get a Verse resource. This does not include the text content; use the Passages endpoint for that.
path Parameters
bible_id_pathThe Bible version identifier
book_idThe Bible Book identifier which is commonly the first 3 characters of the USFM reference
chapter_idThe Bible Chapter identifier which is part of the USFM reference.
verse_idThe Bible Verse identifier pulled from part of the USFM reference
Get a Verse's data › Responses
Successful request
idVerse identifier
passage_idPassage identifier
titleVerse title