Présentation générale

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.

Paramètres

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>'

Réponse

Champ	Type	Obligatoire	Description
nom	chaîne de caractères	Oui	Name of the API.
description	stringnull	Non	Summary of the API and the workflows it supports.
version	chaîne de caractères	Oui	Version of the API contract.
openapi	chaîne de caractères	Oui	Absolute URL of the OpenAPI document (`GET /v1/openapi.json`).
endpoints	array<object>	Oui	One entry per documented operation.
endpoints[].method	chaîne de caractères	Oui	HTTP method used to call the operation.
endpoints[].path	chaîne de caractères	Oui	Versioned path appended to the API base URL.
endpoints[].summary	chaîne de caractères	Non	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

Statut	Description
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.