Skip to content
You are reading the Teku development version documentation and some features may not be available in the stable release. You can switch to the stable version using the version box at the bottom of the screen.

Updated on November 12, 2020

REST API

Enable the REST API service from the command line. You can also interact with APIs using Swagger UI by enabling the API documentation endpoint.

View the REST API documentation for more information about the available APIs.

Enable the REST API service

Enable the REST API service by setting the --rest-api-enabled command line option to true.

Warning

Only trusted parties should access the REST API. Do not directly expose these APIs publicly on production nodes.

Interact with Teku APIs using the web browser by setting the --rest-api-docs-enabled command line option to true.

Access the APIs at http:<interface>:<port>/swagger-ui where:

The default location is http://localhost:5051/swagger-ui.

You can also use tools such as Postman or cURL to interact with Teku APIs.

Example

curl -X GET "http://localhost:5051/beacon/committees?epoch=2"

REST API endpoints

The REST API is logically divided into multiple endpoints.

Endpoint Description
/admin Provides network administration functionality.
/beacon General information about the beacon chain.
/network Information about the network.
/node Information about the beacon node.
/validator Provide information and functionality for validator clients.
Questions or feedback? You can discuss issues and obtain free support on Teku Discord channel.
For paid professional support by Consensys, contact us at quorum@consensys.net