Provides data about the languages supported by the YouVersion platform. Use for presenting language options in your UI.
Get a collection of languages supported in the Platform.
Get a collection of language objects. Add the Country parameter to filter to prominent languages for that country. Send an Accept-Language header to control which name is returned in each language's localized_name; the negotiated locale is echoed in the Content-Language response header. Each object's display_names map carries a name in every supported locale and is therefore large, so request fields[] without display_names (and use page_size) when you only need localized_name.
query Parameters
page_sizeThe number of items to return in the collection. Numeric values must be between 1 and 99.
Special value "" is supported only when used in combination with the fields parameter and
when the client requests three or fewer fields (see fields parameter). When "" is used the
server will return all matching items for the requested resource (no numeric page limit).
fields[]A list of top-level fields to include in each resource object. Use bracket notation to pass
multiple values, for example: fields[]=id&fields[]=name&fields[]=language.
When provided, page_size=* is allowed only if the number of fields requested is three (3) or fewer.
page_tokenThe page token to retrieve results from.
countryThe ISO 3166 2 character country code
bibles_availableFilter languages based on whether Bible content is available for that language.
Headers
Accept-LanguageThe localization preferred as a response to the request. See RFC 2616 section 14.4 for further details.
Get a collection of languages supported in the Platform. › Responses
Successful request
next_page_tokenToken to send to server when retrieving the next page of results.
total_sizeTotal number of languages in collection matching parameters.
Get details about a specific language in the Platform.
Get a single language resource by its BCP47 language code. Send an Accept-Language header to control which name is returned in localized_name; the negotiated locale is echoed in the Content-Language response header. The display_names map carries a name in every supported locale and is therefore large, so request fields[] without display_names when you only need localized_name.
path Parameters
language_idThe language identifier uses the canonical BCP 47 language code, optionally including the script subtag when it distinguishes writing systems (for example, sr-Latn vs sr-Cyrl). Region subtags are excluded because they usually represent contextual or user-specific preferences rather than the intrinsic identity of the language, with one exception: a small, enumerated set of region variants that speakers treat as distinct languages is preserved (es-419, es-ES, pt-BR, pt-PT, zh-Hant-HK, zh-Hant-TW). Every other region, plus variants and extensions, is excluded, and a request for one redirects to the canonical region-agnostic id. This keeps identifiers stable and minimal while still surfacing the variants users distinguish.
Headers
Accept-LanguageThe localization preferred as a response to the request. See RFC 2616 section 14.4 for further details.
Get details about a specific language in the Platform. › Responses
Successful request
id^(?:[a-z]{2,3}(?:-[A… · requiredCanonical BCP 47 id limited to language, language+script, or one of the enumerated region-significant variants (es-419, es-ES, pt-BR, pt-PT, zh-Hant-HK, zh-Hant-TW). Other regions, variants, and extensions are not allowed.
language^[a-z]{2,3}$ · requiredISO 639 canonical language subtag
script^[A-Z][a-z]{3}$ISO 15924 script code if present in id
script_nameThe English name for the script
aliasesDeprecated or legacy subtags mapped during canonicalization for this language.
A map of every known display name for this language, keyed by the locale the name is written in. Covers all locales the platform can render (e.g. the English, endonym, and hundreds of other localized names), so this object is large; request fields[] without display_names to omit it when you only need localized_name.
localized_nameThe single display name chosen from display_names for the request's Accept-Language header. Selection is per language and uses the Accept-Language priority list, then falls back to the English name, then the first available name. The Content-Language response header reports the locale negotiated for the response as a whole; in a collection an individual language may fall back to a different locale than that header when it has no name in the negotiated one. Use this when you want one name to show the user; use display_names when you need the full set.
scriptsAll scripts known for this language (CLDR/ISO-15924)
variantsVariants associated with this language (not part of the id)
countriesIds of countries where this language is used or supported. Extended details can be retrieved from the countries API with the provided id.
text_directionDefault text direction for this language. ltr is left to right and rtl is right to left.
writing_populationEstimated number of souls that write in this language.
speaking_populationEstimated number of souls that speak in this language.
default_bible_idThe chosen default Bible version for this language.