Volumes
Volumes are collections of books. Each volume contains various information such as its title and the books that it contains. NOTE: Since the chapters endpoint can also return volume information associated with that chapter, you generally won't use the volumes endpoint unless you want to display the list of contained books 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 volume model
The volume model contains all of the information you need about a particular volume.
Properties
- Name
_id- Type
- string
- Description
The id of the volume
- Name
title- Type
- string
- Description
The standard use title of the volume
- Name
titleShort- Type
- string
- Description
A short, not standard name for the volume
- Name
titleOfficial- Type
- string
- Description
A longer, more verbose, name for the volume
- Name
books- Type
- array
- Description
The books contained in the volume
- Name
books[]._id- Type
- string
- Description
The id of a particular book contained in the volume
- Name
books[].title- Type
- string
- Description
A title of a particular book contained in the volume
List all volumes
This endpoint allows you to retrieve a list of all the available volumes. Note that it does not return the books contained in each volume, just a title and id of each volume. Use the /volume/[id] endpoint to get more details about a particular volume.
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 query parameters
- Name
api-key- Type
- string
- Description
The API Key associated with your account. Learn more at API Keys
Response
{
"volumes": [
{
"_id": "oldtestament",
"title": "Old Testament"
},
{
"_id": "newtestament",
"title": "New Testament"
},
{
"_id": "bookofmormon",
"title": "Book of Mormon"
},
{
"_id": "doctrineandcovenants",
"title": "Doctrine and Covenants"
},
{
"_id": "pearlofgreatprice",
"title": "Pearl of Great Price"
}
]
}
Get a volume
This endpoint returns the volume model including the volume's name and all books contained inside.
Required request attributes
- Name
id- Type
- string
- Description
The id of the volume 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": "bookofmormon",
"title": "Book of Mormon",
"titleShort": "BoM",
"titleOfficial": "The Book of Mormon",
"books": [
{
"title": "1 Nephi",
"_id": "1nephi"
},
{
"title": "2 Nephi",
"_id": "2nephi"
},
{
"title": "Jacob",
"_id": "jacob"
},
//...
{
"title": "Moroni",
"_id": "moroni"
}
]
}