Use language ranges to tell the Platform which languages your app needs. A language tag identifies a language, such as en for English, and can include a region, such as en-US for US English. The wildcard * matches all languages.
Use language tags or the bare wildcard *. Prefix patterns such as en* are not valid Basic language ranges for Search or Bible-version listing.
The same language choices apply across SDKs, but Search and Bible-version listing match them differently. Choose the rule for the operation you are calling.
Bible-version listing
Use language filters to select Bible versions from the catalog:
enselects English versions.*includes all languages, subject to your app's catalog access.
If you supply multiple ranges, the catalog returns versions from the first range that has available Bibles. For example, requesting English followed by Spanish returns English versions when available, not a combined set of English and Spanish versions.
See the JavaScript SDK version methods for a JavaScript example and the Bibles API reference for REST parameters.
Search
For topic search, suggested queries, and trending queries, supply a nonempty list of language ranges in preference order. Unified search also uses this list for topic results. The service uses the first supported range.
- Use
ento request English. - Use
*to match all languages. - To prefer a regional language tag with a base-language fallback, supply both, such as
["en-US", "en"]. Do not assume that the service convertsen-UStoen.
For verse results, the Bible version selects the language. Verse search takes no language-range argument. Unified search takes both a Bible version for verses and language ranges for topics.
REST parameters
For REST calls, repeat the language_ranges[] parameter for multiple values. For example, pass these query parameters to request English first, then Spanish:
Code
For working requests, see the Search API guide or your SDK's search guide: JavaScript and TypeScript, React, Swift, Kotlin, or React Native Expo.