Get OpenAPI document – Earn API

概要

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.

Get OpenAPI document – Earn API

概要​

Endpoint​

Authorization​

パラメータ​

Example request​

回答​

Example response excerpt​

HTTP responses​

概要