Quickstart

This guide will get you all set up and ready to use the Open Scripture API.

Before you can make requests to the Open Scripture API, you will need to create an account and generate an API Key. You can find out more about that process in API Keys.

Choose your client

Since the Open Scripture API is just a simple REST API, feel free to use any client that you feel most comfortable with to make http requests. Then it's just as simple as making the request to the specified endpoint

Making your first API request

After picking your preferred client, you are ready to make your first call to the Open Scripture API. Below, you can see how to send a GET request to the Conversations endpoint to get a list of all your conversations. In the cURL example, results are limited to ten conversations, the default page length for each client.

GET

/[baseurl]/volume/[volume_id]/[book_id]/[chapter_number]

curl -G https://openscriptureapi.org/api/scriptures/v1/lds/en/volume/bookofmormon/1nephi/1

This example uses the Chapters endpoint, you can read more about that endpoint here

What's next?

Great, now that you've made first request to the API. Here are a few links that might be handy as you venture further into the Open Scripture API:

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