ESP Component Registry API

This page provides a reference entry point for the ESP Component Registry HTTP API documentation.

The ESP Component Registry powers component search, metadata, versions, and downloads used by the IDF Component Manager tooling and the public registry website.

API Documentation

The canonical API reference is published here:

• ESP Component Registry API Docs: https://components.espressif.com/apidocs/

What you’ll find there

The API documentation describes the available endpoints, request/response schemas, and error codes for common registry operations, such as:

• Discovering components and versions

• Reading component metadata (namespaces, descriptions, tags, etc.)

• Accessing information needed for downloads and dependency resolution

Related pages in this documentation

• ESP Component Registry Badge Endpoint (Badge endpoint used for component badges)

• idf_component.yml Manifest File (Component manifest format consumed by tooling)

• Dependencies.lock File (Dependencies lock file format)

• Compote CLI (CLI reference)