Bible SuperSearch API Documentation

Data Format Examples:

Reference: 'Rom 1:1-2; Matt 5:6-8'

'minimal' Data Structure:

{
    "errors":[],
    "error_level":0,
    "strongs":[], // If the search included any Strong's numbers, this array will contain the Strong's definition for each. See the "Strong's Definition" tab for details.
    "cross_references" : {
        45_3_16: {
            "from_book":43,
            "from_chapter":3,
            "from_verse":16,
            "cross_references":[
                {
                    "to_book":45,
                    "to_chapter_start":10,
                    "to_verse_start":9,
                    "to_chapter_end":10,
                    "to_verse_end":10,
                    "votes":434
                },
                {
                    "to_book":62,
                    "to_chapter_start":4,
                    "to_verse_start":9,
                    "to_chapter_end":4,
                    "to_verse_end":10,
                    "votes":263
                }
                ...
            ]
        }
    ],
    "paging":{
        "total":338,
        "per_page":30,
        "current_page":1,
        "last_page":12,
        "from":1,
        "to":30
    },
    "results":{
        "kjv":[
            {"id":"23241","book":"40","chapter":"5","verse":"6","text":"Blessed are they which do hunger and thirst after righteousness: for they shall be filled."},
            {"id":"23242","book":"40","chapter":"5","verse":"7","text":"Blessed are the merciful: for they shall obtain mercy."},
            {"id":"23243","book":"40","chapter":"5","verse":"8","text":"Blessed are the pure in heart: for they shall see God."},
            {"id":"27932","book":"45","chapter":"1","verse":"1","text":"Paul, a servant of Jesus Christ, called to be an apostle, separated unto the gospel of God,"},
            {"id":"27933","book":"45","chapter":"1","verse":"2","text":"(Which he had promised afore by his prophets in the holy scriptures,)"}
        ]
    }
}

'passage' Data Structure:

{
    "errors":[],
    "error_level":0,
    "strongs":[], // If the search included any Strong's numbers, this array will contain the Strong's definition for each. See the "Strong's Definition" tab for details.
    "results":[
        {
            "book_id":45,
            "book_name":"Romans",
            "book_short":"Rm",
            "book_raw":"Rom",            // Book name as entered by user
            "chapter_verse":"1:1-2",     // Standardized chapter and verse
            "nav":{ ... },               // Metadata for browsing buttons, see below for details
            "chapter_verse_raw":"1:1-2", // Chapter and verse as entered by user
            "verse_index": {             // A list of all chapters and verses retrieved.
                1: [1, 2]
            },
            "verses":{
                // Indexed by Bible (module)
                "kjv":{
                    // Indexed by chapter
                    "1":{
                        // Indexed by verse
                        "1":{"id":"27932","book":"45","chapter":"1","verse":"1","text":"Paul, a servant of Jesus Christ, called to be an apostle, separated unto the gospel of God,"},
                        "2":{"id":"27933","book":"45","chapter":"1","verse":"2","text":"(Which he had promised afore by his prophets in the holy scriptures,)"}
                    }
                }
            },
            "verses_count":2,
            "single_verse":false  // Indicates if the passage contains exactly one verse.  Note: Searches will result in all single verse passages.
        },
        {
            "book_id":40,
            "book_name":"Matthew",
            "book_short":"Mt",
            "book_raw":"Matt",
            "chapter_verse":"5:6-8",
            "chapter_verse_raw":"5:6-8",
            "nav": {ncb: 40, ncc: 6, pcb: 40, pcc: 4, ccb: 40, ccc: 5, nb: 41, pb: 39}
            "verse_index": {
                5: [6, 7, 8]
            },
            "verses":{
                "kjv":{
                    "5":{
                        "6":{"id":"23241","book":"40","chapter":"5","verse":"6","text":"Blessed are they which do hunger and thirst after righteousness: for they shall be filled."},
                        "7":{"id":"23242","book":"40","chapter":"5","verse":"7","text":"Blessed are the merciful: for they shall obtain mercy."},
                        "8":{"id":"23243","book":"40","chapter":"5","verse":"8","text":"Blessed are the pure in heart: for they shall see God."}
                    }
                }
            },
            "verses_count":3,
            "single_verse":false
        }
    ]
}

'cross_references' metadata (when cross_references=true):

{
    "cross_references": {
        "43_3_16": {
            "from_book":43,          // Source verse book_id
            "from_chapter":3,        // Source verse chapter
            "from_verse":16,         // Source verse verse
            "cross_references":[
                {
                    "to_book":45,          // Destination book_id
                    "to_chapter_start":10, // Destination start chapter
                    "to_verse_start":9,    // Destination start verse
                    "to_chapter_end":10,   // Destination end chapter
                    "to_verse_end":10,     // Destination end verse
                    "votes":434            // Relative rank / vote count
                }
            ]
        }
    }
}

Navigation

Book Browsing

For multiverse ranges and chapters, this gives the book and chapter metadata for generating browsing buttons. Only available on 'passage' data structures and is not currently provided for single verses.

{
    "errors":[],
    "error_level":0,
    "results":[
        {
            "book_id":40,
            "book_name":"Matthew",
            "book_short":"Mt",
            "book_raw":"Matt",
            "chapter_verse":"5:6-8",
            "chapter_verse_raw":"5:6-8",
            "nav": {
                // Link to Next Chapter, if applicable
                next_chapter: "Matthew 6",  // 'reference' for next chapter link
                ncb: 40,    // Next chapter book: book_id of the chapter following this one
                ncc: 6,     // Next chapter chapter: chapter number of chapter following this one

                // Link to Previous Chapter, if applicable
                prev_chapter: "Matthew 4",  // 'reference' for previous chapter link
                pcb: 40,    // Previous chapter book: book_id of the chapter preceding this one
                pcc: 4,     // Previous chapter chapter: chapter number of the chapter preceding this one

                // Link to current chapter (if not already displaying the whole chapter)
                cur_chapter: "Matthew 5",   // 'reference' for current chapter link
                ccb: 40,    // Current chapter book: book_id of the current chapter
                ccc: 5,     // Current chapter chapter: chapter number of the current chapter,

                // Link to the Next Book, if applicable
                next_book: "Mark",          // 'reference' of next book
                nb: 41,     // Book_id of the next book

                // Link to the Previous Book, if applicable
                prev_book: "Malachi"        // 'reference' of previous book
                pb: 39      // Book_id of the previous book
            },
            "verse_index": {
                5: [6, 7, 8]
            },
            "verses":{ ... }
            "verses_count":3,
            "single_verse":false
        }
    ]
}

Search Pagination

For all searches, this provides the metadata for building pagination. (Please note, setting 'page_all' to true disables all pagination),

{
    "errors":[],
    "error_level":0,
    "paging":{
        "total":338,        // Total number of results
        "per_page":30,      // Results per page
        "current_page":1,   // Current page number
        "last_page":12,     // Total number of pages
        "from":61,          // First displaying result  Example: 'Now displaying results 61 to 90'
        "to":90             // Last displaying result
    },
    "results":[ ... ]
}