Chapters

Each chapter contains various information such as its title, number, summary, and the verses that it contains. Optionally the volume and book information can also be obtained and returned as well along with the chapter info, this way you don't have to make as many API calls to get the book and volume information. Additionally, the verses can also include footnote and other meta data as well if requested.

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 chapter model

The chapter model contains all of the information you need about a particular chapter.

Properties

Name
_id
Type
string
Description
The id of the chapter
Name
nextChapterId
Type
string
Description
The id of the next chapter, or an empty string if there is no next chapter. Note that this works accross books and volumes, so the next chapter for Revelation 22 will be 1 Nephi 1
Name
prevChapterId
Type
string
Description
The id of the previous chapter, or an empty string if there is no previous chapter. Note that this works accross books and volumes, so the previous chapter for 1 Nephi 1 will be Revelation 22
Name
volume
Type
object
Description
Basic volume information if requested in the API Call
Name
volume._id
Type
string
Description
The id of the volume
Name
volume.title
Type
string
Description
The standard use title of the volume
Name
volume.titleShort
Type
string
Description
A short, not standard name for the volume
Name
volume.titleOfficial
Type
string
Description
A longer, more verbose, name for the volume
Name
book
Type
object
Description
Basic book information if requested in the API Call. Note that the book object does not contain the book's title, as the chapter object will always contain the book's title
Name
book._id
Type
string
Description
The id of the book
Name
book.titleShort
Type
string
Description
A short generally standard name for the book
Name
book.titleOfficial
Type
string
Description
A longer, more verbose, name for the book
Name
book.subtitle
Type
string
Description
The subtitle of the book if it has one, or just an empty string
Name
book.summary
Type
string
Description
The summary of the book if it has one, or just an empty string
Name
chapter
Type
object
Description
The chapter object will always be returned for this call and contains the meat of what is in the chapter
Name
chapter.bookTitle
Type
string
Description
The standard use title of the book within which this chapter is contained
Name
chapter.delineation
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
chapter.number
Type
integer
Description
The chapter number of this chapter within its parent book
Name
chapter.summary
Type
string
Description
The chapter summary
Name
chapter.chapterAugmentations
Type
array
Description
Augmentations to the chapter, for example adding an additional subtitle, or other information. Generally this information is not pertinant to the text. Must be requested specifically.
Name
chapter.verses
Type
array
Description
The veres contained in this chapter. The verses are guarenteed to be in order, and it is guarenteed that the verse number is the index + 1
Name
chapter.verses[].text
Type
text
Description
The literal plaintext of the verse
Name
chapter.verses[].footNotes
Type
text
Description
Any footnotes associated with the verse. Must be requested specifically
Name
chapter.verses[].italics
Type
text
Description
Any italics information associated with the verse. Must be requested specifically
Name
chapter.verses[].associatedContent
Type
text
Description
Any associated content attached to the verse. Must be requested specifically

GET/chapter/[id] OR /book/[book_id]/[chapter_number] OR /volume/[volume_id]/[book_id]/[chapter_number]

Get a chapter

This endpoint returns the chapter model.

A particular chapter can also be obtained via the book endpoint, if the book endpoint is appended with the chapter number, for example: /book/1nephi/1

A particular chapter can also be obtained via the volume endpoint, if the volume endpoint is appended with the book id and chapter number, for example: /volume/bookofmormon/1nephi/1

Required request attributes

Name
id
Type
string
Description
The id of the chapter to query

Required query parameters

Name
api-key
Type
string
Description
The API Key associated with your account. Learn more at API Keys

Optional body parameters

Name
includeExtras
Type
object
Description
An optional json object which includes which extra information should be returned with the request
Name
includeExtras.volumeInfo
Type
boolean
Description
Default is false. Whether or not to include the volume object with the response.
Name
includeExtras.bookInfo
Type
boolean
Description
Default is false. Whether or not to include the book object with the response.
Name
includeExtras.chapterAugmentations
Type
boolean
Description
Default is false. Whether or not to include the chapterAugmentations object with the response
Name
includeExtras.footnotes
Type
boolean
Description
Default is false. Whether or not to include the footnotes with each verse
Name
includeExtras.associatedContent
Type
boolean
Description
Default is false. Whether or not to include the associatedContent with each verse
Name
includeExtras.verseItalics
Type
boolean
Description
Default is false. Whether or not to include the italics object with each verse

Response with all body parameters selected

{
  "_id": "1nephi1",
  "nextChapterId": "1nephi2",
  "prevChapterId": "revelation22",
  "volume": {
    "title": "Book of Mormon",
    "titleShort": "BoM",
    "titleOfficial": "The Book of Mormon",
    "_id": "bookofmormon"
  },
  "book": {
    "title": "1 Nephi",
    "titleShort": "1 Ne",
    "titleOfficial": "THE FIRST BOOK OF NEPHI",
    "subtitle": "HIS REIGN AND MINISTRY",
    "summary": "An account of Lehi an ..., I, Nephi, wrote this record.",
    "_id": "1nephi"
  },
  "chapter": {
    "bookTitle": "1 Nephi",
    "delineation": "Chapter",
    "number": 1,
    "summary": "Nephi begins the record of ... He is persecuted by the Jews. About 600 B.C.",
    "chapterAugmentations": [],
    "verses": [
      {
        "text": "I, Nephi, having been born of goodly parents, ...  in my days.",
        "footNotes": [],
        "italics": [],
        "associatedContent": []
      },
      {
        "text": "Yea, I make a record in the language of my father, which consists of the learning of the Jews and the language of the Egyptians.",
        "footNotes": [],
        "italics": [],
        "associatedContent": []
      },
        // ...
      {
        "text": "And when the Jews ... of deliverance.",
        "footNotes": [],
        "italics": [],
        "associatedContent": []
      }
    ]
  }
}

Response with no body parameters selected

{
  "_id": "1nephi1",
  "nextChapterId": "1nephi2",
  "prevChapterId": "revelation22",
  "chapter": {
    "bookTitle": "1 Nephi",
    "delineation": "Chapter",
    "number": 1,
    "summary": "Nephi begins the record of ... He is persecuted by the Jews. About 600 B.C.",
    "verses": [
      {
        "text": "I, Nephi, having been born of goodly parents, ...  in my days.",
      },
      {
        "text": "Yea, I make a record in the language of my father, which consists of the learning of the Jews and the language of the Egyptians.",
      },
        // ...
      {
        "text": "And when the Jews ... of deliverance.",
      }
    ]
  }
}

Note: the Open Scripture API is still in beta, and these resources/endpoints can change at any time