Free Use Bible API

Simplified chapters provide each verse's content as a single string instead of a list of formatted content items. This is useful for easier text processing. Footnotes, headings, and poetry are represented as offset ranges into this single string.

Methods:

• getSimpleTranslationBookChapter(translation, book, chapter, endpoint?)
• getSimpleCommentaryBookChapter(commentary, book, chapter, endpoint?)
• getSimpleCompleteTranslation(translation, endpoint?)
• getSimpleChapter(chapter, endpoint?): Follows a chapter's simpleChapterApiLink.
• getSimpleTranslationBookChapterWords(translation, book, chapter, endpoint?) / getSimpleChapterWords(chapter, endpoint?): Word annotations for simplified chapters.
• getSimpleWordText(verse, word) / getSimpleVerseWords(verse, words): Resolves offsets for simplified verses.
• getSimpleChapterVerseText(chapter, options?): Extracts text from a simplified chapter.

The chapter.content array is a union type of different content pieces that make up a chapter. When iterating through content, check the type field to determine how to render it.

Supported Types:

• heading: A chapter heading. Contains a content array of strings.
• line_break: A simple line break.
• verse: A Bible verse. Contains a number and a content array which can include strings, FormattedText, InlineHeading, InlineLineBreak, or VerseFootnoteReference.
• hebrew_subtitle: Informational content (e.g., subtitles in Psalms). Contains a content array of strings, FormattedText, or VerseFootnoteReference.

type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;

interface ChapterHeading {
    type: 'heading';
    content: string[];
}

interface ChapterLineBreak {
    type: 'line_break';
}

interface ChapterHebrewSubtitle {
    type: 'hebrew_subtitle';
    content: (string | FormattedText | VerseFootnoteReference)[];
}

interface ChapterVerse {
    type: 'verse';
    number: number;
    content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
}

Entity datasets (like theographic) provide metadata about people, places, events, and people groups.

Key Characteristics:

• Discovery: Entity datasets include specific links in their /api/available_datasets.json entry: listOfPeopleApiLink, listOfPlacesApiLink, listOfEventsApiLink, and listOfPeopleGroupsApiLink.
• Chapter Alignment: You can retrieve chapter-aligned entity data via /api/d/{dataset}/{book}/{chapter}.json. This returns the entities appearing in that chapter and the verse numbers where they are mentioned.
• Combining Data: Entities use standard Bible book IDs, chapter numbers, and verse numbers, allowing them to be overlaid on any translation.
• Entity References: Entities reference each other using DatasetEntityRef, which specifies a type ('people' | 'places' | 'events' | 'groups') and an id.

export interface DatasetEntityRef {
    /**
     * The ID of the entity that is being referenced.
     */
    id: string;

    /**
     * The type of the entity that is being referenced.
     * Matches the collection segment of the entity's API link,
     * so the link can be constructed as `/api/d/{dataset}/{type}/{id}.json`.
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * The name of the entity that is being referenced.
     */
    name?: string;

    /**
     * The API link for the entity that is being referenced.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * The ID of the book (GEN, EXO, etc.).
     */
    book: string;

    /**
     * The chapter number that the reference starts at.
     */
    chapter: number;

    /**
     * The verse number that the reference starts at.
     */
    verse: number;

    /**
     * The verse that the reference ends at.
     * Consecutive verses in the same chapter are collapsed into a single reference.
     */
    endVerse?: number;
}

Text within verses or subtitles can be enriched with formatting and footnotes.

FormattedText: Used to denote specific text styles. Includes:

• text: The actual string.
• poem?: A number indicating indentation level (common in Psalms).
• wordsOfJesus?: A boolean flag for the words of Jesus.

Footnotes: Footnotes are managed via ChapterFootnote objects and referenced in content using VerseFootnoteReference (which provides a noteId).

Footnote Structure:

• noteId: Unique identifier for the note.
• text: The footnote content.
• reference?: The chapter and verse this footnote applies to.
• caller: The character used to link the text to the footnote (e.g., "(a)" or "+" for autogenerated).

interface FormattedText {
    text: string;
    poem?: number;
    wordsOfJesus?: boolean;
}

interface VerseFootnoteReference {
    noteId: number;
}

interface ChapterFootnote {
    noteId: number;
    text: string;
    reference?: {
        chapter: number;
        verse: number;
    };
    caller: '+' | string | null;
}