Updated on April 13, 2020

REST API

Enable the REST API service from the command line, and enable the API documentation endpoint to interact with APIs using Swagger UI.

Teku REST API documentation is also available.

Enable the REST API service

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

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.

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.