Public API

This section of the documentation details the public API usable to get details of projects, builds, versions and other details from Read the Docs.

Warning

Originally, the Read the Docs API allowed connections over insecure HTTP. Starting in January 2019, requests over HTTP will be automatically redirected to HTTPS and non-GET/HEAD requests over insecure HTTP will fail.

Tip

It is a good idea to put your email address, application name, or Read the Docs username into the user agent header of your requests. That way the Read the Docs’ team can contact you in the event of issues.

• API v2
  • Authentication and authorization
  • Resources
    • Projects
    • Versions
    • Builds
    • Undocumented resources and endpoints
• API v1 (deprecated)
  • A basic API client using slumber
  • API Endpoints
  • Doc Search
  • Root
  • Builds
  • Build
  • Files
  • File
  • Projects
  • Project
  • Users
  • User
  • Versions
  • Version
  • Filtering Examples
    • File Search
    • Anchor Search