getpassagetextrequest.md

GetPassageTextRequest

Example Usage

import { GetPassageTextRequest } from "esv-sdk/models/operations";

let value: GetPassageTextRequest = {
  query: "<value>",
};

Fields

Field	Type	Required	Description	Example
query	string	✔️	Bible passage reference (e.g., "John 3:16" or "43011016")
includePassageReferences	boolean	➖	Include passage references before passages	true
includeVerseNumbers	boolean	➖	Include verse numbers	true
includeFirstVerseNumbers	boolean	➖	Include the verse number for the first verse of a chapter	true
includeFootnotes	boolean	➖	Include callouts to footnotes in the text.	true
includeFootnoteBody	boolean	➖	Include footnote body content	true
includeHeadings	boolean	➖	Include passage headings	true
includeShortCopyright	boolean	➖	Include a short copyright notice	false
includeCopyright	boolean	➖	Include the full copyright notice	false
includePassageHorizontalLines	boolean	➖	Include horizontal lines between passages	false
includeHeadingHorizontalLines	boolean	➖	Include horizontal lines under headings	false
horizontalLineLength	number	➖	Length of horizontal lines	55
includeSelahs	boolean	➖	Include "Selah" in passage text	true
indentUsing	operations.IndentUsing	➖	Character to use for indentation
indentParagraphs	number	➖	Number of indentation characters for paragraphs
indentPoetry	number	➖	Number of indentation characters for poetry
indentPoetryLines	number	➖	Number of indentation characters for poetry lines
indentDeclares	number	➖	Number of indentation characters for declares
indentPsalmDoxology	number	➖	Number of indentation characters for Psalm doxology
lineLength	number	➖	Maximum line length