translationDatabase API

Description

Example

Language Names Endpoint

The Language Names Endpoint provides access to basic language information for all languages in the world. The lc field provides a unique language code for each language, based on the IETF standard (see our IETF page on the unfoldingWord website for a simple introduction).

Tip

The following is an example JSON snippet endpoint and may be used as a reference guide.

{
  "pk": 6,
  "alt": [
    "Afaraf",
    "Danakil",
    "Denkel",
    "Adal",
    "Afar Af",
    "Qafar",
    "Baadu (Ba'adu)"
  ],
  "lr": "Africa",
  "gw": false,
  "ang": "Afar",
  "ld": "ltr",
  "lc": "aa",
  "ln": "Afaraf",
  "hc": "ET",
  "cc": [
    "DJ",
    "ER",
    "ET",
    "US",
    "CA"
  ]
}

The field names are described as follows:

  • pk: database key id, for internal use only

  • alt: list of alternate names for the language

  • lr: specifies the region of the world where the language is predominantly used

  • gw: specifies whether or not this is a Gateway Language

  • ang: an anglicized version of the language name

  • ld: specifies the usual text direction, either “ltr” or “rtl”

  • lc: specifies language code of this resource following the IETF standard

  • ln: specifies the name of the language as its speakers refer to it (localized name)

  • hc: specifies the country code for the home country of this language

  • cc: list of country codes where the language is spoken

Language Names Short Endpoint

The Language Names Short Endpoint provides access to abbreviated language information for all languages in the world. The lc field provides a unique language code for each language, based on the IETF standard (see our IETF page on the unfoldingWord website for a simple introduction).

Tip

The following is an example JSON snippet endpoint and may be used as a reference guide.

{
  "pk": 6,
  "lr": "Africa",
  "ang": "Afar",
  "lc": "aa",
  "ln": "Afaraf",
  "hc": "ET"
}

The field names are described as follows:

  • pk: database key id, for internal use only

  • lr: specifies the region of the world where the language is predominantly used

  • ang: an anglicized version of the language name

  • lc: specifies language code of this resource following the IETF standard

  • ln: specifies the name of the language as its speakers refer to it (localized name)

  • hc: specifies the country code for the home country of this language