Passage Text Endpoint
Our passage text endpoint, located at /v3/passage/text/, provides passages from the ESV in plain text. The rendering of the text is customizable through optional parameters.
Example Request and Response
A simple request using cURL would look like this:
curl -H 'Authorization: Token YOUR_API_KEY' 'https://api.esv.org/v3/passage/text/?q=John+11:35'
You will receive a JSON response containing ESV text and metadata about the passage you requested:
{
"query": "John 11:35",
"canonical": "John 11:35",
"parsed": [
[
43011035,
43011035
]
],
"passage_meta": [
{
"canonical": "John 11:35",
"chapter_start": [
43011001,
43011057
],
"chapter_end": [
43011001,
43011057
],
"prev_verse": 43011034,
"next_verse": 43011036,
"prev_chapter": [
43010001,
43010042
],
"next_chapter": [
43012001,
43012050
]
}
],
"passages": [
"John 11:35\n\n [35] Jesus wept. (ESV)"
]
}
Required Parameters
Name:qType:
stringDefault:
''
This is the requested passage. We try our best to parse a meaningful passage reference from this value. Here are some examples of what's accepted:
John 1:1jn11.35Genesis 1-34301103501001001-01011032John1.1;Genesis1.119001001-19001006,19003001-19003008
Optional Parameters
Name:include-passage-referencesType:
booleanDefault:
true
Include the passage reference before the text.
Name:
include-verse-numbersType:
booleanDefault:
true
Include verse numbers.
Name:
include-first-verse-numbersType:
booleanDefault:
true
Include the verse number for the first verse of a chapter.
Name:
include-footnotesType:
booleanDefault:
true
Include callouts to footnotes in the text.
Name:
include-footnote-bodyType:
booleanDefault:
true
Include footnote bodies below the text. Only works if include-footnotes is also true.
Name:
include-headingsType:
booleanDefault:
true
Include section headings. For example, the section heading of Matthew 5 is "The Sermon on the Mount".
Name:
include-short-copyrightType:
booleanDefault:
true
Include "(ESV)" at the end of the text. Mutually exclusive with include-copyright. This fulfills your copyright display requirements.
Name:
include-copyrightType:
booleanDefault:
false
Include a copyright notice at the end of the text. Mutually exclusive with include-short-copyright. This fulfills your copyright display requirements.
Name:
include-passage-horizontal-linesType:
booleanDefault:
false
Include a line of equal signs (====) above the beginning of each passage.
Name:
include-heading-horizontal-linesType:
booleanDefault:
false
Include a visual line of underscores (____) above each section heading.
Name:
horizontal-line-lengthType:
integerDefault:
55
Controls the length of the line for include-passage-horizontal-lines and include-heading-horizontal-lines.
Name:
include-selahsType:
booleanDefault:
true
Include "Selah" in certain Psalms.
Name:
indent-usingType:
stringDefault:
space
Controls indentation. Must be space or tab.
Name:
indent-paragraphsType:
integerDefault:
2
Controls how many indentation characters start a paragraph.
Name:
indent-poetryType:
booleanDefault:
true
Controls indentation of poetry lines.
Name:
indent-poetry-linesType:
integerDefault:
4
Controls how many indentation characters are used per indentation level for poetry lines.
Name:
indent-declaresType:
integerDefault:
40
Controls how many indentation characters are used for "Declares the LORD" in some of the prophets.
Name:
indent-psalm-doxologyType:
integerDefault:
30
Controls how many indentation characters are used for Psalm doxologies.
Name:
line-lengthType:
integerDefault:
0
Controls how long a line can be before it is wrapped. Use 0 for unlimited line lengths.