अवलोकन

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	Type	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.
टैग	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 in the Earn OpenAPI 3.1 specification.