Visão geral

This document as JSON, so the full contract can be fetched from the API itself.

Endpoint

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

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/openapi.json' \
  --header 'Accept: application/json' \
  --header 'apikey: <EARN_PUBLIC_API_KEY>'

Resposta

The response is the complete OpenAPI 3.1 contract used by the Earn API reference.

Field	Tipo	Required	Descrição
openapi	cadeia de caracteres	Sim	OpenAPI specification version used by the document.
informações	objeto	Sim	API metadata, including its title, version, description, contact, and license.
info.title	cadeia de caracteres	Sim	Display name of the API.
info.version	cadeia de caracteres	Sim	Version of the Earn API contract.
info.summary	cadeia de caracteres	Sim	Short summary of the API.
info.description	cadeia de caracteres	Sim	Detailed API lifecycle, authorization, units, and stability information.
info.contact	objeto	Sim	Name and URL of the API contact.
info.license	objeto	Sim	Name and URL of the license that applies to the API.
servers	array<object>	Sim	Server definitions used to construct API request URLs.
servers[].url	cadeia de caracteres	Sim	Base URL of an API server.
servers[].description	cadeia de caracteres	Sim	Environment represented by the server URL.
security	array<object>	Sim	Global security requirements applied to API operations.
security[].apikey	matriz	Sim	Declares the global `apikey` security scheme requirement.
tags	array<object>	Sim	Resource groups used to organize operations in the API reference.
tags[].name	cadeia de caracteres	Sim	Name of an API resource group.
tags[].description	cadeia de caracteres	Sim	Description of the operations included in the resource group.
paths	objeto	Sim	Documented API paths and their supported HTTP operations.
paths.{path}.{method}	objeto	Não	Operation definition containing its ID, rate limit, tags, summary, description, parameters, request body, and responses where applicable.
componentes	objeto	Sim	Reusable schemas, parameters, responses, examples, and security schemes.
components.schemas	objeto	Sim	Reusable request and response schemas referenced by operations.
components.parameters	objeto	Sim	Reusable path and query parameter definitions.
components.responses	objeto	Sim	Reusable HTTP response definitions.
components.examples	objeto	Sim	Reusable request and response examples.
components.securitySchemes	objeto	Sim	Definition of the `apikey` header security scheme.

Example response excerpt

The full response contains every path and reusable component. This excerpt shows selected top-level values from the response:

{
	"openapi": "3.1.0",
	"info": {
		"title": "Quicknode Earn Public API",
		"version": "1.3.0",
		"summary": "HTTP API to drive Earn strategies end to end.",
		"contact": {
			"name": "Quicknode Earn",
			"url": "https://earn.quicknode.com"
		},
		"license": {
			"name": "Proprietary",
			"url": "https://www.quicknode.com/terms-of-service"
		}
	},
	"servers": [
		{
			"url": "https://earn-api.quicknode.dev/functions/v1/api",
			"description": "Production"
		}
	],
	"security": [
		{
			"apikey": []
		}
	],
	"tags": [
		{
			"name": "Discovery",
			"description": "Machine-readable API index and the self-served OpenAPI document."
		}
	]
}

HTTP responses

Status	Descrição
200	The OpenAPI 3.1 document.
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 getOpenapiDocument in the Earn OpenAPI 3.1 specification.