概述

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.

参数

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

回复

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

Field	类型	Required	描述
openapi	字符串	是	OpenAPI specification version used by the document.
信息	对象	是	API metadata, including its title, version, description, contact, and license.
info.title	字符串	是	Display name of the API.
info.version	字符串	是	Version of the Earn API contract.
info.summary	字符串	是	Short summary of the API.
info.description	字符串	是	Detailed API lifecycle, authorization, units, and stability information.
info.contact	对象	是	Name and URL of the API contact.
info.license	对象	是	Name and URL of the license that applies to the API.
servers	array<object>	是	Server definitions used to construct API request URLs.
servers[].url	字符串	是	Base URL of an API server.
servers[].description	字符串	是	Environment represented by the server URL.
安全	array<object>	是	Global security requirements applied to API operations.
security[].apikey	数组	是	Declares the global `apikey` security scheme requirement.
tags	array<object>	是	Resource groups used to organize operations in the API reference.
tags[].name	字符串	是	Name of an API resource group.
tags[].description	字符串	是	Description of the operations included in the resource group.
paths	对象	是	Documented API paths and their supported HTTP operations.
paths.{path}.{method}	对象	不	Operation definition containing its ID, rate limit, tags, summary, description, parameters, request body, and responses where applicable.
components	对象	是	Reusable schemas, parameters, responses, examples, and security schemes.
components.schemas	对象	是	Reusable request and response schemas referenced by operations.
components.parameters	对象	是	Reusable path and query parameter definitions.
components.responses	对象	是	Reusable HTTP response definitions.
components.examples	对象	是	Reusable request and response examples.
components.securitySchemes	对象	是	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

状态	描述
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.