YouVersion PlatformYouVersion Platform
PlatformBiblesDev Docs
CommunityPartnersSupport

YouVersion Platform

Build applications and integrate with the world's most popular Bible platform.

Platform Products

  • Platform Portal
  • Developer Documentation
  • App Management

Resources

  • Support
  • Press inquiries

Legal

  • Privacy Policy
  • Terms of Use

© 2026 YouVersion. All rights reserved.

  • Overview
  • API Reference
  • SDKs
  • Changelog
<  Back to Platform
data exchange
    Show the data exchange approval page.getComplete the data exchange approval flow.postCreate a data exchange token.post
bibles
    Get a Bible collectiongetGet a Bible's datagetGet the index for a BiblegetGet a passage of Bible textgetGet a Book collection for a BiblegetGet a Book's datagetGet a Chapter collection for a BookgetGet a Chapter's datagetGet a Verse collection for a ChaptergetGet a Verse's dataget
fonts
    Get a collection of fonts supported in the Platform.getGet details about a specific font family in the Platform.getGet a browser-consumable stylesheet for a specific font family.get
highlights
    Get a collection of highlights for a user.getCreate or update a highlight on a passage.postClear highlights for a passage.delete
languages
    Get a collection of languages supported in the Platform.getGet details about a specific language in the Platform.get
licenses
    Get a collection of licensesget
permissions
    Get permissions granted to an app.get
search
    Get suggested or trending search queries.getSearch the Platform for Bible verses, topics and images.getSearch the Platform for topics related to a query.getSearch the Platform for Bible verses.getSearch the Platform for verse images.get
organizations
    Get a collection of organizations in the Platform.getGet details about a specific organization in the Platform.getGet bibles associated with a specific organization in the Platform.get
verse of the days
    Get the verse of the day calendar for an entire year.getGet the verse of the day for a specific day of the year.getGet the verse of the day calendar for an entire year.getGet the verse of the day for a specific day of the year.get
apps
    Get details about a specific app in the Platform.get
Schemas
Transformers
Transformers

search

Endpoint

Search the Platform for Bible verses, related topics, verse images, and query suggestions. Includes the unified endpoint that returns all kinds at once and the kind-specific paginated endpoints.


Get suggested or trending search queries.

GET
https://api.youversion.com
/v1/search-queries

Returns query objects (a search string and its source). Supply query with language_ranges[] for as-you-type suggestions, or trending=true with language_ranges[] for recently popular searches. When trending=true, query is ignored. The first language range supported by search is used.

Get suggested or trending search queries. › query Parameters

language_ranges[]
​string[] · required

An ordered list of language ranges using bracket notation. Use repeated parameters like language_ranges[]=en&language_ranges[]=es to supply multiple ranges, and use the wildcard * to match all languages. A language range is much like a language tag but may contain wildcards. See RFC 4647 section 2 for the full definition: https://www.rfc-editor.org/rfc/rfc4647.html#section-2 Language ranges in this parameter may only be of the Basic Range format.

query
​string

The partial query for as-you-type suggestions. Omit for trending queries.

Example: lo
trending
​boolean

Return recently popular searches for the language instead of suggestions.

Default: false

Get suggested or trending search queries. › Responses

Successful request

​object[] · readOnly · required
GET/v1/search-queries
curl --request GET \ --url 'https://api.youversion.com/v1/search-queries?language_ranges%5B%5D=%3Cvalue%3E'
shell
Example Responses
{ "data": [ { "text": "love", "source": "trending" } ] }
json
application/json

Search the Platform for Bible verses, topics and images.

GET
https://api.youversion.com
/v1/search-unified

Search for Bible verses, related topics and verse images by query, returning a single unified set of results across all content kinds. Verse results carry references and metadata only (e.g. JHN.3.16), never passage text; resolve verse text through the licensed-content endpoint.

This endpoint is unpaginated: it returns one combined page of top results per kind and exposes no page_size or page_token parameters. Use the kind-specific endpoints (search-verses, search-topics, search-images) when you need to page through the full result set for a single kind.

Search the Platform for Bible verses, topics and images. › query Parameters

query
​string · minLength: 1 · maxLength: 100 · required

The search query string used to find matching results.

bible_id
​integer · int32 · required

The Bible version identifier

Example: 3034
language_ranges[]
​string[] · required

An ordered list of language ranges using bracket notation. Use repeated parameters like language_ranges[]=en&language_ranges[]=es to supply multiple ranges, and use the wildcard * to match all languages. A language range is much like a language tag but may contain wildcards. See RFC 4647 section 2 for the full definition: https://www.rfc-editor.org/rfc/rfc4647.html#section-2 Language ranges in this parameter may only be of the Basic Range format.

user_intent
​string · enum

The searcher's intent. Defaults to unknown, matching the Core Search service.

Enum values:
unknown
topical
text
reference
Default: unknown
fields[]
​string[]

Result kinds to include: verses, topics and/or images. Use bracket notation to pass multiple values, for example fields[]=verses&fields[]=images. Omit to return all kinds. Query metadata is always included.

Search the Platform for Bible verses, topics and images. › Responses

Successful request

A single unified, unpaginated set of search results grouped by kind: verse references, related topics and verse images. Returns one combined page of top results per kind; there is no page_size or page_token. Use the kind-specific endpoints (search-verses, search-topics, search-images) to page through the full result set for a kind.
​object[] · readOnly · required
​object[] · readOnly · required
​object[] · readOnly · required
user_intent
​string | null · required

The intent the Core Search service resolved for the query.

Example: text
did_you_mean
​string[] · required

Alternative spellings the search service suggests for the query.

Example: ["water","war"]
search_instead_for
​string | null · required

A corrected query the results were actually returned for, if any.

GET/v1/search-unified
curl --request GET \ --url 'https://api.youversion.com/v1/search-unified?query=%3Cstring%3E&bible_id=%3Cnumber%3E&language_ranges%5B%5D=%3Cvalue%3E'
shell
Example Responses
{ "verses": [ { "reference": "JHN.3.16" } ], "topics": [ { "id": 42, "text": "faith", "subtopics": [ "trust", "belief" ] } ], "images": [ { "id": 95634, "references": [ "1CO.13.4", "1CO.13.5" ] } ], "user_intent": "text", "did_you_mean": [ "water", "war" ], "search_instead_for": "search_instead_for" }
json
application/json

Search the Platform for topics related to a query.

GET
https://api.youversion.com
/v1/search-topics

Returns the set of topics (id, text, subtopics) related to a query, for pivoting to other verses in the same topic.

This endpoint is unpaginated: Core Search returns a fixed set of topics and exposes no page_size or page_token parameters. Query metadata (did_you_mean, search_instead_for) is always included.

Search the Platform for topics related to a query. › query Parameters

query
​string · minLength: 1 · maxLength: 100 · required

The search query string used to find matching results.

language_ranges[]
​string[] · required

An ordered list of language ranges using bracket notation. Use repeated parameters like language_ranges[]=en&language_ranges[]=es to supply multiple ranges, and use the wildcard * to match all languages. A language range is much like a language tag but may contain wildcards. See RFC 4647 section 2 for the full definition: https://www.rfc-editor.org/rfc/rfc4647.html#section-2 Language ranges in this parameter may only be of the Basic Range format.

Search the Platform for topics related to a query. › Responses

Successful request

An unpaginated set of topics related to a query, for pivoting to other verses in the same topic. Backed by Core Search /topics, which returns a fixed set of topics; there is no page_size or page_token. Query metadata (did_you_mean, search_instead_for) is always included.
​object[] · readOnly · required
did_you_mean
​string[] · required

Alternative spellings the search service suggests for the query.

Example: ["water","war"]
search_instead_for
​string | null · required

A corrected query the topics were actually returned for, if any.

total_size
​integer · int32 · required

Total number of topics returned in this response. Because the endpoint is unpaginated, this is the full count returned, not a running total across pages.

Example: 4
GET/v1/search-topics
curl --request GET \ --url 'https://api.youversion.com/v1/search-topics?query=%3Cstring%3E&language_ranges%5B%5D=%3Cvalue%3E'
shell
Example Responses
{ "topics": [ { "id": 42, "text": "faith", "subtopics": [ "trust", "belief" ] } ], "did_you_mean": [ "water", "war" ], "search_instead_for": "search_instead_for", "total_size": 4 }
json
application/json

Search the Platform for Bible verses.

GET
https://api.youversion.com
/v1/search-verses

Search for Bible verses by query, returning a paginated list of verse references. Verse results carry references and metadata only (e.g. JHN.3.16), never passage text; resolve verse text through the licensed-content endpoint. The bible_id determines the language searched, so this endpoint takes no language parameter. Use page_size and page_token to page through the full result set.

Search the Platform for Bible verses. › query Parameters

query
​string · minLength: 1 · maxLength: 100 · required

The search query string used to find matching results.

bible_id
​integer · int32 · required

The Bible version identifier

Example: 3034
user_intent
​string · enum

The searcher's intent. Defaults to unknown, matching the Core Search service.

Enum values:
unknown
topical
text
reference
Default: unknown
page_size
​integer · min: 1 · max: 99

The number of verse results to return in the collection. Must be between 1 and 99.

Example: 25
Default: 25
page_token
​string

The page token to retrieve results from.

Example: eyJzdGFydF9hdCI6IDI2fQ==

Search the Platform for Bible verses. › Responses

Successful request

A paginated list of Bible verse search results. Verse results carry references and metadata only (e.g. JHN.3.16), never passage text; resolve verse text through the licensed-content endpoint.
​object[] · readOnly · required
user_intent
​string | null · required

The intent the Core Search service resolved for the query.

Example: text
did_you_mean
​string[] · required

Alternative spellings the search service suggests for the query.

Example: ["water","war"]
search_instead_for
​string | null · required

A corrected query the results were actually returned for, if any.

next_page_token
​string | null · readOnly

Token to send to the server when retrieving the next page of results.

Example: eyJzdGFydF9hdCI6IDI2fQ==
GET/v1/search-verses
curl --request GET \ --url 'https://api.youversion.com/v1/search-verses?query=%3Cstring%3E&bible_id=%3Cnumber%3E'
shell
Example Responses
{ "verses": [ { "reference": "JHN.3.16" } ], "user_intent": "text", "did_you_mean": [ "water", "war" ], "search_instead_for": "search_instead_for", "next_page_token": "eyJzdGFydF9hdCI6IDI2fQ==" }
json
application/json

Search the Platform for verse images.

GET
https://api.youversion.com
/v1/search-images

Search for verse-art images by query, returning a paginated list of images. Each image carries its id and the USFM verse references it illustrates (e.g. 1CO.13.4); image bytes are served by the CDN, not this endpoint. The bible_id determines the language searched, so this endpoint takes no language parameter. Use page_size and page_token to page through the full result set.

Search the Platform for verse images. › query Parameters

query
​string · minLength: 1 · maxLength: 100 · required

The search query string used to find matching results.

bible_id
​integer · int32 · required

The Bible version identifier

Example: 3034
page_size
​integer · min: 1 · max: 99

The number of verse results to return in the collection. Must be between 1 and 99.

Example: 25
Default: 25
page_token
​string

The page token to retrieve results from.

Example: eyJzdGFydF9hdCI6IDI2fQ==

Search the Platform for verse images. › Responses

Successful request

A paginated list of verse-image search results. Each result is a verse-art image keyed by an id and the USFM verse references it illustrates; image bytes are served by the CDN, not this endpoint.
​object[] · readOnly · required
next_page_token
​string | null · readOnly

Token to send to the server when retrieving the next page of results.

Example: eyJzdGFydF9hdCI6IDI2fQ==
GET/v1/search-images
curl --request GET \ --url 'https://api.youversion.com/v1/search-images?query=%3Cstring%3E&bible_id=%3Cnumber%3E'
shell
Example Responses
{ "images": [ { "id": 95634, "references": [ "1CO.13.4", "1CO.13.5" ] } ], "next_page_token": "eyJzdGFydF9hdCI6IDI2fQ==" }
json
application/json

permissionsorganizations