Visão geral

The API name, version, a link to the OpenAPI document, and a one-line list of every operation.

Endpoint

GET https://earn-api.quicknode.dev/functions/v1/api/v1

Authorization

Include the published apikey header. This read request is public and does not require a SIWE signature.

Parâmetros

This endpoint does not accept path or query parameters.

Example request

curl --request GET \
  --url 'https://earn-api.quicknode.dev/functions/v1/api/v1' \
  --header 'Accept: application/json' \
  --header 'apikey: <EARN_PUBLIC_API_KEY>'

Resposta

Field	Tipo	Required	Descrição
nome	cadeia de caracteres	Sim	Name of the API.
description	stringnull	Não	Summary of the API and the workflows it supports.
versão	cadeia de caracteres	Sim	Version of the API contract.
openapi	cadeia de caracteres	Sim	Absolute URL of the OpenAPI document (`GET /v1/openapi.json`).
endpoints	array<object>	Sim	One entry per documented operation.
endpoints[].method	cadeia de caracteres	Sim	HTTP method used to call the operation.
endpoints[].path	cadeia de caracteres	Sim	Versioned path appended to the API base URL.
endpoints[].summary	cadeia de caracteres	Não	Short description of the operation.

Example response

{
	"name": "Quicknode Earn Public API",
	"description": "The Earn public API (`/v1`) drives the full strategy lifecycle over HTTP ...",
	"version": "1.1.0",
	"openapi": "https://earn-api.quicknode.dev/functions/v1/api/v1/openapi.json",
	"endpoints": [
		{
			"method": "GET",
			"path": "/v1",
			"summary": "Machine-readable API index"
		},
		{
			"method": "GET",
			"path": "/v1/vaults",
			"summary": "Vault list (browse)"
		},
		{
			"method": "POST",
			"path": "/v1/strategies",
			"summary": "Create a strategy (SIWE `strategy.create`)"
		}
	]
}

HTTP responses

Status	Descrição
200	The API index.
429	Rate limit exceeded. `Retry-After` (seconds) tells you when to retry. Reads, feedback, and push writes are keyed per IP; create/update/delete are keyed per wallet+IP; deposit/withdraw/claim calldata is keyed per strategy+IP.

OpenAPI source

This page is based on operation getApiIndex in the Earn OpenAPI 3.1 specification.