{
"errors": [], // Array of error messages, if any. If an error has occured, the API will return HTTP status code 400.
"error_level": 0, // Integer indicating error level. 0 - No error, 1 & 2 - Reserved for future use, 3 - Non-fatal error, 4 - Fatal error
"results": {} // Contains the actual data returned by the API
}
In your config.js file, set "apiUrl" to: "https://api.biblesupersearch.com"
It should look like this:
// URL of Bible SuperSearch API (string)
// Note: You can install the Bible SuperSearch API on your own server
// If you do, you will need to change this
// Default: https://api.biblesupersearch.com
"apiUrl": "https://api.biblesupersearch.com",
Now, save the file and reload the application to make sure it works.
On the admin side, navigate to "Settings", then to "Bible SuperSearch:"
Now, click on the Advanced tab:
Now, change the API URL to: https://api.biblesupersearch.com
If you've entered the URL correctly, the box will turn green. Now, click "Save Changes:"
Now, reload the application and it should be working off of this API.
Bibles Available via API | |||||||
---|---|---|---|---|---|---|---|
Module* | Language | Name | Short Name | Year | Copyrighted | Research** | Downloadable |
afri | Afrikaans | Afrikaans 1953 | Afrikaans | 1953 | No | No | Yes |
albanian | Albanian | Albanian | Albanian | No | Yes | Yes | |
am_amh | Amharic | መጽሐፍ ቅዱስ | መጽሐፍ ቅዱስ | 1962, 2003 | No | Yes | Yes |
svd | Arabic | Smith Van Dyke | SVD | No | No | Yes | |
bn_irv | Bengali | ইন্ডিয়ান রিভাইজড ভার্সন (IRV) - বেঙ্গলী | বেঙ্গলী IRV | 2018 | No | Yes | Yes |
my_judson | Burmese | မြန်မာကျမ်းစာ Judson 1840 | မြန်မာကျမ်းစာ | 1840 | No | Yes | Yes |
chinese_union_simp | Chinese | Chinese Union (Simplified) | Chinese Union (Simp) | No | Yes | Yes | |
chinese_union_trad | Chinese | Chinese Union (Traditional) | Chinese Union (Trad) | No | Yes | Yes | |
chinese_union_simp_s | Chinese | Chinese Union Version 和合本 - Simplified with Strong's numbers 简体中文版连史特朗经文滙篇 | Chinese Union Simplified with Strong's | No | Yes | Yes | |
chinese_union_trad_s | Chinese | Chinese Union Version 和合本 - Traditional with Strong's numbers 繁體中文版連史特朗經文滙篇 | Chinese Union Traditional with Strong's | No | Yes | Yes | |
ckjv_sdt | Chinese | 中文英皇欽定本上帝版 Chinese KJV (Traditional) Shang-Di 繁體中文 | CKJVSD/T | No | No | Yes | |
ckjv_sds | Chinese | 中文英皇钦定本上帝版 Chinese KJV (Simplified) Shang-Di 简体中文 | CKJVSD/S | No | No | Yes | |
bkr | Czech | Bible Kralicka | BKR | No | No | Yes | |
stve | Dutch | Staten Vertaling | Stve | No | No | Yes | |
asv | English | American Standard Version | ASV | 1901 | No | Yes | Yes |
asvs | English | American Standard Version w Strong's | ASVs | No | Yes | Yes | |
kjv | English | Authorized King James Version | KJV | 1611 / 1769 | No | No | Yes |
bishops | English | Bishops Bible | Bishops | 1568 | No | No | Yes |
coverdale | English | Coverdale Bible | Coverdale | 1535 | No | No | Yes |
geneva | English | Geneva Bible | Geneva | 1587 | No | No | Yes |
kjv_strongs | English | KJV with Strongs | KJV Strongs | 1611 / 1769 | No | No | Yes |
net | English | NET Bible® | NET | 1996-2016 | No | Yes | Yes |
tyndale | English | Tyndale Bible | Tyndale | No | No | Yes | |
web | English | World English Bible | WEB | 2006 | No | Yes | Yes |
finn | Finnish | Finnish 1776 (Finnish) | Finn | 1776 | No | No | Yes |
epee | French | La Bible de l'Épée | Epee | 2005 | No | No | Yes |
segond_1910 | French | Louis Segond 1910 | Segond 1910 | 1910 | No | Yes | Yes |
martin | French | Martin | Martin | 1744 | No | No | Yes |
oster | French | Ostervald | Oster | 1996 | No | No | Yes |
elberfelder_1871 | German | Elberfelder (1871) | Elberfelder (1871) | No | Yes | Yes | |
elberfelder_1905 | German | Elberfelder (1905) | Elberfelder (1905) | No | Yes | Yes | |
luther | German | Luther Bible | Luther | 1545 | No | No | Yes |
luther_1912 | German | Luther Bible (1912) | Luther (1912) | 1912 | No | Yes | Yes |
schlachter | German | Schlachter Bibel | Schlachter | 1951 | No | Yes | Yes |
tr | Greek | Textus Receptus NT | TR | 1550 / 1884 | No | No | Yes |
trparsed | Greek | Textus Receptus Parsed NT | TR Parsed | 1550 / 1884 | No | No | Yes |
gu_irv | Gujarati | ઇન્ડિયન રીવાઇઝ્ડ વર્ઝન (IRV) ગુજરાતી | ગુજરાતી IRV | 2019 | No | Yes | Yes |
hcv | Haitian, Haitian Creole | Haitian Creole Version | HCV | No | Yes | Yes | |
ha_con | Hausa | Biblica® Buɗaɗɗen Littafi Mai Tsarki, Sabon Rai Don Kowa™ | Buɗaɗɗen Littafi Mai Tsarki | 2020 | No | Yes | Yes |
ha_lit | Hausa | Litafi Mai-tsarki | Litafi Mai-tsarki | 2020 | No | Yes | Yes |
wlc | Hebrew | WLC | Wlc | No | No | Yes | |
he_modern | Hebrew | תנ ך עברי מודרני | תנ ך עברי מודרני | No | No | Yes | |
irv | Hindi | Indian Revised Version | IRV | 2017 / 2018 | No | Yes | Yes |
karoli | Hungarian | Karoli | Karoli | No | No | Yes | |
indo_tb | Indonesian | Terjemahan Baru | Indonesian TB | 1994 | No | Yes | Yes |
indo_tm | Indonesian | Terjemahan Lama | Indonesian TM | No | Yes | Yes | |
diodati | Italian | Diodati | Diodati | 1649 | No | No | Yes |
bungo | Japanese | Bungo-yaku: Taisho-kaiyaku (NT) (1950), Meiji-yaku (OT) (1953) | Bungo | 1950/1953 | No | Yes | Yes |
kougo | Japanese | Kougo-yaku | Kougo | 1954/1955 | No | Yes | Yes |
jv_jvn | Javanese | Kitab sutyi prejanjian anyar ing Basa Jawa Suriname sing gampang | Prajanjian Anyar ing Basa Jawa | 2009 | No | Yes | Yes |
kn_kjv | Kannada | Kannada KJV | Kannada KJV | 1969 | No | No | Yes |
kn_irv | Kannada | ಇಂಡಿಯನ್ ರಿವೈಜ್ಡ್ ವರ್ಸನ್ (IRV) - ಕನ್ನಡ | ಕನ್ನಡ IRV | 2017, 2019 | No | Yes | Yes |
korean | Korean | Korean | Korean | No | Yes | Yes | |
lv_gluck_8 | Latvian | Glück 8th edition | Glück 8th | No | No | Yes | |
lith | Lithuanian | Lithuanian Bible | Lith | No | No | No | |
lt_heritage | Lithuanian | Tikinčiųjų Paveldo Vertimas | Paveldo | 2022-2024 | No | No | Yes |
maori | Maori | Maori Bible | Maori | No | No | Yes | |
mr_irv | Marathi | इंडियन रीवाइज्ड वर्जन (IRV) - मराठी | मराठी IRV | 2017, 2019 | No | Yes | Yes |
ne_ulb | Nepali | अनलक शाब्दिक बाइबल | अनलक शाब्दिक बाइबल | 2019 | No | Yes | Yes |
opt | Persian | Old Persian Translation | OPT | 1895 | No | No | Yes |
pol_nbg | Polish | NOWEJ BIBLII GDANSKIEJ | NBG | 2012 | No | Yes | Yes |
polbg | Polish | Polska Biblia Gdanska | PolBG | 1881 | No | Yes | Yes |
pol_ubg | Polish | Uwspółcześniona Biblia Gdańska | UBG | 2017 | No | No | Yes |
blivre | Portuguese | Biblia Livre | Biblia Livre | No | Yes | Yes | |
almeida_ra | Portuguese | Tradução de João Ferreira de Almeida (Versão Revista e Atualizada) | JFA-RA | No | Yes | Yes | |
almeida_rc | Portuguese | Tradução de João Ferreira de Almeida Revista e Corrigida. | JFA-RC | No | Yes | Yes | |
pa_irv | Punjabi, Panjabi | ਇੰਡਿਅਨ ਰਿਵਾਇਜ਼ਡ ਵਰਜ਼ਨ (IRV) - ਪੰਜਾਬੀ | ਪੰਜਾਬੀ IRV | 2017, 2019 | No | Yes | Yes |
cornilescu | Romanian | Cornilescu | Cornilescu | No | No | Yes | |
fidela | Romanian | Fidela Biblia în limba română | Fidela | 2011-2016 | No | No | Yes |
synodal | Russian | Synodal | Synodal | 1876 | No | No | Yes |
so_jimale | Somali | Kitaabka Quduuska Ah Adan Jim'ale | Kitaabka Quduuska Ah | 1979, 2008 | No | Yes | Yes |
rv_1858 | Spanish | Reina Valera 1858 NT | RV 1858 | 1858 | No | No | Yes |
rv_1909 | Spanish | Reina Valera 1909 | RV 1909 | 1909 | No | No | Yes |
rvg | Spanish | Reina Valera Gómez | RVG | 2010 | Yes | No | Yes |
rv_1909_strongs | Spanish | Reina-Valera 1909 w/Strong's | RV1909 S | No | Yes | Yes | |
sagradas | Spanish | Sagradas Escrituras | Sagradas | 1569 | No | No | Yes |
swahili | Swahili | Swahili NT | Swahili NT | No | Yes | Yes | |
tagab | Tagalog | Tagalog Ang Biblia | TAB | 1905 | No | Yes | Yes |
tg_tgk | Tajik | Части Библии в таджикском языке Таджикистан | Части Библии в таджикском | 2010, 2014 | No | No | Yes |
ta_irv | Tamil | இண்டியன் ரிவைஸ்டு வெர்ஸன் | தமிழ் IRV | 2017, 2019 | No | Yes | Yes |
ta_oitce | Tamil | திறந்தநிலை தமிழ் சமகால பதிப்பு | திறந்த சமகால | 2005, 2020, 2022 | No | Yes | Yes |
te_irv | Telugu | ఇండియన్ రివైజ్డ్ వెర్షన్ (IRV) - తెలుగు | తెలుగు IRV | 2017, 2019 | No | Yes | Yes |
thaikjv | Thai | Thai KJV | Thaikjv | No | No | Yes | |
bo_ntb | Tibetan | དམ་པའི་གསུང་རབ་བོད་འགྱུར་གསར་མ། | བོད་ཡིག་གསར་པ། | 2016 - 2023 | No | Yes | Yes |
turkish | Turkish | Turkish | Turkish | No | Yes | Yes | |
ug_ara | Uighur, Uyghur | مۇقېددېس كالام (يەنگى يېزىق ) | مۇقەددەس كىتاب | 2010 | No | Yes | Yes |
ur_geo | Urdu | کتابِ مقدّس | کتابِ مقدّس | 2019 | No | Yes | Yes |
cadman | Vietnamese | Vietnamese Cadman | Cadman | 1934 | No | Yes | Yes |
wo_kyg | Wolof | Kàddug Yàlla gi | KYG | 2010, 2020 | No | Yes | Yes |
wo_wol_nt_2010 | Wolof | Téereb Injiil | Téereb Injiil | 2010 | No | Yes | Yes |
Action: | Query |
URL: | https://api.biblesupersearch.com/api |
Description: | Used for all queries against the Bibles in our database, including keyword searchs and passage retrieval. When running a query, the only requirement is that either 'reference' or 'search' are required. |
Action Parameters | ||||
---|---|---|---|---|
Parameter | Name | Type | Default | Description |
reference | Reference | String | (none) | Passage reference, such as Romans 1:1-20; Acts 2:3; 1 Cor 5:20-6:7 |
search | Search | String | (none) | Keyword search |
request | Request | String | (none) | Single field that can recieve either reference or keywords. If item resolves to a valid passage and specifies a chapter (or verse), request will be treated as a passage request; otherwise the request will be treated as a keyword search. |
bible | Bibles | String (Drop Down Menu - Multiple) |
kjv | MODULE of the Bible(s) to query against. Can be a string, array or JSON-encoded array. Use the Bibles action to get a list of available Bibles for your app or website. |
whole_words | Whole Words | Boolean | false | Whether to search for exact words. Otherwise, keywords will be found within words. |
exact_case | Exact Case | Boolean | false | Whether to search for the exact case. Searches are case-insensitive by default. |
data_format | Data Format | String | passage | Format of the outputed data structure.
|
highlight | Highlight | Boolean | false | Whether to highlight keywords in retrieved verses. Setting this to 'true' will cause highlight_tag to be wrapped around each matched keyword. |
highlight_tag | Highlight Tag | String | b | HTML tag to use for wrapping highlighted keywords. Just set to the name of the tag, omitting <> |
page | Page Number | Integer | 1 | For search results, the number of the page to show. Currently, only searches support pagination. See details below |
page_limit | Results per Page | Integer | 30 | Number of verses to display per page. |
page_all | Show All Results | Boolean | false | Whether to disable all pagination. |
context | Show in Context | Boolean | false | For a given single verse, will return the verse with verses around it. |
context_range | Context Range | Integer | 5 | Range of verses to pull when 'context' is true. |
search_type | Search Type | String (Drop Down menu) |
and | Type of search when using keyword search. Options:
|
keyword_limit | Keyword Limit | Integer | 5 | Keyword limit. For 'keyword_limit' search type, sets the minimum number of keywords. |
proximity_limit | Proximity Limit | Integer | 5 | Proximity limit. For Proximity search types, sets the range of allowable verses between keywords. |
markup | Markup Format | String | none | Format of markup for Bibles having Strongs numbers or red letter. 'none' returns no markup. 'raw' returns the markup as stored in the database: {} indicates Strongs numbers, [] indicates added words, and ‹› (not <>) indicates red letter. |
callback | Call back | String | (none) | Name of callback for JSONP, if needed |
Advanced Parameters | ||||
---|---|---|---|---|
Parameter | Name | Type | Default | Description |
search_all | Search All | String | (none) | For an advanced search form, this is the input for searching for all words. |
search_any | Search Any | String | (none) | For an advanced search form, this is the input for searching for any words. |
search_one | Search One | String | (none) | For an advanced search form, this is the input for searching for one of the words. |
search_none | Search None | String | (none) | For an advanced search form, this is the input for searching for none of the words. |
search_phrase | Search Phrase | String | (none) | For an advanced search form, this is the input for searching for an exact phrase. |
{
"errors":[],
"error_level":0,
"strongs":[], // If the search included any Strong's numbers, this array will contain the Strong's definition for each. See the "Strong's Definition" tab for details.
"paging":{
"total":338,
"per_page":30,
"current_page":1,
"last_page":12,
"from":1,
"to":30
},
"results":{
"kjv":[
{"id":"23241","book":"40","chapter":"5","verse":"6","text":"Blessed are they which do hunger and thirst after righteousness: for they shall be filled."},
{"id":"23242","book":"40","chapter":"5","verse":"7","text":"Blessed are the merciful: for they shall obtain mercy."},
{"id":"23243","book":"40","chapter":"5","verse":"8","text":"Blessed are the pure in heart: for they shall see God."},
{"id":"27932","book":"45","chapter":"1","verse":"1","text":"Paul, a servant of Jesus Christ, called to be an apostle, separated unto the gospel of God,"},
{"id":"27933","book":"45","chapter":"1","verse":"2","text":"(Which he had promised afore by his prophets in the holy scriptures,)"}
]
}
}
{
"errors":[],
"error_level":0,
"strongs":[], // If the search included any Strong's numbers, this array will contain the Strong's definition for each. See the "Strong's Definition" tab for details.
"results":[
{
"book_id":45,
"book_name":"Romans",
"book_short":"Rm",
"book_raw":"Rom", // Book name as entered by user
"chapter_verse":"1:1-2", // Standardized chapter and verse
"nav":{ ... }, // Metadata for browsing buttons, see below for details
"chapter_verse_raw":"1:1-2", // Chapter and verse as entered by user
"verse_index": { // A list of all chapters and verses retrieved.
1: [1, 2]
},
"verses":{
// Indexed by Bible (module)
"kjv":{
// Indexed by chapter
"1":{
// Indexed by verse
"1":{"id":"27932","book":"45","chapter":"1","verse":"1","text":"Paul, a servant of Jesus Christ, called to be an apostle, separated unto the gospel of God,"},
"2":{"id":"27933","book":"45","chapter":"1","verse":"2","text":"(Which he had promised afore by his prophets in the holy scriptures,)"}
}
}
},
"verses_count":2,
"single_verse":false // Indicates if the passage contains exactly one verse. Note: Searches will result in all single verse passages.
},
{
"book_id":40,
"book_name":"Matthew",
"book_short":"Mt",
"book_raw":"Matt",
"chapter_verse":"5:6-8",
"chapter_verse_raw":"5:6-8",
"nav": {ncb: 40, ncc: 6, pcb: 40, pcc: 4, ccb: 40, ccc: 5, nb: 41, pb: 39}
"verse_index": {
5: [6, 7, 8]
},
"verses":{
"kjv":{
"5":{
"6":{"id":"23241","book":"40","chapter":"5","verse":"6","text":"Blessed are they which do hunger and thirst after righteousness: for they shall be filled."},
"7":{"id":"23242","book":"40","chapter":"5","verse":"7","text":"Blessed are the merciful: for they shall obtain mercy."},
"8":{"id":"23243","book":"40","chapter":"5","verse":"8","text":"Blessed are the pure in heart: for they shall see God."}
}
}
},
"verses_count":3,
"single_verse":false
}
]
}
For multiverse ranges and chapters, this gives the book and chapter metadata for generating browsing buttons. Only available on 'passage' data structures and is not currently provided for single verses.
{
"errors":[],
"error_level":0,
"results":[
{
"book_id":40,
"book_name":"Matthew",
"book_short":"Mt",
"book_raw":"Matt",
"chapter_verse":"5:6-8",
"chapter_verse_raw":"5:6-8",
"nav": {
// Link to Next Chapter, if applicable
next_chapter: "Matthew 6", // 'reference' for next chapter link
ncb: 40, // Next chapter book: book_id of the chapter following this one
ncc: 6, // Next chapter chapter: chapter number of chapter following this one
// Link to Previous Chapter, if applicable
prev_chapter: "Matthew 4", // 'reference' for previous chapter link
pcb: 40, // Previous chapter book: book_id of the chapter preceding this one
pcc: 4, // Previous chapter chapter: chapter number of the chapter preceding this one
// Link to current chapter (if not already displaying the whole chapter)
cur_chapter: "Matthew 5", // 'reference' for current chapter link
ccb: 40, // Current chapter book: book_id of the current chapter
ccc: 5, // Current chapter chapter: chapter number of the current chapter,
// Link to the Next Book, if applicable
next_book: "Mark", // 'reference' of next book
nb: 41, // Book_id of the next book
// Link to the Previous Book, if applicable
prev_book: "Malachi" // 'reference' of previous book
pb: 39 // Book_id of the previous book
},
"verse_index": {
5: [6, 7, 8]
},
"verses":{ ... }
"verses_count":3,
"single_verse":false
}
]
}
For all searches, this provides the metadata for building pagination. (Please note, setting 'page_all' to true disables all pagination),
{
"errors":[],
"error_level":0,
"paging":{
"total":338, // Total number of results
"per_page":30, // Results per page
"current_page":1, // Current page number
"last_page":12, // Total number of pages
"from":61, // First displaying result Example: 'Now displaying results 61 to 90'
"to":90 // Last displaying result
},
"results":[ ... ]
}
Action: | Statics |
URL: | https://api.biblesupersearch.com/api/statics |
Description: | Single API action to retrieve basic information needed to use the API. This includes:
|
Action Parameters | ||||
---|---|---|---|---|
Parameter | Name | Type | Default | Description |
language | Language | String | en | 2 Character ISO 639‑1 language code |
callback | Call back | String | (none) | Name of callback for JSONP, if needed |
{
"errors": [],
"error_level": 0,
"results": {
"bibles": { ... }, // See Bibles Action
"books": [ ... ], // See Books Action
"search_types": [ ... ],
"shortcuts": [ ... ],
"download_formats": [ ... ],
"name": "Bible SuperSearch API",
"version": "5.6.1",
"environment": "production",
}
}
Action: | Bibles |
URL: | https://api.biblesupersearch.com/api/bibles |
Description: | Retrieves the list of Bibles avaliable via the API |
Action Parameters | ||||
---|---|---|---|---|
Parameter | Name | Type | Default | Description |
callback | Call back | String | (none) | Name of callback for JSONP, if needed |
{
"errors":[],
"error_level":0,
"results":{
// Indexed by 'module'
"kjv":{
"name":"Authorized King James Version",
"shortname":"KJV",
"module":"kjv", // The 'module' is what the API uses to identify the Bible for queries.
"year":"1611 \/ 1769", // Publication year
"lang":"English",
"lang_short":"en",
"copyright":"0", // Copyrighted (not public domain)
"italics":"1", // (Future use) Supports Italicised words
"strongs":"0", // (Future use) Embedded strongs numbers
"rank":"10", // Default sorting order.
"research":"0" // Indicates a Bible text intended for research purposes only.
},
"geneva":{
"name":"Geneva Bible",
"shortname":"Geneva",
"module":"geneva",
"year":"1587",
"lang":"English",
"lang_short":"en",
"copyright":"0",
"italics":"0",
"strongs":"0",
"rank":"60",
"research":"0"
},
"tr":{
"name":"Textus Receptus NT",
"shortname":"TR","
"module":"tr",
"year":"1550 \/ 1884",
"lang":"Greek",
"lang_short":"el","
copyright":"0",
"italics":"0",
"strongs":"0",
"rank":"70",
"research":"0"
},
"wlc":{
"name":"WLC",
"shortname":"Wlc",
"module":"wlc",
"year":"",
"lang":"Hebrew",
"lang_short":"he",
"copyright":"0",
"italics":"0",
"strongs":"0",
"rank":"300",
"research":"1"
}
}
}
Action: | Books |
URL: | https://api.biblesupersearch.com/api/books |
Description: | Retrieves a list of Bible Books in the specified language |
Action Parameters | ||||
---|---|---|---|---|
Parameter | Name | Type | Default | Description |
language | Language | String | en | 2 Character ISO 639‑1 language code |
callback | Call back | String | (none) | Name of callback for JSONP, if needed |
{
"errors":[],
"error_level":0,
"results":[
{"id":1,"name":"Genesis","shortname":"Gen"},
{"id":2,"name":"Exodus","shortname":"Ex"},
....
{"id":65,"name":"Jude","shortname":"Jude"},
{"id":66,"name":"Revelation","shortname":"Rev"}
]
}
Action: | Strong's Definitions |
URL: | https://api.biblesupersearch.com/api/strongs |
Description: | Retrieves definitions for the given Strong's numbers. |
Action Parameters | ||||
---|---|---|---|---|
Parameter | Name | Type | Default | Description |
strongs | Strong's Number(s) | String | (none) | Retrieve Strong's definitions for the given Strong's numbers. Can be a single string, a comma-separated string or a JSON-encoded array |
callback | Call back | String | (none) | Name of callback for JSONP, if needed |
{
"errors":[],
"error_level":0,
"results":[
// Definition record, "tvm" will be empty.
{
"id":11398,
"number":"G2545",
"root_word":"καίω",
"transliteration":"kaiō",
"pronunciation":"kah'-yo",
"tvm":"",
"entry":"Apparently a primary verb; to <i>set on fire<\/i>, that is, <i>kindle<\/i> or (by implication) <i>consume:<\/i> - burn, light."
},
// TVM record, "tvm" will be populated, and other items will be empty.
{
"id":14471,
"number":"G5719",
"root_word":null,
"transliteration":null,
"pronunciation":null,
"tvm":"<b>Tense:<\/b> Present, See G5774 <br><b>Voice:<\/b> Active, See G5784 <br><b>Mood:<\/b> Indicative, See G5791 <br>\n",
"entry":null
}
]
}
Action: | Version |
URL: | https://api.biblesupersearch.com/api/version |
Description: | Retrieves basic version information about the API. This includes:
|
Action Parameters | ||||
---|---|---|---|---|
Parameter | Name | Type | Default | Description |
callback | Call back | String | (none) | Name of callback for JSONP, if needed |
{
"errors": [],
"error_level": 0,
"results": {
"name": "Bible SuperSearch API",
"version": "5.6.1",
"environment": "production",
}
}
Action: | Bible Download |
URL: | https://api.biblesupersearch.com/api/download |
Description: | Returns the given Bible module(s) as a file download, rendered into the selected format |
Action Parameters | ||||
---|---|---|---|---|
Parameter | Name | Type | Default | Description |
bible | Bibles | String - multiple | (none) | (required) MODULE of the Bible(s) to download. Can be a string, array or JSON-encoded array. Set to ALL to get all downloadable Bibles |
format | Format | String - multiple | (none) | (required) Format of the Bibles to download. Can be a string, array or JSON-encoded array. See list of options below. |
zip | ZIP | Boolean | FALSE | If specified, forces a ZIP file download when one Bible or format is selected. Note: Selecting multiple Bibles or formats automatially returns a ZIP file, and this parameter is ignored |
Ready-to-print PDF files | ||
---|---|---|
Identifier | Name | Description |
pdf_cpt_let | Compact Text, Letter, Words of Christ in Red | |
pdf_cpt_a4 | Compact Text, A4, Words of Christ in Red | |
pdf_cpt_let_ul | Compact Text, Letter, Words of Christ Underlined | Monochrome friendly. |
pdf_cpt_a4_ul | Compact Text, A4, Words of Christ Underlined | Monochrome friendly. |
Plain Text | ||
---|---|---|
Identifier | Name | Description |
text | Plain Text | Simple, plain text format |
mr_text | Machine-readable Plain Text |
Spreadsheet | Opens in MS Excel or other spreadsheet software. Both human and machine readable. | |
---|---|---|
Identifier | Name | Description |
csv | CSV | Comma separated values. UTF-8 encoding. |
xlsx | Excel | 2007-365 (.xlsx) |
Databases | Databases and database dumps. Ready to import into your own software. | |
---|---|---|
Identifier | Name | Description |
json | JSON | JavaScript Object Notation |
sqlite3 | SQLite | SQLite 3 database |
mysql | MySQL | MySQL Database Dump |
biblesupersearch | Bible SuperSearch | Official Bible SuperSearch format. |
By using the Bible SuperSearch API ("service", "API"), you agree to the terms of this agreement between yourself ("customer") and Preserved Word Ministries ("we", "our", "us") (Bible SuperSearch is a ministry of Preserved Word Ministries).
We reserve the right to limit access to the service. We reserve the right to discontinue the service at any time.
The Bible SuperSearch API and client software are licensed for NON-COMMERCIAL usage ONLY. Any commercial usage requires our prior expressed written permission.
While we offer free access to the API, support will require the the purchase of a support license. We can only offer support for the API located at https://api.biblesupersearch.com. We are unable to provide support for any of our sandbox APIs, nor for instances of our API hosted by a third party. While the code for this API is Open Source and can be downloaded and installed from our GIT repository, we cannot provide support for this at this time.
All sales are final on support licenses, software, and software enhancements.
This service is made available in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
In no event shall Preserved Word Ministries, nor any of its officers, directors and employees, be liable to you for anything arising out of or in any way connected with your use of this service, whether such liability is under contract, tort or otherwise, and Preserved Word Ministries, including its officers, directors and employees shall not be liable for any indirect, consequential or special liability arising out of or in any way related to your use of this service.
You hereby indemnify to the fullest extent Preserved Word Ministries from and against any and all liabilities, costs, demands, causes of action, damages and expenses (including reasonable attorney’s fees) arising out of or in any way related to your breach of any of the provisions of these Terms.
We reserve the right to terminate a customer's access to the service for any usage we deem to be an abuse, including but not limited to the following:
If any provision of these Terms is found to be unenforceable or invalid under any applicable law, such unenforceability or invalidity shall not render these Terms unenforceable or invalid as a whole, and such provisions shall be deleted without affecting the remaining provisions herein.
Preserved Word Ministries is permitted to revise these Terms at any time as it sees fit, and by using this service you are expected to review such Terms on a regular basis to ensure you understand all terms and conditions governing use of this service.
This agreement shall be governed pursuant to the laws of the state of Michigan.
Preserved Word Ministries ("we") value your ("customer") privacy and the privacy of the visitors to your website ("end users").
We track the number of times a customer's website accesses the API for each day, to prevent over-usage.
We understand that end users may be looking for personal and sensitive information while using our Bible search engine API. Therefore, the API does not store any user-identifiable data on end users. We do store anonymous form data; this is used solely to generate short URLs. (These short URLs are needed to enhance the user's experience, including the ability to share a link to a search, and allow the browser's back / forward buttons to work as expected, even within the context of a JavaScript application such as our client software. )
The API does not collect or store credit card data or other sensitive information. All official client software transmit form data to the API via HTTPS.
If you have any questions or concerns, please contact us at https://www.biblesupersearch.com/contact/