API
Developers > API
Authentication
For authentication, users need to use the Bearer authentication scheme by adding the following header to their request: Authorization -> Bearer <token>
.
Network endpoints
Idle's smart contracts are deployed on multiple networks, hence users should use the appropriate endpoint to retrieve the information needed
Ethereum
https://api.idle.finance
Polygon zkEVM
https://api-zkevm.idle.finance
Optimism
https://api-optimism.idle.finance
Endpoints
pools
GET
api.idle.finance
return all the network pools for both Best Yield and Yield Tranches vaults.
Headers
<token>*
Authentication using Bearer token
tvls
GET
api.idle.finance
return the total value locked (TVL) per underlying token.
Headers
<token>*
String
Authentication using Bearer token
rates
GET
api.idle.finance
return historical daily data for Best Yield vaults in a given calendar range.
Path parameters
<address>*
String
Underlying token address
Query parameters
frequency
86400
Seconds in one day
Headers
<token>*
String
Authentication using Bearer token
The query string params are:
start
: filter results from a specific timestampend
: filter results to a specific timestampisRisk
(true/false): if true returns only results for risk-adjusted strategy (deprecated), if false returns only results for Best Yield vaultsfrequency
: seconds between two recordsorder
(asc/desc): order results by timestamplimit
: limit results
Request examples
Return historical daily data for the Best Yield DAI vault from 22 July 2020 to 24 July 2020 in descending order.
https://api.idle.finance/rates/0x6b175474e89094c44da98b954eedeac495271d0f?start=1595412616&end=1595581466&isRisk=false&frequency=86400&order=desc
Return the latest data for Best Yield DAI vault.
https://api.idle.finance/rates/0x6b175474e89094c44da98b954eedeac495271d0f?isRisk=false&order=desc&limit=1
Return the available Yield Tranches on Polygon zkEVM
curl -H "Authorization: Bearer YOUR_TOKEN" "https://api-zkevm.idle.finance/pools"
const data = await axios
.get("https://api-zkevm.idle.finance/pools", {
headers:{ Authorization: `Bearer YOUR_TOKEN` }
})
.catch(err => {
// Handle request error
});
const request = require('request');
const apiUrl = 'https://api-zkevm.idle.finance/pools';
const accessToken = 'YOUR_TOKEN';
const options = {
url: apiUrl,
method: 'GET',
headers: {
'Authorization': `Bearer ${accessToken}`
},
};
request(options, (error, response, body) => {
if (error) {
console.error(error);
} else {
console.log(response.statusCode);
console.log(body);
}
});
Last updated
Was this helpful?