# Hedgin

- [Hedgin documentation](https://docs.hedgin.xyz/index.md): Hedgin runs Solana investment vaults with program-enforced custody. Learn how to deposit, manage a vault, or build a bot.
- [Start here](https://docs.hedgin.xyz/start-here.md): Pick the right Hedgin tool for your goal: the website, the manager console, the manager bot API, the SDK, or a direct program integration.
- [How the Hedgin protocol works](https://docs.hedgin.xyz/concepts/protocol.md): Who holds the money, who can move it, and which rules a Solana program enforces for every Hedgin vault.
- [Vaults, shares, and NAV](https://docs.hedgin.xyz/concepts/vaults-and-nav.md): How a Hedgin vault prices its shares, when requests settle, how fees are charged, and what the status and pause switches block.
- [How Hedgin transactions work](https://docs.hedgin.xyz/concepts/transactions.md): Why every Hedgin action passes through four separate stages, and why only on-chain confirmation means it succeeded.
- [Deposit into and withdraw from a vault](https://docs.hedgin.xyz/depositors/deposits-and-withdrawals.md): Request a deposit or a withdrawal on the Hedgin website, follow it until it settles, and cancel it if you change your mind.
- [Manage a vault](https://docs.hedgin.xyz/managers/overview.md): Run a Hedgin vault from start to finish in the manager console: get whitelisted, create the vault, set fees, invest, handle requests, claim fees, and close it.
- [Swap vault tokens with Jupiter](https://docs.hedgin.xyz/managers/jupiter-swaps.md): Swap a vault's tokens through Jupiter in the manager console, set slippage, and sell a token back to the deposit token.
- [Provide liquidity with Meteora DLMM](https://docs.hedgin.xyz/managers/meteora-dlmm.md): Open, manage, and exit Meteora DLMM liquidity positions and limit orders from a Hedgin vault.
- [Trade perpetuals with Phoenix](https://docs.hedgin.xyz/managers/phoenix-perps.md): Set up a USDC vault's Phoenix trading account, move collateral, place and cancel orders, and wind the account down.
- [Telegram bot](https://docs.hedgin.xyz/managers/telegram-bot.md): Manage a Hedgin vault from Telegram: wallets, reads, swaps, Meteora DLMM positions, Phoenix perps, and vault settings, with a confirm screen before every transaction.
- [Manager bot API](https://docs.hedgin.xyz/api-reference/introduction.md): What the Hedgin manager bot API V1 does, who it is for, and how its endpoints fit together.
- [Getting started](https://docs.hedgin.xyz/api-reference/getting-started.md): Make a first read, build a swap, and send it with the Hedgin manager bot API.
- [Authentication](https://docs.hedgin.xyz/api-reference/authentication.md): API key format, scopes, vault access checks, and what to do when a key or manager keypair leaks.
- [Units and views](https://docs.hedgin.xyz/api-reference/units-and-views.md): How the manager bot API encodes amounts, prices, bin ids, and public keys, and what the read responses contain.
- [Send and status](https://docs.hedgin.xyz/api-reference/send-and-status.md): Sign builds, send them in the right order, follow batches and next steps, and confirm the outcome.
- [Errors and limits](https://docs.hedgin.xyz/api-reference/errors-and-limits.md): Error format, HTTP status codes, error codes, rate limits, and request size limits of the manager bot API.
- [Examples](https://docs.hedgin.xyz/api-reference/examples.md): Copyable calls for reads and builds, and a TypeScript loop that signs, sends, and confirms every step of a build.
- [List vaults](https://docs.hedgin.xyz/api-reference/vault-reads/list-vaults.md): Requires key scope `read`.
- [Get vault](https://docs.hedgin.xyz/api-reference/vault-reads/get-vault.md): Requires key scope `read`.
- [Get holdings](https://docs.hedgin.xyz/api-reference/vault-reads/get-holdings.md): Requires key scope `read`.
- [List open strategies](https://docs.hedgin.xyz/api-reference/vault-reads/list-open-strategies.md): Requires key scope `read`.
- [Get NAV history](https://docs.hedgin.xyz/api-reference/vault-reads/get-nav-history.md): Requires key scope `read`.
- [Get open requests](https://docs.hedgin.xyz/api-reference/vault-reads/get-open-requests.md): Requires key scope `read`.
- [Get closed strategies](https://docs.hedgin.xyz/api-reference/vault-reads/get-closed-strategies.md): Requires key scope `read`.
- [Get Phoenix state](https://docs.hedgin.xyz/api-reference/vault-reads/get-phoenix-state.md): Requires key scope `read`.
- [Get swap quote](https://docs.hedgin.xyz/api-reference/market-reads/get-swap-quote.md): Requires key scope `read`.
- [Search DLMM pools](https://docs.hedgin.xyz/api-reference/market-reads/search-dlmm-pools.md): Requires key scope `read`.
- [Get DLMM pool](https://docs.hedgin.xyz/api-reference/market-reads/get-dlmm-pool.md): Requires key scope `read`.
- [Get token](https://docs.hedgin.xyz/api-reference/market-reads/get-token.md): Requires key scope `read`.
- [Create Jupiter strategy](https://docs.hedgin.xyz/api-reference/jupiter-transactions/create-jupiter-strategy.md): Requires key scope `jupiter/initialize`.
- [Swap tokens](https://docs.hedgin.xyz/api-reference/jupiter-transactions/swap-tokens.md): Requires key scope `jupiter/swap`.
- [Sell all of a token and close its strategy](https://docs.hedgin.xyz/api-reference/jupiter-transactions/sell-all-of-a-token-and-close-its-strategy.md): Requires key scope `jupiter/sweep`.
- [Create empty DLMM position](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/create-empty-dlmm-position.md): Requires key scope `dlmm/initialize`.
- [Open and fund DLMM position](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/open-and-fund-dlmm-position.md): Requires key scope `dlmm/open`.
- [Add liquidity](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/add-liquidity.md): Requires key scope `dlmm/add`.
- [Fund a wide position](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/fund-a-wide-position.md): Requires key scope `dlmm/add-range`.
- [Extend a position](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/extend-a-position.md): Requires key scope `dlmm/extend`.
- [Remove liquidity](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/remove-liquidity.md): Requires key scope `dlmm/remove`.
- [Flip bins to the other side](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/flip-bins-to-the-other-side.md): Requires key scope `dlmm/flip`.
- [Claim position fees](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/claim-position-fees.md): Requires key scope `dlmm/claim-fee`.
- [Exit position to deposit token](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/exit-position-to-deposit-token.md): Requires key scope `dlmm/zap-out`.
- [Swap zap-out proceeds](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/swap-zap-out-proceeds.md): Requires key scope `dlmm/zap-out/swap`.
- [Close DLMM position](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/close-dlmm-position.md): Requires key scope `dlmm/close`.
- [Place DLMM limit order](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/place-dlmm-limit-order.md): Requires key scope `dlmm/limit-order/place`.
- [Cancel DLMM limit order](https://docs.hedgin.xyz/api-reference/meteora-dlmm-transactions/cancel-dlmm-limit-order.md): Requires key scope `dlmm/limit-order/cancel`.
- [Create Phoenix strategy](https://docs.hedgin.xyz/api-reference/phoenix-transactions/create-phoenix-strategy.md): Requires key scope `phoenix/initialize`.
- [Build Phoenix onboarding](https://docs.hedgin.xyz/api-reference/phoenix-transactions/build-phoenix-onboarding.md): Requires key scope `phoenix/onboard`.
- [Deposit Phoenix collateral](https://docs.hedgin.xyz/api-reference/phoenix-transactions/deposit-phoenix-collateral.md): Requires key scope `phoenix/deposit`.
- [Withdraw Phoenix collateral](https://docs.hedgin.xyz/api-reference/phoenix-transactions/withdraw-phoenix-collateral.md): Requires key scope `phoenix/withdraw`.
- [Place Phoenix order](https://docs.hedgin.xyz/api-reference/phoenix-transactions/place-phoenix-order.md): Requires key scope `phoenix/order`.
- [Cancel Phoenix orders](https://docs.hedgin.xyz/api-reference/phoenix-transactions/cancel-phoenix-orders.md): Requires key scope `phoenix/cancel`.
- [Unwrap queued Phoenix withdrawal](https://docs.hedgin.xyz/api-reference/phoenix-transactions/unwrap-queued-phoenix-withdrawal.md): Requires key scope `phoenix/sweep`.
- [Create vault](https://docs.hedgin.xyz/api-reference/vault-and-strategy-transactions/create-vault.md): Requires key scope `vault/initialize`.
- [Update vault settings](https://docs.hedgin.xyz/api-reference/vault-and-strategy-transactions/update-vault-settings.md): Requires key scope `vault/update`.
- [Claim manager fee](https://docs.hedgin.xyz/api-reference/vault-and-strategy-transactions/claim-manager-fee.md): Requires key scope `vault/claim-fee`.
- [Close vault](https://docs.hedgin.xyz/api-reference/vault-and-strategy-transactions/close-vault.md): Requires key scope `vault/close`.
- [Close strategy](https://docs.hedgin.xyz/api-reference/vault-and-strategy-transactions/close-strategy.md): Requires key scope `strategy/close`.
- [Send signed transaction](https://docs.hedgin.xyz/api-reference/send-and-status/send-signed-transaction.md): Requires key scope `send` and the builder action that produced the ticket.
- [Submit Phoenix onboarding](https://docs.hedgin.xyz/api-reference/send-and-status/submit-phoenix-onboarding.md): Requires key scopes `send` and `phoenix/onboard`.
- [Get transaction status](https://docs.hedgin.xyz/api-reference/send-and-status/get-transaction-status.md): Requires key scope `send`.
- [SDK overview](https://docs.hedgin.xyz/sdk/overview.md): Install @hedginvault/sdk, create a client, and run a manager action from build to confirmation in one call.
- [Reads](https://docs.hedgin.xyz/sdk/reads.md): Every HedgeClient read method with its API route, return type, and an example, plus the unit helpers.
- [Actions](https://docs.hedgin.xyz/sdk/actions.md): Every action that HedgeClient.execute runs, with its request body, notes, an example, and the API key scope it needs.
- [Execute and safety](https://docs.hedgin.xyz/sdk/safety.md): How execute builds, inspects, signs, sends, and confirms transactions, what the signing policy refuses, and why an unknown outcome is never retried by rebuilding.
- [API checker](https://docs.hedgin.xyz/sdk/api-checker.md): Run hedge-check-api to probe a live Hedgin manager API for auth, routing, validation, error hygiene, and drift from the SDK's schemas.

## OpenAPI Specs

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


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