# Kamui

- [Welcome](https://docs.kamui.finance/index.md): Kamui Finance is an on-chain asset allocation platform offering programmatically managed, risk-tiered yield vaults backed by tokenised real-world assets (RWA).
- [Quick Guide](https://docs.kamui.finance/quick-guide.md): The day-to-day depositor experience — making a deposit, tracking a position, and requesting a withdrawal.
- [Product Architecture](https://docs.kamui.finance/product-architecture.md): The three platform layers — Vault Operations, the Kamui Backend Core, and the web app — and the Lagoon ERC-7540 protocol underneath.
- [Transparency](https://docs.kamui.finance/transparency.md): On-chain asset transparency, NAV and pricing, methodology and definitions, and the underlying assets.
- [Allocation Risk Management](https://docs.kamui.finance/risk-management.md): The eight-stage asset selection framework, composition rules, and continuous risk monitoring.
- [Security](https://docs.kamui.finance/security.md): Audited third-party vault infrastructure, automated monitoring with documented pause criteria, and a formal incident-response process.
- [Legal & Compliance & Policies](https://docs.kamui.finance/legal-compliance.md): Legal structure, eligibility and compliance, risk disclosure, and platform policies.
- [Contact](https://docs.kamui.finance/contact.md): Enquiries, frequently asked questions, support, and developer resources.
- [API overview](https://docs.kamui.finance/api/overview.md): Read Kamui vault and wallet data, and build unsigned deposit and redeem request transactions, from your backend with your own API key.
- [Authentication](https://docs.kamui.finance/api/authentication.md): Each client calls the API with its own API key, sent in the x-partner-api-key header.
- [Build transactions](https://docs.kamui.finance/api/transactions.md): Quote and build the unsigned transactions that deposit USDC into a vault or create a redeem request on it.
- [Postman collection](https://docs.kamui.finance/api/postman.md): Try every action from Postman, with example responses and tests that check each answer.
- [Errors](https://docs.kamui.finance/api/errors.md): Every error answers a fixed code, a message and the request id.
- [Data conventions](https://docs.kamui.finance/api/data-conventions.md): Amounts, prices, APR, timestamps, addresses, vault slugs and response times in API requests and responses.
- [Check the API and your key](https://docs.kamui.finance/api-reference/health-ping.md): Checks that the function is up and that your API key works. Send an empty JSON object. A 200 with `status: "ok"` means the key was accepted.
- [List vaults](https://docs.kamui.finance/api-reference/vaults-list.md): Every public Kamui vault with its live state, in the order the Kamui app lists them. Send an empty JSON object.
- [Get a vault](https://docs.kamui.finance/api-reference/vaults-get.md): One vault, read the same way as `vaults.list`.
- [Get vault history](https://docs.kamui.finance/api-reference/vaults-history.md): Share price (`metric: "share_price"`) or TVL (`metric: "tvl"`) history of one vault, in its deposit asset.
- [Get wallet positions](https://docs.kamui.finance/api-reference/users-positions.md): Positions of one wallet in every active vault, read at one block (`blockNumber`).
- [List wallet transactions](https://docs.kamui.finance/api-reference/users-transactions.md): Transaction history of one wallet in every active vault, or in one vault with `slug`, with the request statuses the Kamui app shows.
- [Quote a transaction](https://docs.kamui.finance/api-reference/transaction-quote.md): Prices a `DEPOSIT` or a `REDEEM_REQUEST` for the vault `slug` names, at one block (`blockNumber`). It builds no transaction.
- [Build a transaction](https://docs.kamui.finance/api-reference/transaction-build.md): Builds a `DEPOSIT` or a `REDEEM_REQUEST` for the vault `slug` names: it runs the checks below in order (the first failure answers), returns the unsigned transactions and simulates them. Nothing is signed or sent.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.