Documentation

Search the documentation

Full-text search across LottieFiles documentation pages, ranked by relevance with title matches weighted highest. Returns page titles, descriptions, and URLs; fetch a result's full content with getDocPage or its markdownUrl. When a non-English locale has no matches, results fall back to English.

get/api/search

Request

  • Base URL: https://docs.lottiefiles.com
  • URL: https://docs.lottiefiles.com/api/search
  • Auth: none required

Query parameters

qstring required

Search terms, for example dotlottie react player or state machine events.

locale'en' | 'zh' | 'ko'

Documentation locale to search.

limitinteger

Maximum number of results to return.

Response

Matching pages, most relevant first.

querystring required

The normalized search terms.

localestring required

Locale the results come from. English when the requested locale had no matches.

totalinteger required

Number of matching pages, which can exceed the number returned.

Changes

No recorded changes to this operation across all 1 revision of this API.