# Illuminate

## Illuminate

- [Illuminate - DeFi: Fixed](https://docs.illuminate.finance/illuminate-defi-fixed.md): An introduction to the Illuminate ecosystem.
- [iPTs: Meta Principal Tokens](https://docs.illuminate.finance/illuminate-defi-fixed/ipts-meta-principal-tokens.md): A description of our core mechanism -- iPTs.
- [Lending](https://docs.illuminate.finance/illuminate-defi-fixed/lending.md): A description of the lending process and involved risks / security considerations.
- [Maturity & Redemption](https://docs.illuminate.finance/illuminate-defi-fixed/maturity-and-redemption.md): A description of the redemption and coordination process for external principal tokens.
- [Integrations](https://docs.illuminate.finance/illuminate-defi-fixed/integrations.md): An integration demonstration alongside our initial integration partners
- [YieldSpace AMM](https://docs.illuminate.finance/illuminate-defi-fixed/yieldspace-amm.md): A description of the liquidity provision mechanisms behind Illuminate
- [Pricing & Arbitrage](https://docs.illuminate.finance/illuminate-defi-fixed/pricing-and-arbitrage.md): A description of the optimized pricing and iPT pegging mechanism
- [Smart Contracts](https://docs.illuminate.finance/smart-contracts.md)
- [Lender](https://docs.illuminate.finance/smart-contracts/lender.md)
- [Lender.sol](https://docs.illuminate.finance/smart-contracts/lender/lender.sol.md): This document describes the functions, attributes and modifiers in Lender.sol
- [Redeemer](https://docs.illuminate.finance/smart-contracts/redeemer.md)
- [Redeemer.sol](https://docs.illuminate.finance/smart-contracts/redeemer/redeemer.sol.md): This document describes the functions, attributes and modifiers in Redeemer.sol
- [Marketplace](https://docs.illuminate.finance/smart-contracts/marketplace.md)
- [Marketplace.sol](https://docs.illuminate.finance/smart-contracts/marketplace/marketplace.sol.md): This document describes the functions, attributes and modifiers in MarketPlace.sol
- [Illuminate Principal Token (ERC5095)](https://docs.illuminate.finance/smart-contracts/illuminate-principal-token-erc5095.md)
- [ERC5095.sol](https://docs.illuminate.finance/smart-contracts/illuminate-principal-token-erc5095/erc5095.sol.md): This document describes the functions, attributes and modifiers in ERC5095.sol
- [Deployed Contract Addresses](https://docs.illuminate.finance/smart-contracts/deployed-contract-addresses.md): This page contains the current deployments on mainnet and Goerli
- [Critical Attributes](https://docs.illuminate.finance/smart-contracts/critical-attributes.md): This page documents critical attributes stored by the contract federation
- [Key Roles](https://docs.illuminate.finance/smart-contracts/key-roles.md): Describes the abilities and roles of the admin
- [Contract Relationships](https://docs.illuminate.finance/smart-contracts/contract-relationships.md): Describe how the Lender, Redeemer, MarketPlace and Converter contracts related to one another
- [Operation Checklists](https://docs.illuminate.finance/smart-contracts/operation-checklists.md): What each redeem and lend must accomplish to be successful
- [Deposit Lifecycle](https://docs.illuminate.finance/smart-contracts/deposit-lifecycle.md): Describes the course of funds as they move through Illuminate
- [Error Codes](https://docs.illuminate.finance/smart-contracts/error-codes.md)
- [Smart Contract Integration](https://docs.illuminate.finance/smart-contracts/smart-contract-integration.md): This page describes how to integrate Illuminate into your smart contracts with examples.
- [IlluminAPI](https://docs.illuminate.finance/illuminapi.md)
- [GET](https://docs.illuminate.finance/illuminapi/get.md): All GET endpoints are documented here. Base URLs should be changed in relation to the environment that is used: Testnet or Mainnet.
- [Get Markets](https://docs.illuminate.finance/illuminapi/get/get-markets.md)
- [Get Quotes](https://docs.illuminate.finance/illuminapi/get/get-quotes.md)
- [Get Best Quote](https://docs.illuminate.finance/illuminapi/get/get-best-quote.md)
- [Get Pools](https://docs.illuminate.finance/illuminapi/get/get-pools.md)
- [Get Pool](https://docs.illuminate.finance/illuminapi/get/get-pool.md)
- [Get Raw Pool APYs](https://docs.illuminate.finance/illuminapi/get/get-raw-pool-apys.md)
- [Get User Positions](https://docs.illuminate.finance/illuminapi/get/get-user-positions.md)
- [Get Status](https://docs.illuminate.finance/illuminapi/get/get-status.md)
- [POST](https://docs.illuminate.finance/illuminapi/post.md)
- [Illuminate-js](https://docs.illuminate.finance/illuminate-js.md)
- [Media Kit](https://docs.illuminate.finance/media-kit.md)
- [Misc](https://docs.illuminate.finance/misc.md)
- [FAQ](https://docs.illuminate.finance/faq.md): Frequently Asked Questions


---

# 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, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.illuminate.finance/illuminate-defi-fixed.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
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.