> For the complete documentation index, see [llms.txt](https://docs.idle.finance/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.idle.finance/developers.md).

# Developers

- [Introduction](https://docs.idle.finance/developers/introduction.md): Developers > Introduction
- [Networks and codebase](https://docs.idle.finance/developers/networks-and-codebase.md): Developers > Networks and codebase
- [Ethereum mainnet](https://docs.idle.finance/developers/networks-and-codebase/ethereum-mainnet.md): Developers > Networks and codebase > Ethereum
- [Polygon](https://docs.idle.finance/developers/networks-and-codebase/polygon.md): Developers > Networks and codebase > Polygon
- [Kovan testnet](https://docs.idle.finance/developers/networks-and-codebase/kovan-testnet.md): Developers > Networks and codebase > Kovan
- [ERC-4626 standard](https://docs.idle.finance/developers/networks-and-codebase/erc-4626-standard.md): Developers > Network and codebase > ERC-4626
- [Best Yield](https://docs.idle.finance/developers/best-yield.md): Developers > Best Yield
- [Architecture](https://docs.idle.finance/developers/best-yield/architecture.md): Developers > Best Yield > Architecture
- [Deployed contracts](https://docs.idle.finance/developers/best-yield/deployed-contracts.md)
- [Ethereum](https://docs.idle.finance/developers/best-yield/deployed-contracts/ethereum.md): Developers > Best Yield > Deployed contracts > Ethereum
- [Optimism](https://docs.idle.finance/developers/best-yield/deployed-contracts/optimism.md): Developers > Best Yield > Deployed contracts > Optimism
- [Interface](https://docs.idle.finance/developers/best-yield/interface.md): Developers > Best Yield > Interface
- [Methods](https://docs.idle.finance/developers/best-yield/methods.md): Developers > Best Yield > Methods
- [mintIdleToken](https://docs.idle.finance/developers/best-yield/methods/mintidletoken.md): Developers > Best Yield > mintIdleToken
- [redeemIdleToken](https://docs.idle.finance/developers/best-yield/methods/redeemidletoken-1.md): Developers > Best Yield > redeemIdleToken
- [redeemInterestBearingTokens](https://docs.idle.finance/developers/best-yield/methods/redeeminterestbearingtokens.md): Developers > Best Yield > redeemInterestBearingTokens
- [rebalance](https://docs.idle.finance/developers/best-yield/methods/rebalance.md): Developers > Best Yield > rebalance
- [tokenPrice](https://docs.idle.finance/developers/best-yield/methods/tokenprice.md): Developers > Best Yield > tokenPrice
- [tokenPriceWithFee](https://docs.idle.finance/developers/best-yield/methods/tokenpricewithfee.md): Developers > Best Yield > tokenPriceWithFee
- [getAPRs](https://docs.idle.finance/developers/best-yield/methods/getaprs.md): Developers > Best Yield > getAPRs
- [getAvgApr](https://docs.idle.finance/developers/best-yield/methods/getavgapr.md): Developers > Best Yield > getAvgApr
- [userAvgPrices](https://docs.idle.finance/developers/best-yield/methods/useravgprices.md): Developers > Best Yield > userAvgPrices
- [getGovTokensAmounts](https://docs.idle.finance/developers/best-yield/methods/getgovtokensamounts.md): Developers > Best Yield > getGovTokensAmounts
- [getAllocations](https://docs.idle.finance/developers/best-yield/methods/getallocations.md): Developers > Best Yield > getAllocations
- [getGovTokens](https://docs.idle.finance/developers/best-yield/methods/getgovtokens.md): Developers > Best Yield > getGovTokens
- [getAllAvailableTokens](https://docs.idle.finance/developers/best-yield/methods/getallavailabletokens.md): Developers > Best Yield > getAllAvailableTokens
- [getProtocolTokenToGov](https://docs.idle.finance/developers/best-yield/methods/getprotocoltokentogov.md): Developers > Best Yield > getProtocolTokenToGov
- [Edge cases](https://docs.idle.finance/developers/best-yield/edge-cases.md): Developers > Best Yield > Edge cases
- [Security management policy](https://docs.idle.finance/developers/best-yield/security-management-policy.md): Developers > Best Yield > Security management policy
- [Get integrated as yield source](https://docs.idle.finance/developers/best-yield/integrators.md): Developers > Best Yield > Get integrated as yield source
- [Get user earnings](https://docs.idle.finance/developers/best-yield/get-user-earnings.md): Developers > Best Yield > Get user earnings
- [Yield Tranches](https://docs.idle.finance/developers/yield-tranches.md): Developers > Yield Tranches
- [Architecture](https://docs.idle.finance/developers/yield-tranches/architecture.md): Developers > Yield Tranches > Architecture
- [Deployed contracts](https://docs.idle.finance/developers/yield-tranches/deployed-contracts.md): Developers > Yield Tranches > Deployed contracts
- [Ethereum](https://docs.idle.finance/developers/yield-tranches/deployed-contracts/ethereum.md): Developers > Yield Tranches > Deployed contracts > Ethereum
- [Polygon zkEVM](https://docs.idle.finance/developers/yield-tranches/deployed-contracts/polygon.md): Developers > Yield Tranches > Deployed contracts > Polygon zkEVM
- [Optimism](https://docs.idle.finance/developers/yield-tranches/deployed-contracts/optimism.md): Developers > Yield Tranches > Deployed contracts > Optimism
- [Interface](https://docs.idle.finance/developers/yield-tranches/interface.md): Developers > Yield Tranches > Interface
- [Methods](https://docs.idle.finance/developers/yield-tranches/methods.md): Developers > Yield Tranches > Methods
- [AAStaking](https://docs.idle.finance/developers/yield-tranches/methods/aastaking.md): Developers > Yield Tranches > Methods > AAstaking
- [BBStaking](https://docs.idle.finance/developers/yield-tranches/methods/bbstaking.md): Developers > Yield Tranches > Methods > BBStaking
- [AATranche](https://docs.idle.finance/developers/yield-tranches/methods/aatranche.md): Developers > Yield Tranches > Methods > AATranche
- [BBTranche](https://docs.idle.finance/developers/yield-tranches/methods/bbtranche.md): Developers > Yield Tranches > Methods > BBTranche
- [depositAA](https://docs.idle.finance/developers/yield-tranches/methods/depositaa.md): Developers > Yield Tranches > Methods > depositAA
- [depositAARef](https://docs.idle.finance/developers/yield-tranches/methods/depositaaref.md): Developers > Yield Tranches > Methods > depositAARef
- [depositBB](https://docs.idle.finance/developers/yield-tranches/methods/depositbb.md): Developers > Yield Tranches > Methods > depositBBnonpayable
- [depositBBRef](https://docs.idle.finance/developers/yield-tranches/methods/depositbbref.md): Developers > Yield Tranches > Methods > depositBBRef
- [fee](https://docs.idle.finance/developers/yield-tranches/methods/fee.md): Developers > Yield Tranches > Methods > fee
- [getApr](https://docs.idle.finance/developers/yield-tranches/methods/getapr.md): Developers > Yield Tranches > Methods > getAPR
- [getContractValue](https://docs.idle.finance/developers/yield-tranches/methods/getcontractvalue.md): Developers > Yield Tranches > Methods > getContractValue
- [getCurrentAARatio](https://docs.idle.finance/developers/yield-tranches/methods/getcurrentaaratio.md): Developers > Yield Tranches > Methods > getCurrentAARatio
- [getIncentiveTokens](https://docs.idle.finance/developers/yield-tranches/methods/getincentivetokens.md): Developers > Yield Tranches > Methods > getIncentiveTokens
- [lastNAVAA](https://docs.idle.finance/developers/yield-tranches/methods/lastnavaa.md): Developers > Yield Tranches > Methods > lastNAVAA
- [lastNAVBB](https://docs.idle.finance/developers/yield-tranches/methods/lastnavbb.md): Developers > Yield Tranches > Methods > lastNAVBB
- [strategy](https://docs.idle.finance/developers/yield-tranches/methods/strategy.md): Developers > Yield Tranches > Methods > strategy
- [strategyToken](https://docs.idle.finance/developers/yield-tranches/methods/strategytoken.md): Developers > Yield Tranches > Methods > strategyToken
- [token](https://docs.idle.finance/developers/yield-tranches/methods/token.md): Developers > Yield Tranches > Methods > token
- [trancheAPRSplitRatio](https://docs.idle.finance/developers/yield-tranches/methods/trancheaprsplitratio.md): Developers > Yield Tranches > Methods > trancheAPRSplitRatio
- [tranchePrice](https://docs.idle.finance/developers/yield-tranches/methods/trancheprice.md): Developers > Yield Tranches > Methods > tranchePrice
- [virtualPrice](https://docs.idle.finance/developers/yield-tranches/methods/virtualprice.md): Developers > Yield Tranches > Methods > virtualPrice
- [withdrawAA](https://docs.idle.finance/developers/yield-tranches/methods/withdrawaa.md): Developers > Yield Tranches > Methods > withdrawAA nonpayable
- [withdrawBB](https://docs.idle.finance/developers/yield-tranches/methods/withdrawbb.md): Developers > Yield Tranches > Methods > withdrawBB
- [Integration example](https://docs.idle.finance/developers/yield-tranches/integration-example.md): Developers > Yield Tranches > Integration example
- [Edge cases](https://docs.idle.finance/developers/yield-tranches/edge-cases.md): Developers > Yield Tranches > Edge cases
- [Security management policy](https://docs.idle.finance/developers/yield-tranches/security-management-policy.md): Developers > Yield Tranches > Security management policy
- [Subgraph](https://docs.idle.finance/developers/yield-tranches/subgraph.md): Developers > Yield Tranches > Subgraph
- [API](https://docs.idle.finance/developers/api.md): Developers > API
- [Security](https://docs.idle.finance/developers/security.md): Developers > Security
- [Hats Finance vault](https://docs.idle.finance/developers/security/hats-finance-vault.md): Developers > Security > Hats Finance vault
- [Hypernative monitoring](https://docs.idle.finance/developers/security/hypernative-monitoring.md): Developers > Security > Hypernative monitoring
- [Immunefi bug bounty](https://docs.idle.finance/developers/security/bug-bounty.md): Developers > Security > Immunefi bug bounty
- [Integration Standard Requirements](https://docs.idle.finance/developers/security/integration-standard-requirements.md): Developers > Security > Integration Standard Requirements
- [Risk Framework](https://docs.idle.finance/developers/security/risk-framework.md): Developers > Security > Risk Framework
- [Smart contract audits](https://docs.idle.finance/developers/security/audits.md): Developers > Security > Smart contracts audits


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.idle.finance/developers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.