readthedocs-search-api

To search documentation across projects, query the Read the Docs Search API endpoint with the q parameter to locate relevant pages across public repositories without requiring authentication.

No, the Read the Docs Search API is public and requires no authentication for accessing public documentation across Community and Business sites.

Filter search results to a specific project on Read the Docs by applying the project:{slug} filter within your query to narrow the returned documentation pages.

Pagination works by passing the page parameter to the API endpoint, allowing you to navigate through structured search results and extract fields like project, version, title, path, and highlights.

The best way to find API docs and guides without manual browsing is to programmatically query the Read the Docs Search API, enabling fast discovery of relevant pages to accelerate onboarding or research.

Yes, you can configure the Search API to query a specific site by setting the RTD_HOST variable to your Read the Docs site before making requests to the /api/v3/search/ endpoint.