概覽

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.

領域	類型	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.
security	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.
元件	物件	是的	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 在 Earn OpenAPI 3.1 specification.