API docs by Redocly

Bible SuperSearch API Documentation (6.0.4)

Download OpenAPI specification:

URL: https://aicwebtech.com/ License: GNU GPL v3.0
To install the API on your website, click here.

Query

For all queries of Bible information in our database.

query Parameters
reference
string
Default: "(none)"
Example: reference=Psalm 63:1-2

A Bible passage reference.

search
string
Default: "(none)"
Example: search=Peace

A keyword that can be found in the Bible.

request
string
Default: "(none)"
Example: request=John 3:16

Keywords or Bible passasge references. Cannot be both. If a passage, the response format looks like the reference parameter response. If a keyword, the response format looks like the search parameter response.

data_format
string
Default: "passage"

Formats the structure of the response. Parameter values can either be:

  • Passage - For more informative responses
  • Raw / minimal - For more concise responses
bible
string
Default: "kjv"

Translation of the bible. Can be a:

  • string
  • array
  • JSON encoded array
whole_words
boolean
Default: false

Sets the search and keyword parameters to search for whole words.

exact_case
boolean
Default: false

Sets the search and keyword parameters to search for exact case.

highlight
string
Default: false

Setting to true will wrap the highlight tag around the keyword.

highlight_tag
string
Default: "b"

The HTML tag used to highlight keywords.

page
string
Default: 1

The number of the page to show.

page_limit
integer
Default: 1

The results per page.

page_all
boolean
Default: false

Shows all results.

context
boolean
Default: false

Shows the verses surrounding the given verse.

context_range
integer
Default: 5

The amount of verses pulled by the context parameter.

search_type
string
Default: "and"
Example: search_type=or

The type of search when using the keyword search. The options include:

  • and or all_words - Searches for verses with the given words.
  • or or any_word - Seaches for verses mentioning at least one of the given words.
  • xor or one_word - Searches for verses with one of the given words.
  • two_or_more - Searches for verses with two or more of the given words.
keyword_limit
integer
Default: 5

Sets the minimum amount of keywords for keyword searches.

proximity_limit
integer
Default: 5

Sets the range of verses of allowable verses between keywords.

markup
string
Default: "none"

Formats the markup for Strongs numbers or red letters. The options include:

  • none - No formatting applied.
  • raw - Returns the markup as stored in the database.
    • {} = strongs numbers
    • [] = added
    • ‹› (not <>) = red letters
parallel_search_error_suppress
boolean
Default: false

The verses from this Bible have been included for comparison errors won't show.

callback
string
Default: "(none)"

Name of callback for JSONP.

Responses

Request samples 

curl "https://api.biblesupersearch.com/api?reference=Psalm+63:1-2"

Response samples

Content type
application/json
Example

Response for a reference query in a passage data_format (e.g. Psalm63:1-2).

{
  • "hash": "pgvu7cuok3",
  • "disambiguation": [ ],
  • "strongs": [ ],
  • "paging": [ ],
  • "errors": [ ],
  • "error_level": 0,
  • "results": [
    ]
}