# DeFi Orbit API

> On-chain data infrastructure for DeFi positions. LP and lending position data — PnL, fees, impermanent loss, APR, and risk — across 10+ chains through one REST API and MCP.

- [Introduction](https://docs.defiorbit.xyz/index.md): DeFi Orbit is on-chain data infrastructure for DeFi positions — a multi-chain data API built for funds, market makers, and the teams building on DeFi.
- [Quickstart](https://docs.defiorbit.xyz/quickstart.md): Create an API key and retrieve a wallet’s Uniswap V3 position counts.
- [Dashboard](https://docs.defiorbit.xyz/dashboard.md): Manage API keys, credits, usage, and DeFi Orbit AI from the dashboard.
- [For AI agents](https://docs.defiorbit.xyz/agents.md): The DeFi Orbit API contract on one page: auth, retries, credits, pagination, and MCP.
- [Authentication](https://docs.defiorbit.xyz/authentication.md): Authenticate every DeFi Orbit API request with a bearer API key.
- [Credits](https://docs.defiorbit.xyz/credits.md): How fixed and per-result credit costs are charged.
- [Pagination](https://docs.defiorbit.xyz/pagination.md): Page through list results, see which count credits use, and how many wallets a batch accepts.
- [Errors and rate limits](https://docs.defiorbit.xyz/errors.md): Status codes, error JSON, and which failures to retry.
- [Protocols and chains](https://docs.defiorbit.xyz/protocols.md): Which chain ids and route families each protocol supports.
- [Data methodology](https://docs.defiorbit.xyz/methodology.md): What each PnL, APR, fee, impermanent loss, and risk figure represents.
- [Versioning](https://docs.defiorbit.xyz/versioning.md): How the API evolves without breaking your integration.
- [Liquidity positions](https://docs.defiorbit.xyz/recipes/lp-positions.md): Read Uniswap V3, Aerodrome V3, and Orca LP positions for a wallet.
- [Lending positions](https://docs.defiorbit.xyz/recipes/lending.md): Check Aave V3, Morpho, and Kamino health, then load positions and calculations.
- [PnL, yield, and snapshots](https://docs.defiorbit.xyz/recipes/pnl-and-yield.md): Choose the current health check, daily history, or the full position payload.
- [Batch wallets](https://docs.defiorbit.xyz/recipes/batch.md): Read many wallets in one POST.
- [What is DeFi Orbit?](https://docs.defiorbit.xyz/guides/what-is-defi-orbit.md): DeFi Orbit is a multi-chain portfolio management platform built specifically for liquidity providers. We help you track, analyze, and optimize your DeFi positions across multiple blockchains—all in one place.
- [Quick Start Guide](https://docs.defiorbit.xyz/guides/quick-start-guide.md): Get started with DeFi Orbit in just a few minutes. Follow these simple steps to connect your wallet and start tracking your DeFi positions.
- [Key Features](https://docs.defiorbit.xyz/guides/key-features.md): DeFi Orbit gives you everything you need to track, analyze, and optimize your liquidity positions across multiple chains. Here's what makes our platform different.
- [Portfolio Dashboard (Pools)](https://docs.defiorbit.xyz/guides/portfolio-dashboard-pools.md): Your Portfolio Dashboard is the command center for monitoring all your DeFi positions. It provides a real-time overview of your liquidity pools, lending positions, and overall portfolio performance across all supported chains.
- [Position Cards (Dashboard)](https://docs.defiorbit.xyz/guides/position-cards-dashboard.md): View comprehensive information about individual liquidity positions by clicking on any position card in your dashboard.
- [Lending & Borrowing Cards (Dashboard)](https://docs.defiorbit.xyz/guides/lending-borrowing-cards-dashboard.md): Monitor your lending and borrowing positions across protocols with real-time health factor tracking and risk assessment.
- [Portfolio Page](https://docs.defiorbit.xyz/guides/portfolio-page.md): The Portfolio page shows everything your wallets hold—tokens, DeFi positions, and DApp balances—with breakdowns by wallet and chain and a value chart over time.
- [Wallets Manager](https://docs.defiorbit.xyz/guides/wallets-manager.md): Add, label, and organize the wallets DeFi Orbit tracks for you. Tracking is read-only: you paste an address, and we read public on-chain data—no keys, no custody.
- [Notifications & Alerts](https://docs.defiorbit.xyz/guides/notifications-alerts.md): Get alerted before a lending position approaches liquidation. Set a health factor threshold per wallet and receive alerts by Telegram, Email, or Discord.
- [Swap & Bridge](https://docs.defiorbit.xyz/guides/swap-and-bridge.md): Swap tokens and bridge between chains without leaving DeFi Orbit. Powered by LI.FI, signed in your own wallet—DeFi Orbit never holds your funds.
- [Demo View](https://docs.defiorbit.xyz/guides/demo-view.md): Browse DeFi Orbit without an account. The demo view opens a real portfolio with live-looking data so you can explore every screen before signing up.
- [Updating Your Username](https://docs.defiorbit.xyz/guides/updating-your-username.md): Change your DeFi Orbit username anytime from your account settings.
- [Updating your Yield Income Target](https://docs.defiorbit.xyz/guides/updating-your-yield-income-target.md): Change your annual yield income goal anytime to reflect your evolving investment strategy.
- [Risk Profile Assessment](https://docs.defiorbit.xyz/guides/risk-profile-assessment.md): Understand your DeFi investing style and get personalized portfolio guidance based on your risk profile.
- [Plans & Billing](https://docs.defiorbit.xyz/guides/plans-and-billing.md): Every new account starts with a 7-day free trial of the Advanced plan, no card required. Here's what each plan controls and how billing works.
- [Portfolio Enterprise](https://docs.defiorbit.xyz/guides/enterprise.md): Run your clients' DeFi portfolios from one account. Enterprise adds client sub-accounts, shareable portfolio links, and a daily audit trail on top of the full DeFi Orbit app.
- [Audit Trail](https://docs.defiorbit.xyz/guides/audit-trail.md): A dated record of every portfolio you run. DeFi Orbit snapshots your portfolio's net worth every day, then shows the history as a table, a daily PnL chart, and a calendar.
- [Founding & Charter Members](https://docs.defiorbit.xyz/guides/founding-charter-members.md): DeFi Orbit recognizes and honors our earliest believers—the users who had faith in our vision before the masses arrived. These special membership tiers celebrate the people who supported us from the beginning.
- [Get started](https://docs.defiorbit.xyz/recipes/mcp.md): Connect an MCP client to the same API key, credits, and rate limit as a direct call.
- [Tool reference](https://docs.defiorbit.xyz/ai/tools.md): The 52 read-only tools DeFi Orbit AI exposes, grouped by protocol.
- [Get Portfolio Balance](https://docs.defiorbit.xyz/api-reference/portfolio/balance.md): Total USD value of a wallet, broken down by chain.
- [Get Portfolio Assets](https://docs.defiorbit.xyz/api-reference/portfolio/assets.md): Every token the wallet holds, per chain, with live USD pricing — the raw token list behind the balance total.
- [Get Uniswap V3 Summary](https://docs.defiorbit.xyz/api-reference/uniswap-v3/summary.md): Wallet-level counts only — active vs. inactive positions.
- [List Uniswap V3 Positions](https://docs.defiorbit.xyz/api-reference/uniswap-v3/list.md): All active LP positions for a wallet. A live USDC/HYPE LP on Unichain (chain 130) is a good real example — this wallet also has 12 closed positions across Optimism, Arbitrum, and Ethereum mainnet, visible with `status=inactive`.
- [Get Uniswap V3 Position](https://docs.defiorbit.xyz/api-reference/uniswap-v3/get.md): Raw on-chain state for a single position: ticks, pool, tokens, liquidity.
- [Get Position Events](https://docs.defiorbit.xyz/api-reference/uniswap-v3/events.md): Position history for one LP position: deposits (IncreaseLiquidity), withdrawals (DecreaseLiquidity), fee collections, and compounds (Collect). Each event has token amounts, token prices at the transaction (token0PriceUSD, token1PriceUSD), timestamp, and transaction_hash. USD value is amount times th…
- [Get Position Historical Performance](https://docs.defiorbit.xyz/api-reference/uniswap-v3/snapshots.md): Daily history chart for one LP position: mint genesis point, then one row per UTC day. rewards is 0 (Uniswap has no reward token). This is not the current health check — that is GET /:id/snapshot.
- [Get Position Snapshot](https://docs.defiorbit.xyz/api-reference/uniswap-v3/snapshot.md): A one-shot health check: current value, in/out of range, PnL, and APR. Not the daily history chart — use GET /:id/snapshots for historical performance.
- [Get Position PnL](https://docs.defiorbit.xyz/api-reference/uniswap-v3/pnl.md): Just the profit/loss numbers, pulled out of the `full` payload.
- [Get Position Yield](https://docs.defiorbit.xyz/api-reference/uniswap-v3/yield.md): Fee/reward accrual. projected_yield_apr and estimated_total_yield match the position page. earned_apr_percentage is historical earned APR and stays non-zero out of range. unclaimed_fees is Pending Fees. unclaimed_rewards is Pending Rewards.
- [Get Full Position Detail](https://docs.defiorbit.xyz/api-reference/uniswap-v3/full.md): Everything: state, full event history, PnL, impermanent loss, fee accrual, and APR — the "give me all of it" endpoint. The heaviest-weight endpoint in the catalog — reach for `pnl`, `yield`, or `snapshot` if you don't need the whole payload.
- [Batch Get Uniswap V3 Positions](https://docs.defiorbit.xyz/api-reference/uniswap-v3/batch.md): Same as the list endpoint, multiple wallets in one POST. Returns the same shape as `?full=true` on the list endpoint, one array per wallet — for scanning many addresses at once.
- [Get Aerodrome V3 Summary](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/summary.md): Wallet-level counts only — active vs. inactive Slipstream CL positions on Base.
- [List Aerodrome V3 Positions](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/list.md): All active Slipstream CL positions for a wallet on Base (chain_id=8453). Use status=inactive for closed positions.
- [Get Aerodrome V3 Position](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/get.md): Raw on-chain state for a single Slipstream position: ticks, pool, tokens, liquidity.
- [Get Aerodrome V3 Position Events](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/events.md): Position history for one Slipstream LP position: deposits (IncreaseLiquidity), withdrawals (DecreaseLiquidity), fee collections, and compounds (Collect). Each event has token amounts, token prices at the transaction (token0PriceUSD, token1PriceUSD), timestamp, and transaction_hash. USD value is amou…
- [Get Aerodrome V3 Historical Performance](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/snapshots.md): Daily history chart for one Slipstream position: mint genesis point, then one row per UTC day. rewards is the cumulative AERO token amount (not USD). This is not the current health check — that is GET /:id/snapshot.
- [Get Aerodrome V3 Position Snapshot](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/snapshot.md): A one-shot health check: current value, in/out of range, PnL, and APR. Not the daily history chart — use GET /:id/snapshots for historical performance.
- [Get Aerodrome V3 Position PnL](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/pnl.md): Just the profit/loss numbers, pulled out of the full payload.
- [Get Aerodrome V3 Position Yield](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/yield.md): Fee and AERO reward accrual. projected_yield_apr and estimated_total_yield match the position page. earned_apr_percentage is historical earned APR and stays non-zero out of range. unclaimed_fees is Pending Fees. unclaimed_rewards is Pending Rewards.
- [Get Full Aerodrome V3 Position Detail](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/full.md): Everything: state, full event history, PnL, impermanent loss, fee and AERO reward accrual, and APR. The heaviest endpoint — prefer snapshot/pnl/yield if you don't need the whole payload.
- [Batch Get Aerodrome V3 Positions](https://docs.defiorbit.xyz/api-reference/aerodrome-v3/batch.md): Same as the list endpoint, multiple wallets in one POST. Returns the same shape as ?full=true on the list endpoint — for scanning many addresses at once on Base.
- [Get Orca Summary](https://docs.defiorbit.xyz/api-reference/orca/summary.md): Wallet-level counts only — active vs. inactive whirlpool and DeFiTuna LP positions on Solana.
- [List Orca Positions](https://docs.defiorbit.xyz/api-reference/orca/list.md): All active Orca whirlpool (and DeFiTuna-wrapped) LP positions for a Solana wallet. Closed positions are visible with `status=inactive`.
- [Get Orca Position](https://docs.defiorbit.xyz/api-reference/orca/get.md): Raw on-chain state for a single whirlpool position: ticks, pool, liquidity. Pass `wallet` to attach DeFiTuna lending info when the position is tuna-wrapped.
- [Batch Get Orca Positions](https://docs.defiorbit.xyz/api-reference/orca/batch.md): Same as the list endpoint, multiple Solana wallets in one POST. Returns the same shape as `?full=true` on the list endpoint — for scanning many addresses at once.
- [Get Aave V3 Summary](https://docs.defiorbit.xyz/api-reference/aave-v3/summary.md): Lightweight per-chain "is this wallet at risk anywhere" check from the lending indexer — no position detail, just chain IDs and an `at_risk` flag (health factor below 1.5). Optional `market_id` (main / lido / horizon) to scope one market.
- [Get Aave V3 Position (all chains)](https://docs.defiorbit.xyz/api-reference/aave-v3/position.md): Live Aave V3 positions from the lending indexer, one entry per chain, without calculation fields. Optional `market_id` to filter main / lido / horizon.
- [Get Position Events](https://docs.defiorbit.xyz/api-reference/aave-v3/events.md): Position history: supply, borrow, withdraw, repay, and liquidation for one chain. Optional `market_id` (default main). Each event has type, amount, amountUSD, priceUSD, asset details, and transactionHash. Newest first.
- [Get Position Historical Performance](https://docs.defiorbit.xyz/api-reference/aave-v3/snapshots.md): Historical performance: daily Aave V3 position snapshots for the history chart. `max_snapshots` is a day count; omit it for the full indexed series. Optional `market_id` (default main).
- [Get Position Risk](https://docs.defiorbit.xyz/api-reference/aave-v3/risk.md): Liquidation distance, LTV, and per-asset risk breakdown for one chain's live position. Optional `market_id` (default main) and `target_health_factor` (default 1.5) for the safe borrow/withdraw slider.
- [Get Position Yield](https://docs.defiorbit.xyz/api-reference/aave-v3/yield.md): Daily/weekly/monthly/yearly interest earned vs. paid, plus net APY. Optional `market_id` (default main) and `target_health_factor` (default 1.5).
- [List Aave V3 Positions](https://docs.defiorbit.xyz/api-reference/aave-v3/bundle.md): Live Aave V3 lending/borrowing positions for a wallet from the lending indexer, one entry per chain, with calculations. Optional `market_id` and `target_health_factor` (default 1.5).
- [Batch Get Aave V3 Positions](https://docs.defiorbit.xyz/api-reference/aave-v3/batch.md): Same as the list endpoint, but accepts multiple wallets in one POST. Returns an array in the same shape as the list endpoint, one entry per wallet/chain pair. Optional `market_id` and `target_health_factor` in the body.
- [Get Morpho Summary](https://docs.defiorbit.xyz/api-reference/morpho/summary.md): Lightweight per-chain "is this wallet at risk anywhere" check from the lending indexer — no position detail, just chain IDs and an `at_risk` flag (health factor below 1.5 on any isolated market). Optional `market_id` (bytes32) to scope one market.
- [Get Morpho Position (all chains)](https://docs.defiorbit.xyz/api-reference/morpho/position.md): Live Morpho Blue positions from the lending indexer, one bundle per chain, without calculation fields. Each entry inside the bundle is an isolated market. Optional `market_id` (0x + 64 hex) to filter one market.
- [Get Position Events](https://docs.defiorbit.xyz/api-reference/morpho/events.md): Position history: supply, borrow, withdraw, repay, and liquidation for one chain. Each event has type, amount, amountUSD, priceUSD, asset details, and transactionHash. market_id is optional; each event names its market. Newest first.
- [Get Position Historical Performance](https://docs.defiorbit.xyz/api-reference/morpho/snapshots.md): Historical performance: daily Morpho Blue position snapshots for the history chart. `max_snapshots` is a day count; omit it for the full indexed series. Optional `market_id` to scope one isolated market.
- [Get Position Risk](https://docs.defiorbit.xyz/api-reference/morpho/risk.md): Health factor, LTV, and safe borrow/withdraw amounts for one isolated Morpho market. `market_id` (bytes32) is required. Optional `target_health_factor` (default 1.5).
- [Get Position Yield](https://docs.defiorbit.xyz/api-reference/morpho/yield.md): Daily interest earned vs. paid, net APY, and projections for one isolated Morpho market. `market_id` (bytes32) is required. Optional `target_health_factor` (default 1.5).
- [List Morpho Positions](https://docs.defiorbit.xyz/api-reference/morpho/bundle.md): Live Morpho Blue positions for a wallet from the lending indexer, one bundle per chain, with calculations. Each position is an isolated market. Optional `market_id` and `target_health_factor` (default 1.5).
- [Batch Get Morpho Positions](https://docs.defiorbit.xyz/api-reference/morpho/batch.md): Same as the list endpoint, but accepts multiple wallets in one POST (max 10). Returns one entry per wallet/chain pair. Optional `market_id` and `target_health_factor` in the body.
- [Get Kamino Summary](https://docs.defiorbit.xyz/api-reference/kamino/summary.md): Wallet-level obligation count and at-risk flag (health factor below 1.5). Cheapest Kamino call — use this to poll whether a wallet needs attention before fetching full detail.
- [List Kamino Positions](https://docs.defiorbit.xyz/api-reference/kamino/position.md): All active Kamino obligations for a wallet. Market name, market address, and obligation address are on position, with collateral and debt. Same item shape as the bundle, including calculations. Use it to discover obligation addresses before calling risk, yield, or events.
- [Get Kamino Bundle](https://docs.defiorbit.xyz/api-reference/kamino/bundle.md): All active Kamino obligations with full position data and risk/yield calculations — health factor, LTV, interest rates, APY projections. One entry per active market obligation.
- [Batch Get Kamino Positions](https://docs.defiorbit.xyz/api-reference/kamino/batch.md): Same as the bundle endpoint but accepts multiple Solana wallets in one POST (max 5 — Kamino checks 38+ isolated markets per wallet). Returns the same shape per obligation across all wallets.
- [Get Obligation Events](https://docs.defiorbit.xyz/api-reference/kamino/events.md): Raw obligation history from Kamino's analytics: blockTimestamp, market and obligation addresses, and a nested snapshot (collateral, debt, net worth, health factor). Not a transaction list, and not the mapped snapshots body. Requires market_address from the list or bundle endpoint.
- [Get Obligation Historical Performance](https://docs.defiorbit.xyz/api-reference/kamino/snapshots.md): Historical performance for one Kamino obligation: collateral, debt, net worth, and health factor over time, mapped from the same Kamino history GET .../events returns raw. Requires market_address.
- [Get Obligation Risk](https://docs.defiorbit.xyz/api-reference/kamino/risk.md): Health factor, LTV, and safe borrow/withdraw amounts for a single Kamino obligation. Requires market_address.
- [Get Obligation Yield](https://docs.defiorbit.xyz/api-reference/kamino/yield.md): Daily/weekly/monthly/yearly interest earned vs. paid, net APY, leverage, and weighted supply/borrow APY for a single Kamino obligation.
- [Get Remaining Credits](https://docs.defiorbit.xyz/api-reference/usage/credits.md): Credits left for your organization, split into Grants (manual grants and the recurring-grant bucket) and Purchased Credits (everything else). Balances are after this call's 1-credit charge.
- [List API Request Logs](https://docs.defiorbit.xyz/api-reference/usage/logs.md): Paginated request history for your organization. Filter by time range, API key, endpoint, HTTP status, and success/errors.
- [Chains and protocols](https://docs.defiorbit.xyz/coverage/chains.md): Every network and protocol DeFi Orbit covers, and where each is available.
- [API Platform](https://docs.defiorbit.xyz/changelog.md): Shipped changes to the DeFi Orbit API, docs, and coverage.
- [Portfolio App](https://docs.defiorbit.xyz/changelog/portfolio.md): Shipped changes to the DeFi Orbit Portfolio app.

## OpenAPI Specs

- [openapi](/openapi.yaml)

## Optional

- [Status](https://defiorbit.xyz/status)


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