Data Feeds
Last updated
Was this helpful?
Last updated
Was this helpful?
Chainlink Data Feeds are the quickest way to connect your smart contracts to the real-world data such as asset prices, reserve balances, NFT floor prices, and L2 sequencer health.
If you already started a project and need to integrate Chainlink, you can with the .
Data feeds provide many different types of data for your applications.
Smart contracts often act in real-time on data such as prices of assets. This is especially true in .
For example, uses Data Feeds to determine prices on their derivatives platform. Lending and borrowing platforms like use Data Feeds to ensure the total value of the collateral.
Data Feeds aggregate many data sources and publish them on-chain using a combination of the and .
To learn how to use Price Feeds, see the documentation.
See the page for a list of available networks and addresses.
Proof of Reserves feeds provide the status of reserves for stablecoins, wrapped assets, and real world assets. Proof of Reserve Feeds operate similarly to Price Feeds, but provide answers in units of measurement such as ounces (oz) or number of tokens.
L2 sequencer feeds track the last known status of the sequencer on an L2 network at a given point in time. This helps you prevent mass liquidations by providing a grace period to allow customers to react to these events.
Data Feeds are an example of a decentralized oracle network and include the following components:
You can call the latestRoundData()
function directly on the aggregator, but it is a best practice to use the proxy instead so that changes to the aggregator do not affect your application. Similar to the proxy contract, the aggregator contract has a latestAnswer
variable, owner
address, latestTimestamp
variable, and several others.
The aggregator contract has several variables and functions that might be useful for your application. Although aggregator contracts are similar for each data feed, some aggregators have different variables. Use the typeAndVersion()
function on the aggregator to identify what type of aggregator it is and what version it is running.
To accommodate the dynamic nature of off-chain environments, Chainlink Data Feeds are updated from time to time to add new features and capabilities as well as respond to externalities such as token migrations, protocol rebrands, extreme market events, and upstream issues with data or node operations.
These updates include changes to the aggregator configuration or a complete replacement of the aggregator that the proxy uses. If you consume data feeds through the proxy, your applications can continue to operate during these changes.
The multisig-coordinated upgradability of Chainlink Data Feeds involves time-tested processes that balance collusion-resistance with the flexibility required to implement improvements and swiftly react to external conditions. The approach taken to upgradability will continue to evolve over time to meet user requirements.
When you build applications and protocols that depend on data feeds, include monitoring and safeguards to protect against the negative impact of extreme market events, possible malicious activity on third-party venues or contracts, potential delays, and outages.
Create your own monitoring alerts based on deviations in the answers that data feeds provide. This will notify you when potential issues occur so you can respond to them.
Configure your application to detect when the reported answer is close to reaching minAnswer
or maxAnswer
and issue an alert so you can respond to a potential market event. Separately, configure your application to detect and respond to extreme price volatility or prices that are outside of your acceptable limits.
Your application should track the latestTimestamp
variable or use the updatedAt
value from the latestRoundData()
function to make sure that the latest answer is recent enough for your application to use it. If your application detects that the reported answer is not updated within the heartbeat or within time limits that you determine are acceptable for your application, pause operation or switch to an alternate operation mode while identifying the cause of the delay.
During periods of low volatility, the heartbeat triggers updates to the latest answer. Some heartbeats are configured to last several hours, so your application should check the timestamp and verify that the latest answer is recent enough for your application.
Users should build applications with the understanding that data feeds for wrapped or liquid staking assets might have different heartbeat and deviation thresholds than that of the underlying asset. Heartbeat and deviation thresholds can also differ for the same asset across different blockchains. Combining data from multiple feeds, even those with a common denominator, might result in a margin of error that users must account for in their risk mitigation practices.
Reserves are available for both cross-chain assets and off-chain assets. This categorization describes the data attestation variations of Proof of Reserve feeds and helps highlight some of the inherent market risks surrounding the data quality of these feeds.
Reserves are available for both off-chain assets and cross-chain assets. Token issuers prove the reserves for their assets through several different methods.
Off-chain reserves provide their data using the following methods:
Third-party: An auditor, accounting firm, or other third party attests to reserves. This is done by combining both fiat and investment assets into a numeric value that is reported against the token.
Custodian: Reserves data are pulled directly from the bank or custodian. The custodian has direct access to the bank or vault holding the assets. Generally, this works when the underlying asset pulled requires no additional valuation and is simply reported on-chain.
Cross-chain reserves provide their data using the following methods:
Wallet address: The project attests which addresses they own through a self-hosted API.
DISCLAIMER
Proof of Reserve feeds can vary in their configurations. Please be careful with the configuration of the feeds used by your smart contracts. You are solely responsible for reviewing the quality of the data (e.g., a Proof of Reserve feed) that you integrate into your smart contracts and assume full responsibility for any damage, injury, or any other loss caused by your use of the feeds used by your smart contracts.
To learn more about Proof of Reserve Feeds, see the documentation.
See the page for a list of available networks and addresses.
NFT Floor Price Feeds provide the price of the lowest priced NFT available in a collection. These feeds operate similarly to so you can use the contract to retrieve price answers.
To learn more, see the documentation.
See the page for a list of available networks and addresses.
To learn how to use L2 sequencer uptime feeds feeds, see the documentation.
Consumer: A consumer is an on-chain or off-chain application that uses Data Feeds. Consumer contracts use the to call functions on the proxy contract and retrieve information from the aggregator contract. For a complete list of functions available in the AggregatorV3Interface
, see the .
Proxy contract: Proxy contracts are on-chain proxies that point to the aggregator for a particular data feed. Using proxies enables the underlying aggregator to be upgraded without any service interruption to consuming contracts. Proxy contracts can vary from one data feed to another, but the on Github is a common example.
Aggregator contract: An aggregator is a contract that receives periodic data updates from the oracle network. Aggregators store aggregated data on-chain so that consumers can retrieve it and act upon it within the same transaction. For a complete list of functions and variables available on most aggregator contracts, see the .
To learn how to create a consumer contract that uses an existing data feed, read the documentation.
Because the proxy and aggregator contracts are all on-chain, you can see the current configuration by reading the variables through an or using a blockchain explorer for your network. For example, you can see the on the Ethereum network using Etherscan.
If you read the BTC/USD proxy configuration, you can query all of the functions and variables that are publicly accessible for that contract including the aggregator
address, latestRoundData()
function, latestAnswer
variable, owner
address, latestTimestamp
variable, and several others. To see descriptions for the proxy contract variables and functions, see the source code for your specific data feed on .
The proxy contract points to an aggregator. This allows you to retrieve data through the proxy even if the aggregator is upgraded. If you view the aggregator
address defined in the proxy configuration, you can see the aggregator and its configuration. For example, see the in Etherscan. This contract includes several variables and functions, including another latestRoundData()
. To see descriptions for the aggregator variables and functions, see the source code on or .
Always check the contract source code and configuration to understand how specific data feeds operate. For example, the is different from the aggregators on other networks.
For examples of the contracts that are typically used in aggregator deployments, see the on GitHub.
For a complete list of functions and variables available on most aggregator contracts, see the .
Proxy and aggregator contracts all have an owner
address that has permission to change variables and functions. For example, if you read the in Etherscan, you can see the owner
address. This address is a (multisig) that you can also inspect.
If you in Etherscan using the Read as Proxy feature, you can see the full details of the multisig including the list of addresses that can sign and the number of signers required for the multisig to approve actions on any contracts that it owns.
The data feed aggregator includes both . These variables prevent the aggregator from updating the latestAnswer
outside the agreed range of acceptable values, but they do not stop your application from reading the most recent answer.
Chainlink Data Feeds do not provide streaming data. Rather, the aggregator updates its latestAnswer
when the value deviates beyond a specified threshold or when the heartbeat idle time has passed. You can find the heartbeat and deviation values for each data feed at or in the lists.
To learn more about the heartbeat and deviation threshold, read the page.
Many Chainlink Data Feeds provide data that is aggregated from many data sources by a decentralized set of independent node operators. The describes this in detail. However, there are some exceptions where data for a feed can come only from a single data source or where data values are calculated. Read the to learn about the different data feed categories and how to identify them.
Chainlink Proof of Reserve Feeds provide the status of the reserves for several assets. You can use these feeds the same way that you read other Data Feeds. Specify the that you want to read instead of specifying a Price Feed address. See the page to learn more.
To find a list of available Proof of Reserve Feeds, see the page.
Off-Chain reserves are sourced from APIs through an .
Self-attested: Reserve data is read from an API that the token issuer hosts. Self-attested feeds carry additional risk.
Cross-chain reserves are sourced from the network where the reserves are held. Chainlink node operators can report cross-chain reserves by running an and querying the source-chain client directly. In some instances, the reserves are composed of a dynamic list of IDs or addresses using a composite adapter.
Wallet address manager: The project uses the wallet address manager contract and self-attests to which addresses they own.
Read answers from Proof of Reserve Feeds the same way that you read other Data Feeds. Specify the that you want to read instead of specifying a Price Feed address. See the page to learn more.
Using Solidity, your smart contract should reference , which defines the external functions implemented by Data Feeds.
Chainlink NFT Floor Price Feeds provide a conservative and risk averse floor price estimate for an NFT collection. These feeds operate the same way as other Chainlink Data Feeds. NFT Floor Price Feeds are supported by aggregation algorithm and Chainlink’s oracle infrastructure to help eliminate extreme price outliers and make these feeds resistant to market manipulation. You can use NFT Floor Price Feeds for use cases that rely on high-quality NFT data, including lending and borrowing, on-chain derivatives, dynamic NFTs, gaming guilds, CeFi products, prediction markets, and more.
Find the list of testnet feeds on the page. To sign up for access to NFT Floor Price feeds on Ethereum Mainnet, .
Read answers from NFT Floor Price Feeds the same way that you read other Data Feeds. Specify the that you want to read instead of specifying a Price Feed address. See the page to learn more.
Using Solidity, your smart contract should reference , which defines the external functions implemented by Data Feeds.