v1

latestOpenAPI 3.0.12026-07-13191560.7 KB
Search

Search a Bible

A search will attempt to match all verses with the list of keywords provided in the query string. The order of the keywords does not matter, however all listed keywords must be present in a verse for it to be considered a match.

Wildcard searches are supported, and can be used to match partial results:

WildcardDescriptionExample
*Matches any character sequence"wo*d" finds text such as "word", "world", and "worshipped"
?Matches any single character"l?ve" finds text such as "live" and "love"

The text property of each search result contains only the verse text, it does not contain footnote references or additional formatting. However, more information on a verse can be queried directly by fetching a single verse.

get/bibles/{bibleId}/search

Query parameters

querystring
Example:love,world

Comma-separated search keywords or a passage reference. Supported wildcards are * and ?. The * wildcard matches any character sequence (e.g. searching for "wo*d" finds text such as "word", "world", and "worshipped"). The ? wildcard matches any matches any single character (e.g. searching for "l?ve" finds text such as "live" and "love").

limitinteger

Limits the number of search results returned. Used with the offset parameter to paginate results.

offsetinteger

Offsets results by the given amount. Used with the limit parameter to paginate results.

sort'relevance' | 'canonical' | 'reverse-canonical'

Sorts search results

rangestring
Example:GEN.1.1-EXO.1.1

Comma-separated list of Passage IDs which the search will be limited to.

fuzziness'AUTO' | '0' | '1' | '2'

Sets the fuzziness of a search to account for misspellings. Values can be 0, 1, 2, or AUTO. Defaults to AUTO which varies depending on the

Response

OK
querystring