> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allium.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Track realtime DeFi positions across liquidity pools, lending protocols, and staking platforms.

## Supported Chains

| Chain                                                                                                                                                                                               | Chain ID      | Status |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------ |
| <img src="https://icons.llamao.fi/icons/chains/rsz_arbitrum.jpg" alt="Arbitrum" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Arbitrum          | `arbitrum`    | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_avalanche.jpg" alt="Avalanche" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Avalanche       | `avalanche`   | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_base.jpg" alt="Base" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Base                      | `base`        | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_blast.jpg" alt="Blast" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Blast                   | `blast`       | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_binance.jpg" alt="BSC" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />BSC                     | `bsc`         | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_celo.jpg" alt="Celo" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Celo                      | `celo`        | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_ethereum.jpg" alt="Ethereum" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Ethereum          | `ethereum`    | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_hyperliquid.jpg" alt="Hyperliquid" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Hyperliquid | `hyperliquid` | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_megaeth.jpg" alt="MegaETH" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />MegaETH             | `megaeth`     | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_monad.jpg" alt="Monad" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Monad                   | `monad`       | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_optimism.jpg" alt="Optimism" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Optimism          | `optimism`    | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_plasma.jpg" alt="Plasma" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Plasma                | `plasma`      | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_polygon.jpg" alt="Polygon" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Polygon             | `polygon`     | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_solana.jpg" alt="Solana" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Solana                | `solana`      | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_soneium.jpg" alt="Soneium" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Soneium             | `soneium`     | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_unichain.jpg" alt="Unichain" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Unichain          | `unichain`    | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_world chain.jpg" alt="World Chain" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />World Chain | `worldchain`  | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_x layer.jpg" alt="X Layer" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />X Layer             | `x_layer`     | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_zksync era.jpg" alt="zkSync" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />zkSync            | `zksync`      | ✅ Live |
| <img src="https://icons.llamao.fi/icons/chains/rsz_zora.jpg" alt="Zora" width="20" height="20" style={{display: "inline", verticalAlign: "middle", marginRight: "6px"}} />Zora                      | `zora`        | ✅ Live |

## Supported Protocols

### Liquidity Pool Positions

<AccordionGroup>
  <Accordion title="EVM: Uniswap V2" icon="water">
    Track LP positions in Uniswap V2 pools across all supported chains.

    **Features:**

    * Position ownership and balances
    * Pool composition and reserves
    * Fee tier information
  </Accordion>

  <Accordion title="EVM: Uniswap V3" icon="droplet">
    Track concentrated liquidity positions with range information.

    **Features:**

    * NFT-based position tracking
    * Tick range and liquidity
    * Fee tier and position status

    <Info>Historical backfill in progress</Info>
  </Accordion>

  <Accordion title="EVM: Uniswap V4" icon="water-ladder">
    Track hook-enabled liquidity positions in Uniswap V4.

    **Features:**

    * Hook-based position logic
    * Custom pool configurations
    * Advanced liquidity management

    <Info>Historical backfill in progress</Info>
  </Accordion>

  <Accordion title="EVM: PancakeSwap V3" icon="cake-candles">
    Track concentrated liquidity positions in PancakeSwap V3 pools.

    **Features:**

    * NFT-based position tracking (Uniswap V3 fork)
    * Tick range and liquidity
    * Fee tier and position status
  </Accordion>

  <Accordion title="Solana: Raydium CLMM" icon="droplet">
    Track concentrated liquidity positions on Raydium.

    **Features:**

    * Concentrated liquidity position tracking
    * Tick range and liquidity
    * Fee tier and position status
  </Accordion>

  <Accordion title="Solana: Meteora DLMM" icon="droplet">
    Track dynamic liquidity market maker positions on Meteora.

    **Features:**

    * DLMM bin-based position tracking
    * Active bin range and liquidity
    * Fee tier and position status
  </Accordion>
</AccordionGroup>

### Lending Positions

<AccordionGroup>
  <Accordion title="Aave V3" icon="coins">
    Track lending and borrowing positions on Aave V3.

    **Features:**

    * Supplied assets and balances
    * Borrowed positions
    * Collateral and health factors
  </Accordion>

  <Accordion title="Compound V3" icon="building-columns">
    Track positions on Compound V3 (Comet) markets.

    **Features:**

    * Base asset positions
    * Collateral tracking
    * Market-specific data
  </Accordion>
</AccordionGroup>

### Hyperliquid Positions

<AccordionGroup>
  <Accordion title="Hyperliquid Regular Positions" icon="chart-line">
    Track spot token holdings on Hyperliquid.

    **Features:**

    * Spot token balances
    * Realtime price data
  </Accordion>

  <Accordion title="Hyperliquid Staking" icon="layer-group">
    Track staking positions on Hyperliquid.

    **Features:**

    * Staked token balances
    * Unclaimed rewards
    * APY tracking
  </Accordion>

  <Accordion title="Hyperliquid Perps" icon="chart-mixed">
    Track perpetual futures positions on Hyperliquid.

    **Features:**

    * Open perp positions
    * Entry price and mark price
    * Unrealized PnL
  </Accordion>
</AccordionGroup>

### Solana Positions

<AccordionGroup>
  <Accordion title="Solana Regular Positions" icon="s">
    Track standard Solana positions across various programs.

    **Features:**

    * Token account positions
    * Program-specific positions
    * Realtime balance updates
  </Accordion>
</AccordionGroup>

## Data Model

The API returns positions as a flat array in `items`, with fields varying by `position_type`. Each position includes token objects with realtime price data.

**Position types:** `LP`, `regular`, `lending`, `staked`, `perps`

<Tabs>
  <Tab title="LP">
    ```json theme={null}
    {
      "position_type": "LP",
      "chain": "ethereum",
      "address": "0x1234567890abcdef1234567890abcdef12345678",
      "position_id": "604387",
      "protocol": "uniswap_v3",
      "total_value_usd": "15234.56",
      "pool_address": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
      "fee_tier": "500",
      "in_range": true,
      "token0": {
        "chain": "ethereum",
        "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
        "price": 1.0,
        "decimals": 6,
        "symbol": "USDC"
      },
      "token1": {
        "chain": "ethereum",
        "address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
        "price": 3245.12,
        "decimals": 18,
        "symbol": "WETH"
      },
      "token0_amount": "5000.123456",
      "token1_amount": "1.543210987654321",
      "token0_amount_usd": "5000.12",
      "token1_amount_usd": "10234.44",
      "unclaimed_fees_token0": "12.345678",
      "unclaimed_fees_token1": "0.001234567890123",
      "unclaimed_fees_usd": "16.35"
    }
    ```
  </Tab>

  <Tab title="Regular">
    ```json theme={null}
    {
      "position_type": "regular",
      "chain": "solana",
      "address": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
      "token": {
        "chain": "solana",
        "address": "So11111111111111111111111111111111111111112",
        "price": 142.35,
        "decimals": 9,
        "symbol": "SOL"
      },
      "amount": "25.123456789",
      "amount_usd": "3575.82"
    }
    ```
  </Tab>

  <Tab title="Lending">
    ```json theme={null}
    {
      "position_type": "lending",
      "chain": "ethereum",
      "address": "0x1234567890abcdef1234567890abcdef12345678",
      "position_id": "aave_v3_0x1234",
      "protocol": "aave_v3",
      "total_value_usd": "42500.00",
      "pool_address": "0x87870bca3f3fd6335c3f4ce8392d69350b4fa4e2",
      "supplies": [
        {
          "token": {
            "chain": "ethereum",
            "address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
            "price": 3245.12,
            "decimals": 18,
            "symbol": "WETH"
          },
          "amount": "10.5",
          "amount_usd": "34073.76"
        }
      ],
      "borrows": [
        {
          "token": {
            "chain": "ethereum",
            "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
            "price": 1.0,
            "decimals": 6,
            "symbol": "USDC"
          },
          "amount": "8500.00",
          "amount_usd": "8500.00"
        }
      ],
      "collateral": [
        {
          "token": {
            "chain": "ethereum",
            "address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
            "price": 3245.12,
            "decimals": 18,
            "symbol": "WETH"
          },
          "amount": "10.5",
          "amount_usd": "34073.76"
        }
      ],
      "health_factor": "2.45"
    }
    ```
  </Tab>

  <Tab title="Staked">
    ```json theme={null}
    {
      "position_type": "staked",
      "chain": "ethereum",
      "address": "0x1234567890abcdef1234567890abcdef12345678",
      "position_id": "lido_steth_0x1234",
      "protocol": "lido",
      "total_value_usd": "16225.60",
      "pool_address": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84",
      "staked_token": {
        "chain": "ethereum",
        "address": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84",
        "price": 3245.12,
        "decimals": 18,
        "symbol": "stETH"
      },
      "staked_amount": "5.0",
      "staked_amount_usd": "16225.60",
      "rewards_token": {
        "chain": "ethereum",
        "address": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84",
        "price": 3245.12,
        "decimals": 18,
        "symbol": "stETH"
      },
      "unclaimed_rewards": "0.0123",
      "unclaimed_rewards_usd": "39.91",
      "apy": "3.2"
    }
    ```
  </Tab>
</Tabs>

## Coming Soon

Additional position types in development:

<CardGroup cols={2}>
  <Card title="EVM Staking" icon="layer-group">
    Monitor staking positions across EVM chains
  </Card>

  <Card title="Solana Lending" icon="coins">
    Solana lending position tracking
  </Card>
</CardGroup>
