oremus Bible Browser

Using the oremus Bible Browser: a web API

It is possible to invoke the oremus Bible Browser (the oBB) directly by making appropriate http GET or POST requests. This page briefly lists the parameters that are supported.

Using the API

The simplest way to use the API is to construct a GET request, for example
http://bible.oremus.org/?version=NRSVAE&passage=Mark%201.1-11
It is important to note that the parameter values should be URL-encoded. In particular spaces should be encoded as %20 (although + also works). Alternatively the parameters can be set in a form and sent with a POST request.

passage

Specify the passage to be shown. The format is:

version

Specify which bible version to use. The following bible versions are supported

Additionally, some extra versions of the Psalms are included:

The version strings are treated case-insensitively.

passages

It is possible to specify passages from more than one book using this parameter. Each passage is separated by encoded line-feeds, i.e., by the encoding %0D%0A

vnum

Indicate whether to show verse and chapter numbers in the displayed text. Values are YES and NO. The default is YES.

fnote

Indicate whether to show footnote markers in the displayed text. Values are YES and NO. The default is YES.

show_ref

Indicate whether to show the passage reference or citation. Values are YES and NO. The default is YES.

headings

Indicate whether to show the section headings provided by the bible version. Values are YES and NO. The default is NO.

omithidden

Indicate whether elements (such as verse numbers) not shown are just hidden or omitted. Values are YES and NO. The default is NO (meaning they are hidden, not omitted).

semico

Indicate whether a semi-colon is identical to a comma, or whether it separates multiple ranges. Values are YES and NO. The default is NO (meaning that a semi-colon is interpreted in the same way as a comma).

search

A text string to search for. This must be URL-encoded.

short form

If all the default values are used then it is possible to use the short-form API which omits all parameters and just specifies the passage, e.g.,
http://bible.oremus.org/?Mark%201.1-11


oBB API v2 (draft) 24 October 2017


oremus Bible Browser
biblemail@oremus.org
v 2.2.7
10 February 2011

From the oremus Bible Browser http://bible.oremus.org v2.2.7 10 February 2011.