Base URL

The base URL to send all API requests is https://api.figment.io. HTTPS is required for all API requests. Calls made over plain HTTP will be redirected to https with a HTTP 301 status code.

API keys

The Figment API uses API keys to authenticate requests. It expects the API key to be passed in x-api-key header.

curl --request GET \
     --url 'https://api.figment.io/' \
     --header 'x-api-key: your-api-key-here'

You can view and manage your API keys in the Figment app's Developers section.

Permissions

API keys permissions (or scope) can be either Read/Write or Read-Only

Read/Write API keys will work for all endpoints.
Read-Only API keys will not work for Create Validators and Exit Validators endpoints.

Environments

API keys environment can be either test or production

API keys with the test environment will only work with testnets and devnets
API keys with the production environment will only work with mainnets.

OpenAPI

Our API follows the Open API spec, version 3.1.0. You can download the latest YAML file at https://api.figment.io/openapi/figment-api.yaml.