Ora API

RESTful API providing access to a variety of Bible-related information.

Bibles

Bibles | Get a Bible by ID

Retrieve a specific Bible version by its ID.

get 
https://orapi.onrender.com/api/v1/bible-versions/{id}?apikey={apikey}
curl -X GET "https://orapi.onrender.com/api/v1/bible-versions/10005?apikey=yourApiKey"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
id Number

The ID of the Bible version to retrieve. (Required)

Success 200

Field Type Description
bible Object

Details of the requested Bible version.
  bible_id Number

Bible ID.
  name String

Bible name.
  shortname String

Short name or abbreviation of the Bible.
  module String

Module identifier of the Bible.
  year String

Year of the Bible version.
  description String

Description of the Bible version.
  lang String

Language of the Bible.
  lang_short String

Short language code.
  copyright_statement String

Copyright statement of the Bible.
  official Number

Whether the Bible is official (1) or not (0).
  research Number

Whether the Bible is for research purposes (1) or not (0).
  module_version String

Version of the Bible module.

 
    HTTP/1.1 200 OK
    {
      "bible": {
			"bible_id": 10005,
			"name": "Albanian",
			"shortname": "Albanian",
			"module": "albanian",
			"year": "",
			"description": "This Bible imported from The Unbound Bible.",
			"lang": "",
			"lang_short": "sq",
			"copyright_statement": "This Bible is in the Public Domain.",
			"official": 1,
			"research": 1,
			"module_version": "5.0.0alpha1"
		}
   }

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.
InvalidBibleId

Invalid Bible ID provided.

404

Name Description
BibleNotFound

Bible with the specified ID not found.

500

Name Description
InternalServerError

Error fetching the Bible.

 
HTTP/1.1 400 Bad Request
{
  "error": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid API key provided."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid Bible ID provided."
}
HTTP/1.1 404 Not Found
{
  "error": "Bible not found."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error fetching the Bible."
}

Send a Sample Request

url

Parameters

json
String
Number

Bibles | Get All Bibles

Retrieve a list of all Bible versions with optional pagination.

get 
https://orapi.onrender.com/api/v1/bible-versions?apikey={apikey}&page={page}&limit={limit}
curl -X GET "https://orapi.onrender.com/api/v1/bible-versions?apikey=yourApiKey&page=1&limit=2"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
page optional Number

Page number for pagination (default: 1).

Default value: 1
limit optional Number

Number of Bible versions per page (default: 0).

Default value: 0

Success 200

Field Type Description
bibles Object[]

List of Bible versions.
  bible_id Number

Bible ID.
  name String

Bible name.
  shortname String

Short name or abbreviation of the Bible.
  module String

Module identifier of the Bible.
  year String

Year of the Bible version.
  description String

Description of the Bible version.
  lang String

Language of the Bible.
  lang_short String

Short language code.
  copyright_statement String

Copyright statement of the Bible.
  official Number

Whether the Bible is official (1) or not (0).
  research Number

Whether the Bible is for research purposes (1) or not (0).
  module_version String

Version of the Bible module.
page Number

Current page.
limit Number

Items per page.

 
HTTP/1.1 200 OK
{
  "bibles": [
    {
      "bible_id": 10000,
      "name": "Afrikaans 1953",
      "shortname": "Afrikaans",
      "module": "afri",
      "year": "1953",
      "description": "his copyright Bible has kindly been made available by the Bible Society of South Africa, strictly for non-commercial use with The SWORD Project.",
      "lang": "Afrikaans",
      "lang_short": "af",
      "copyright_statement": "This Bible is in the Public Domain.",
      "official": 1,
      "research": 0,
      "module_version": "5.0.0alpha1"
    },
    // ... (more Bible versions)
  ],
  "page": 1,
  "limit": 1
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.

500

Name Description
InternalServerError

Error fetching all Bibles.

 
HTTP/1.1 400 Bad Request
{
  "error": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid API key provided."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error fetching all Bibles."
}

Send a Sample Request

url

Parameters

json
String
Number
Number

Books

Books | Get all books

Retrieve a list of books with optional pagination.

get 
https://orapi.onrender.com/api/v1/books?apikey={apikey}&page={page}&limit={limit}
curl -X GET "https://orapi.onrender.com/api/v1/books?apikey=yourApiKey&page=1&limit=10"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
page optional Number

Page number for pagination (default: 1).

Default value: 1
limit optional Number

Number of books per page (default: 0).

Default value: 0

Success 200

Field Type Description
books Object[]

List of books.
  name String

Book name.
  abbreviation String

Book abbreviation.
  book_order Number

Book order.
  testament String

Testament (Old Testament or New Testament).
  genre String

Genre of the book.
page Number

Current page.
limit Number

Items per page.

 
HTTP/1.1 200 OK
{
  "books": [
    {
      "name": "Genesis",
      "abbreviation": "Gen",
      "book_order": 1,
      "testament": "Old Testament",
      "genre": "Pentateuch"
    },
    // ... (more books)
  ],
  "page": 1,
  "limit": 11
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.

500

Name Description
InternalServerError

Error fetching books.

 
HTTP/1.1 400 Bad Request
{
  "message": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "message": "Invalid API key provided."
}
HTTP/1.1 500 Internal Server Error
{
  "message": "Error fetching books."
}

Send a Sample Request

url

Parameters

json
String
Number
Number

Books | Get Book by Order

Retrieve a book based on the specified order.

get 
https://orapi.onrender.com/api/v1/books/order/:order?apikey={apikey}
curl -X GET "https://orapi.onrender.com/api/v1/books/order/1?apikey=yourApiKey"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
order Number

Order of the book to retrieve. (Required)
page optional Number

Page number for pagination (default: 1).

Default value: 1
limit optional Number

Number of books per page (default: 0).

Default value: 0

Success 200

Field Type Description
book Object

Details of the requested book.
  name String

Book name.
  abbreviation String

Book abbreviation.
  book_order Number

Book order.
  testament String

Testament (Old Testament or New Testament).
  genre String

Genre of the book.

 
HTTP/1.1 200 OK
{
  "book": {
    "name": "Genesis",
    "abbreviation": "Gen",
    "book_order": 1,
    "testament": "Old Testament",
    "genre": "Pentateuch"
  }
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.

404

Name Description
NoBookFound

No book found for the specified order.

500

Name Description
InternalServerError

Error fetching book by order.

 
HTTP/1.1 400 Bad Request
{
  "error": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid API key provided."
}
HTTP/1.1 404 Not Found
{
  "message": "No book found for the specified order."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error fetching book by order."
}

Send a Sample Request

url

Parameters

json
String
Number
Number
Number

Books | Get Books by Category

Retrieve a list of books based on the specified category (genre or testament)..

get 
https://orapi.onrender.com/api/v1/books/category/:category?apikey={apikey}
curl -X GET "https://orapi.onrender.com/api/v1/books/category/Pentateuch?apikey=yourApiKey"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
category String

Category to filter books by (genre or testament). (Required)
page optional Number

Page number for pagination (default: 1).

Default value: 1
limit optional Number

Number of books per page (default: 0).

Default value: 0

Success 200

Field Type Description
books Object[]

List of books.
  name String

Book name.
  abbreviation String

Book abbreviation.
  book_order Number

Book order.
  testament String

Testament (Old Testament or New Testament).
  genre String

Genre of the book.
page Number

Current page.
limit Number

Items per page.

 
HTTP/1.1 200 OK
{
  "books": [
    {
      "name": "Genesis",
      "abbreviation": "Gen",
      "book_order": 1,
      "testament": "Old Testament",
      "genre": "Pentateuch"
    },
    // ... (more books)
  ],
  "page": 1,
  "limit": 11
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.

404

Name Description
NoBooksFound

No books found for the specified category.

500

Name Description
InternalServerError

Error fetching books by category.

 
HTTP/1.1 400 Bad Request
{
  "message": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "message": "Invalid API key provided."
}
HTTP/1.1 404 Not Found
{
  "message": "No books found for the specified category."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error fetching books by category."
}

Send a Sample Request

url

Parameters

json
String
String
Number
Number

Genres

Genres | Get All Genres

Retrieve a list of all Bible genres.

get 
https://orapi.onrender.com/api/v1/genres?apikey={apikey}
curl -X GET "https://orapi.onrender.com/api/v1/genres?apikey=yourApiKey"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)

Success 200

Field Type Description
genres String[]

List of Bible genres.

 
HTTP/1.1 200 OK
{
  "genres": [
    "Pentateuch",
    "Historical",
    "Wisdom",
    "Prophets",
    "Gospels",
    "Pauline Epistles",
    "General Epistles",
    "Apocalyptic"
  ]
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.

500

Name Description
InternalServerError

Error fetching all genres.

 
HTTP/1.1 400 Bad Request
{
  "error": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid API key provided."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error fetching all genres."
}

Send a Sample Request

url

Parameters

json
String

Verses

Verses | Get a Specific Verse

Retrieve a specific verse from a book and chapter in the Bible.

get 
https://orapi.onrender.com/api/v1/bible/{bibleId}/books/{book}/chapters/{chapter}/verses/{verse}?apikey={apikey}
curl -X GET "https://orapi.onrender.com/api/v1/bible/10000/books/2/chapters/3/verses/1?apikey=yourApiKey"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
bibleId Number

The ID of the Bible version. (Required)
book Number

The ID of the book. (Required)
chapter Number

The chapter number. (Required)
verse Number

The verse number. (Required)

Success 200

Field Type Description
verse Object

Details of the specific verse.
  book_id Number

ID of the book.
  chapter Number

Chapter number.
  verse_number Number

Verse number.
  text String

Verse text.

 
HTTP/1.1 200 OK
{
  "verse": {
    "book_id": 2,
    "chapter": 3,
    "verse_number": 1,
    "text": "En Moses het die kleinvee opgepas van sy skoonvader Jetro, die priester van Mídian. En toe hy die kleinvee agter die woestyn gedryf het, kom hy by die berg van God, by Horeb."
  }
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.
InvalidBibleBookChapterVerse

Invalid Bible, book, chapter, or verse number provided.

404

Name Description
NoVerseFound

No verse found for the specified book, chapter, and verse.

500

Name Description
InternalServerError

Error fetching the specific verse.

 
HTTP/1.1 400 Bad Request
{
  "error": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid API key provided."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid Bible, book, chapter, or verse number provided."
}
HTTP/1.1 404 Not Found
{
  "error": "No verse found for the specified book, chapter, and verse."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error fetching the specific verse."
}

Send a Sample Request

url

Parameters

json
String
Number
Number
Number
Number

Verses | Get Random Verse

Retrieve a random verse from a given Bible version.

get 
https://orapi.onrender.com/api/v1/bible/{bibleId}/random-verse?apikey={apikey}
curl -X GET "https://orapi.onrender.com/api/v1/bible/10000/random-verse?apikey=yourApiKey"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
bibleId Number

The ID of the Bible version. (Required)

Success 200

Field Type Description
verse Object

Random verse.
  book_id Number

ID of the book.
  chapter Number

Chapter number.
  verse_number Number

Verse number.
  text String

Verse text.

 
HTTP/1.1 200 OK
{
  "verse": {
    "book_id": 18,
    "chapter": 22,
    "verse_number": 15,
    "text": "Wil jy die pad van die ou tyd hou, wat die kwaaddoeners bewandel het,"
  }
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.
InvalidBibleId

Invalid Bible ID provided.

404

Name Description
NoVersesFound

No verses found for the specified Bible version.

500

Name Description
InternalServerError

Error fetching a random verse.

 
HTTP/1.1 400 Bad Request
{
  "error": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid API key provided."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid Bible ID provided."
}
HTTP/1.1 404 Not Found
{
  "error": "No verses found for the specified Bible version."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error fetching a random verse."
}

Send a Sample Request

url

Parameters

json
String
Number

Verses | Get Verse of the Day

Retrieve the verse of the day from a given Bible version.

get 
https://orapi.onrender.com/api/v1/bible/{bibleId}/verse/verse-of-the-day?apikey={apikey}
curl -X GET "https://orapi.onrender.com/api/v1/bible/10015/verse/verse-of-the-day?apikey=yourApiKey"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
bibleId Number

The ID of the Bible version. (Required)

Success 200

Field Type Description
verse Object

Verse of the day.
  book_id Number

ID of the book.
  chapter Number

Chapter number.
  verse_number Number

Verse number.
  text String

Verse text.

 
HTTP/1.1 200 OK
{
  "verse": {
    "book_id": 40,
    "chapter": 16,
    "verse_number": 25,
    "text": "For whosoever would save his life shall lose it: and whosoever shall lose his life for my sake shall find it."
  }
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.
InvalidBibleId

Invalid Bible ID provided.

404

Name Description
NoVersesFound

No verses found for the specified Bible version.

500

Name Description
InternalServerError

Error fetching the verse of the day.

 
HTTP/1.1 400 Bad Request
{
  "error": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid API key provided."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid Bible ID provided."
}
HTTP/1.1 404 Not Found
{
  "error": "No verses found for the specified Bible version."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error fetching the verse of the day."
}

Send a Sample Request

url

Parameters

json
String
Number

Verses | Get Verses of a Chapter

Retrieve verses of a specific chapter in a book of the Bible.

get 
https://orapi.onrender.com/api/v1/bible/{bibleId}/books/{book}/chapters/{chapter}?apikey={apikey}
curl -X GET "https://orapi.onrender.com/api/v1/bible/10000/books/19/chapters/117?apikey=yourApiKey"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
bibleId Number

The ID of the Bible version. (Required)
book Number

The ID of the book. (Required)
chapter Number

The chapter number. (Required)

Success 200

Field Type Description
verses Object[]

List of verses in the specified chapter.
  book_id Number

ID of the book.
  chapter Number

Chapter number.
  verse_number Number

Verse number.
  text String

Verse text.

 
HTTP/1.1 200 OK
{
  "verses": [
    {
      "book_id": 19,
      "chapter": 117,
      "verse_number": 1,
      "text": "Loof die HERE, alle nasies! Prys Hom, alle volke!"
    },
    {
      "book_id": 19,
      "chapter": 117,
      "verse_number": 2,
      "text": "Want sy goedertierenheid is geweldig oor ons, en die trou van die HERE is tot in ewigheid. Halleluja!"
    }
  ]
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.
InvalidBibleBookChapter

Invalid Bible, book, or chapter number provided.

404

Name Description
NoVersesFound

No verses found for the specified chapter.

500

Name Description
InternalServerError

Error fetching chapter verses.

 
HTTP/1.1 400 Bad Request
{
  "error": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid API key provided."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid Bible, book, or chapter number provided."
}
HTTP/1.1 404 Not Found
{
  "error": "No verses found for the specified chapter."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error fetching chapter verses."
}

Send a Sample Request

url

Parameters

json
String
Number
Number
Number

Verses | Search Verses by Keyword

Retrieve verses containing a specific keyword from a given Bible version.

get 
https://orapi.onrender.com/api/v1/bible/{bibleId}/search?keyword={keyword}&apikey={apikey}&page={page}&limit={limit}
curl -X GET "https://orapi.onrender.com/api/v1/bible/10000/search?keyword=Hebreeuse&apikey=yourApiKey&page=1&limit=2"

Parameter

Field Type Description
apikey String

Your API key for authentication. (Required)
bibleId Number

The ID of the Bible version. (Required)
keyword String

The keyword to search for in verses. (Required)
page optional Number

Page number for pagination (default: 1).

Default value: 1
limit optional Number

Number of verses per page (default: 0).

Default value: 0

Success 200

Field Type Description
verses Object[]

List of verses containing the keyword.
  book_id Number

ID of the book.
  chapter Number

Chapter number.
  verse_number Number

Verse number.
  text String

Verse text.
page Number

Current page.
limit Number

Items per page.

 
HTTP/1.1 200 OK
{
  "verses": [
    {
      "book_id": 1,
      "chapter": 39,
      "verse_number": 14,
      "text": "roep sy na haar huisgenote en sê aan hulle: Kyk, hy het vir ons 'n Hebreeuse man hier gebring om met ons gek te skeer; hy het na my gekom om met my gemeenskap te hê, en ek het hard geskreeu;"
    },
    // ... (more verses)
  ],
  "page": 1,
  "limit": 2
}

400

Name Description
MissingApiKey

API key is missing in the request.
InvalidApiKey

Invalid API key provided.
InvalidBibleId

Invalid Bible ID provided.

404

Name Description
NoVersesFound

No verses found containing the specified keyword.

500

Name Description
InternalServerError

Error searching verses by keyword.

 
HTTP/1.1 400 Bad Request
{
  "error": "API key is missing in the request."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid API key provided."
}
HTTP/1.1 400 Bad Request
{
  "error": "Invalid Bible ID provided."
}
HTTP/1.1 404 Not Found
{
  "error": "No verses found containing the specified keyword."
}
HTTP/1.1 500 Internal Server Error
{
  "error": "Error searching verses by keyword."
}

Send a Sample Request

url

Parameters

json
String
Number
String
Number
Number

Generated with apidoc 1.2.0 - Wed Jan 31 2024 10:42:44 GMT-0500 (Eastern Standard Time)