Books
Books are collections of chapters. Each book contains various information such as its title, chapter delineation, subtitle and summary if available, and the chapters that it contains. NOTE: Since the chapters endpoint can also return book information associated with that chapter, you generally won't use the books endpoint unless you want to display the list of contained chapters to the user.
Note: For all API url examples the url given is appended to the base url. The base url will include information like the desired
API version, denomination, and language of the resource that you are requesting. If you simply append the endpoint to "openscriptureapi.org" you
will get a 404 error.
The book model
The book model contains all of the information you need about a particular book.
Properties
- Name
_id- Type
- string
- Description
The id of the book
- Name
title- Type
- string
- Description
The standard use title of the book
- Name
titleShort- Type
- string
- Description
A short generally standard name for the book
- Name
titleOfficial- Type
- string
- Description
A longer, more verbose, name for the book
- Name
subtitle- Type
- string
- Description
The subtitle of the book if it has one, or just an empty string
- Name
summary- Type
- string
- Description
The summary of the book if it has one, or just an empty string
- Name
chapterDelineation- Type
- string
- Description
How the chapters of this book should be referenced when displayed as a string
${chapterDelineation} ${chapterNumber}Generally this value will be "Chapter" but for the Doctrine and Covenants for example it will be "Section"
- Name
chapters- Type
- array
- Description
The chapters contained in the book. The chapters are in order, and thus are not numbered. It is guarenteed that the chapter number is the index + 1
- Name
chapters[]._id- Type
- string
- Description
The id of a particular chapter contained in the book
- Name
chapters[].summary- Type
- string
- Description
The summary text of a particular chapter in the book
Get a book
This endpoint returns the book model including the book's name and all books contained inside.
A particular book can also be obtained via the volume endpoint, if the volume endpoint is appended with the book id, for example: /volume/bookofmormon/1nephi
Required request attributes
- Name
id- Type
- string
- Description
The id of the book to query
Required query parameters
- Name
api-key- Type
- string
- Description
The API Key associated with your account. Learn more at API Keys
Response
{
"_id": "1nephi",
"title": "1 Nephi",
"titleShort": "1 Ne",
"titleOfficial": "THE FIRST BOOK OF NEPHI",
"subtitle": "HIS REIGN AND MINISTRY",
"summary": "An account of Lehi and his wife Sariah, and his four sons, being called, (beginning at the eldest) Laman, Lemuel, Sam, and Nephi. .... This is according to the account of Nephi; or in other words, I, Nephi, wrote this record.",
"chapterDelineation": "Chapter",
"chapters": [
{
"_id": "1nephi1",
"summary": "Nephi begins the record of his people—Lehi sees in vision a pillar of fire and reads from a book of prophecy—He praises God, foretells the coming of the Messiah, and prophesies the destruction of Jerusalem—He is persecuted by the Jews. About 600 B.C."
},
{
"_id": "1nephi2",
"summary": "Lehi takes his family into the wilderness by the Red Sea—They leave their property—Lehi offers a sacrifice to the Lord and teaches his sons to keep the commandments—Laman and Lemuel murmur against their father—Nephi is obedient and prays in faith; the Lord speaks to him, and he is chosen to rule over his brethren. About 600 B.C."
},
//...
{
"_id": "1nephi22",
"summary": "Israel will be scattered upon all the face of the earth—The Gentiles will nurse and nourish Israel with the gospel in the last days—Israel will be gathered and saved, and the wicked will burn as stubble—The kingdom of the devil will be destroyed, and Satan will be bound. About 588–570 B.C."
}
]
}