Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Yearn Finance

Yearn Finance Vaults API

Endpoints for querying Yearn vault data

Documentation Provider Profile APIs.io OpenAPI GitHub

Yearn Finance Vaults API is one of 5 APIs that Yearn Finance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Vaults. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 7 operations across 7 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://ydaemon.yearn.fi.

7 operations 7 paths 14 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://ydaemon.yearn.fi
Contact
Yearn Finance
License
GNU Affero General Public License v3.0
Resource Areas
1

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Vaults 7

Endpoints for querying Yearn vault data

GET
/{chainID}/vaults/all
Get all vaults for a chain
getAllVaults 9 params → 200400404
GET
/{chainID}/vaults/{address}
Get vault by address
getVaultByAddress 3 params → 200400404
GET
/{chainID}/vaults/v2
Get all V2 vaults for a chain
getV2Vaults 5 params → 200
GET
/{chainID}/vaults/v3
Get all V3 vaults for a chain
getV3Vaults 5 params → 200
GET
/{chainID}/vaults/retired
Get all retired vaults for a chain
getRetiredVaults 3 params → 200
GET
/{chainID}/vaults/detected
Get all detected vaults for a chain
getDetectedVaults 3 params → 200
GET
/info/vaults/blacklisted
Get blacklisted vaults
getBlacklistedVaults → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Vault (22 properties), VaultDetails (11 properties), VaultToken (10 properties), VaultAPR (7 properties). Each schema is shown below with its type and property counts.

VaultAPRPricePerShare
object
Price per share at different time points.
3 properties
VaultAPR
object
Annual Percentage Rate data for the vault.
7 properties
VaultToken
object
The underlying token accepted by the vault.
10 properties
VaultDetails
object
Additional metadata and classification details for the vault.
11 properties
Vault
object
A Yearn Finance vault with full metadata.
22 properties
VaultForwardAPRComposite
object
Composite breakdown of forward APR components.
6 properties
VaultAPRPoints
object
Historical APR data points.
3 properties
VaultStrategy
object
A strategy allocated to the vault.
4 properties
Error
object
1 property
VaultForwardAPR
object
Forward-looking APR estimate.
3 properties
VaultStrategyDetails
object
Detailed metrics for a vault strategy.
6 properties
VaultTVL
object
Total Value Locked metrics for the vault.
3 properties
VaultAPRExtra
object
Additional APR components from external sources.
2 properties
VaultAPRFees
object
Fee structure for the vault.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yearn-vaults-api-openapi.yml Raw ↑

Other APIs Yearn Finance publishes across the network.

Kong GraphQL API
AE Profile APIs.io
Yearn Finance Chains API
AE Profile APIs.io
Yearn Finance Info API
AE Profile APIs.io
Yearn Finance TVL API
AE Profile APIs.io
#Vaults
← Back to Y APIs
API Details
ID
yearn:yearn-vaults-api
Base URL
https://ydaemon.yearn.fi
Docs
https://docs.yearn.fi/developers/data-services/yearn-data
Provider
Yearn Finance
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network