Subscribing to dAPIs
dAPIs are datafeeds that are sourced directly from multiple first-party oracles and aggregated using Signed data. It utilizes first-party oracles, enabling data to be served directly from reputable API providers. This guide will walk you through the process of subscribing to a dAPI.
API3 Market
The API3 Market provides all the tooling to seamlessly access dAPI services. This end-to-end process consists of:
- Exploring, selecting and configuring your dAPI
- Activating your dAPI
- Setting up OEV and getting the proxy address
Exploring, selecting and configuring your dAPI
The API3 Market provides a list of all the dAPIs available across multiple chains including testnets. You can filter the list by mainnet or testnet chains. After selecting the chain, you can now search for a specific dAPI by name. Once selected, you will land on the details page (eg ETH/USD on Ethereum Sepolia) where you can find more information about the dAPI.
The API3 Market gives you an option to configure the dAPI's deviation threshold and heartbeat. You will have the following options to choose from:
Deviation | Heartbeat |
---|---|
0.25% | 24 hours |
0.5% | 24 hours |
1% | 24 hours |
5% | 24 hours |
Note
Not all dAPIs support all the configurations. It depends on the asset and chain. Check the API3 Market for more info.
Click here to read more if you are unsure what suits your dApp
Activating your dAPI
Note
If a dAPI is already activated, make sure to check the expiration date and update parameters. You can update the parameters and extend the subscription by purchasing a new configuration.
Once you've selected the dAPI and the configuration, you will be presented with an option to purchase the dAPI and activate it. Make sure to check the time and amount of the subscription. If everything looks good, click on Purchase.
You can then connect your wallet and confirm the transaction.
Once the transaction is confirmed, you will be presented with a confirmation page for the order. You can now go back and check the updated configuration for the dAPI.
Setting up OEV and getting the proxy address
Once you are done configuring and activating the dAPI, you can now integrate it. To do so, click on the Integrate button on the dAPI details page.
To read from the dAPI, you will need the proxy contract address. Select Get Proxy Address to get the proxy contract address.
Before you can start reading from the dAPI, you will need to set your OEV beneficiary address. This is the address that will receive the OEV proceeds through the OEV Network.
Note
The OEV beneficiary address must be an EOA or a smart contract address that can call the Api3ServerV1
contract to withdraw funds to itself.
Once you have entered a valid address, click on Deploy Proxy. Confirm the transaction in your wallet.
You can now see the deployed proxy contract address. You can now use this to read from the configured dAPI.
In order for OEV Searchers to be able to find your dApp and participate in the OEV auctions, you must register your dApp and all the proxies with API3 Ecosystem. To do this, click on Register Proxy and fill out all the details about your dApp.
To get started with using dAPIs, you can follow the Reading a dAPI Proxy guide.
FLEX_END_TAG