ScriptureEarth.org API

Intro

Welcome to the ScriptureEarth.org (SE) Application Programming Interface (API) specification. This API will retrieve an SE JSON that serves as a bridge, enabling SE to communicate with another application. The SE API exposes the application's data to anyone who has a key.

You will need a version number and your SE key. The available version numbers are now 1 or 2. You will need to email Scott Starker to obtain your key. This email only needs to be sent once, but you will need to enter the key each time you make an SE API request. His email address is scott_starker@sil.org.

A request is called by "https://www.ScriptureEarth.org/api/[the request]?v=[version]&key=[your key]". You will need to type the request. The requests are display in green below. Depending on the request you will need to type "&[iso=[ISO 639-3 code[&rod=[ROD code][&var=[variant code]]", or "&idx=[index number]", or "&pln=[language name and alternate language name]", or "&cc=[country code]", or "&country=[country name]]”.

New SE API requests are displayed with this background color. (5/13/2025)

Summary

SE API has these requests now:

Each of the applications will pull out the JSON appropriate for that php.

In Depth

Each of the requests will now be detailed.

records.php

To get every item for one language:

will pull out

records.php will look like (https://scriptureearth.org/api/records.php?v=1&key=[your key]&iso=ngu) in raw data:

{
"0": {
"type": "iso",
"id": "1",
"attributes": {
"iso": "ngu",
"num_nav": 9,
"navigation": {
"English": "00eng.php",
"Spanish": "00spa.php",
"Portugues": "00por.php",
"French": "00fra.php",
"Dutch": "00nld.php",
"German": "00deu.php",
"Chinese": "00cmn.php",
"Korean": "00kor.php",
"Russian": "00rus.php,"
"Arabic": "00arb.php"
}
},
"relationships": {
"rod": "00000",
"var_code": "",
"var_name": "",
"iso_query_string": "iso=ngu",
"idx": 113,
"idx_query_string": "idx=113",
"language_name": {
"English": "Náhuatl, Guerrero",
"Spanish": "Náhuatl de Guerrero",
"Portuguese": "",
"French": "",
"Dutch": "",
"German": "",
"Chinese": "",
"Korean": "나후아틀, 게레로",
"Russian": "Науатль, Герреро",
"Arabic": "",
"minority": ""
},
"alternate_language_count": 6,
"alternate_language_names": {
"0": "Náhuatl (Nauatl; Azteca) de Guerrero Central",
"1": "Mexicano (Mejicano) de Guerrero Central",
"2": "Nahuatl, Guerrero",
"3": "Guerrero Aztec",
"4": "Mexicano de Guerrero",
"5": "Xalitla Nahuatl"
},
"country_count": 1,
"countries_names": {
"0": "Mexico"
},
"countries_codes": {
"0": "MX"
},
"se_apps": {
"android": 6,
"ios": 1
},
"se_sab": {
"text": 1095,
"audio": 0,
"video": 0
},
"se_online_viewer": 1,
"se_media": {
"text": 33,
"ePub": 0,
"audio": 187,
"video": 0,
"playlist_audio": 1,
"playlist_video": 4
},
"se_download_media": {
"text": 33,
"audio": 187,
"video": 0,
"playlist_video": 3
},
"se_google_play": 1,
"se_other_software": {
"GoBible": 1,
"MySword": 0,
"theWord": 1
},
"links_media": {
"Bible.is": 2,
"Bible.is_Gospel_Film": 1,
"YouVersion": 2,
"eBible": 1,
"GRN": 1
},
"buy": 1,
"maps": 1,
"watch": 1,
"websites": 0,
"other_titles": 1,
"SIL_link": 1
}
}
}

all_iso.php

same as records.php but pulls the counts of all of the ISO 639-3 products

partial_languageNames.php

To get at least 3 letters for English language names and alternate language names starting at the beginning of the words

will pull out

country.php

To get the country:

will pull out

partial_countries.php

To get at least 2 letters starting at the beginning of the word

will pull out

all_countries.php

To get all the countries

will pull out

subfamilies.php

To get the subfamily(ies)

will pull out

media_se.php

To get the ScriptureEarth media:

will pull out all of the ScriptureEarth URLs for

To get the links:

will pull out the general URLs for

apps.php

To get the Android, iOS, or both apps:

will pull out

version 2 will add

apps.php will look like (https://scriptureearth.org/api/apps.php?v=2&key=[your key]&cc=MX):

languageNames.php

To get the language name(s) and mobile devices:

will pull out

languageNames.php will look like (https://scriptureearth.org/api/languageNames.php?v=2&key=[your key]&cc=MX&rel=ios):

sab.php

To get the SAB HTML:

will pull out

other_se.php

To get the other ScritureEarth items:

will pull out

To get the website links:

will pull out

download_media.php

To get the downloadable media:

will pull out