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

# Protocol commands

> All Commands operating on the Protocol Object — protocol info, user analytics, DEX stats, launchpads, and lending.

The **Protocol** Object covers DeFi applications — DEXs, lending markets, launchpads, and other on-chain services. Protocol Commands analyze how protocols perform, who uses them, how they compare to peers, and how their underlying markets behave.

Protocol Commands are organized into **six Command Groups**, each representing a different analytical lens on protocol activity.

Which groups apply depends on the [Protocol type](/docs/core-concepts/objects/protocol#protocol-types). **Protocol Info** and **User Analytics** are shared by all Protocols; **Spot DEX**, **Perp DEX**, **Lending**, and **Launchpads** are type-specific.

## Command groups

<CardGroup cols={2}>
  <Card title="Protocol Info" icon="circle-info" href="#protocol-info">
    Protocol identity, key metrics, developer activity, and competitive comparison.
  </Card>

  <Card title="User Analytics" icon="users" href="#user-analytics">
    User acquisition, profile segmentation, and cross-protocol preference patterns.
  </Card>

  <Card title="Spot DEX" icon="arrow-right-arrow-left" href="#spot-dex">
    DEX performance, trader analysis, market listings, and peer comparison.
  </Card>

  <Card title="Perp DEX" icon="chart-candlestick" href="#perp-dex">
    Perpetual DEX performance, funding rates, open interest, and trader position analysis.
  </Card>

  <Card title="Launchpads" icon="rocket" href="#launchpads">
    Launchpad metrics, trader profitability, lifecycle, graduation, revenue, and creators.
  </Card>

  <Card title="Lending" icon="hand-holding-dollar" href="#lending">
    Lending market size, rates, liquidations, and collateral risk modeling.
  </Card>
</CardGroup>

***

## Protocol Info

Protocol identity, key metrics, developer activity, and competitive comparison.

### `PRA` Protocol Analysis

Protocol profile — identity, key metrics (TVL, users, revenue), developer activity, and protocol-specific news.

**Key data fields**

* **Info** — protocol type, category, TVL, users 24H, new users, revenue 30D, industry, tags, supported chains
* **Family** — parent/child protocol relationships and forks
* **Dev Updates** — developer activity (commits, contributors)
* **News** — protocol-specific news with sub-filters

<br />

### `PCP` Competition

Protocol competition — market share, TVL, volume, and user metrics benchmarked across peer protocols.

**Key data fields**

* Compare TVL, volume, users, revenue, and market share between selected protocols (max 5) over time

***

## User Analytics

User acquisition, profile segmentation, and cross-protocol preference patterns.

### `UAC` User Acquisition

User acquisition — active, new, returning, and churned user segmentation with daily and historical tracking.

**Key data fields**

* Active, new, returning, and churned user counts with daily real-time and historical period data
* Network-level filtering

<br />

### `UPO` User Profile

User profile — smart wallet, institutional, whale, and early bird segmentation with wallet value distribution.

**Key data fields**

* Smart wallet count, institutional / whale / early bird wallet counts, wallet value distribution (aggregated and over time)
* Network-level filtering

<br />

### `UPE` User Preference

User preference — transaction frequency segmentation and cross-protocol user overlap analysis.

**Key data fields**

* User frequency segment distribution (daily and historical)
* Cross-protocol user overlap counts between protocols

***

## Spot DEX

DEX performance, trader analysis, market listings, and peer comparison.

> Applies to **Spot DEX** Protocols.

### `DUA` DEX User Analysis

DEX user analysis — market share by trader segment, swap volume distribution, bot vs. human detection, and smart money tracking.

**Key data fields**

* Market share by users per DEX, trader type breakdown (new / returning), total unique traders, swap volume by segment, average swap size, bot vs human trade ratio and volume share

<br />

### `DEP` DEX Performance

DEX performance — key stats (volume, TVL, trades, unique traders), market listings, trend analysis, and peer rankings.

**Key data fields**

* **Key Stats** — volume 24H, TVL, trades 24H, unique traders, total markets, supported networks
* **Markets** — per-pair volume, TVL, trades, liquidity
* **Volume / TVL / Trades** — metrics over time
* **Rankings** — DEX peer ranking

<br />

### `DCP` DEX Comparison

DEX competition — volume market share and user comparison across selected DEXs with real-time and historical views.

**Key data fields**

* Compare volume, TVL, trades, and unique users between selected DEXs (max 5)
* Market share % in real-time and over time

***

## Perp DEX

Perpetual DEX performance, funding rates, open interest, and trader position analysis.

> Applies to **Perp DEX** Protocols.

### `PDPF` Perp DEX Performance

Perp DEX performance — key stats, market listings, funding rates, and open interest trends.

**Key data fields**

* **Key Stats** — volume 24H, open interest, trades 24H, unique traders, funding rate avg, liquidations 24H, total markets
* **Markets** — per-market open interest, funding rate, volume, long/short ratio, liquidations
* **Volume / OI / Trades** — metrics over time (including historical funding rate and OI trend)

<br />

### `PDUA` Perp DEX User Analysis

Perp DEX user analysis — market share by trader segment, position analysis, and leverage patterns.

**Key data fields**

* Market share by users per Perp DEX, trader type breakdown (new / returning), total unique traders, position size distribution by segment, average leverage by segment

***

## Launchpads

Launchpad metrics, trader profitability, lifecycle, graduation, revenue, and creators.

### `LPO` Launchpad Overview

Launchpad overview — 30-day key metrics (launches, graduations, volume, revenue) with period-over-period deltas.

**Key data fields**

* Tokens launched (30D), graduated count (30D), trading volume (30D), revenue (30D), graduation rate — all with % change vs prior period

<br />

### `LAC` Launch Activity

Launch activity — token creation timeline and launched token listings with lifecycle status, volume, and creator attribution.

**Key data fields**

* Token launch count over time
* Launched token list with launch date, status, volume, market cap, graduation status

<br />

### `TLC` Token Lifecycle

Token lifecycle — status distribution (active, zombie, dead, graduated) over time with failure rate analysis.

**Key data fields**

* Token status distribution over time (active / zombie / dead / graduated)
* Trading stop rate, dead rate over time

<br />

### `GDM` Graduation Metrics

Graduation metrics — graduation rate trends, time-to-graduate distribution, and graduated token listings with ROI data.

**Key data fields**

* Graduation success rate over time
* Time-to-graduate distribution
* Graduated token list with launch date, graduation date, and time to graduate

<br />

### `CRA` Creator Analysis

Creator analysis — creator distribution by token count, repeat creator trends, and creator leaderboard with graduation metrics.

**Key data fields**

* Creator count by tokens created (1, 2–3, 4–9, 10+)
* Repeat creator rate over time
* Top creators with token count, graduation rate, and volume

<br />

### `TDA` Trading Activity

Trading activity — volume trends (total / buy / sell), concentration analysis, size distribution, market breakdown, and real-time trade feed.

**Key data fields**

* Volume over time (total / buy / sell)
* Volume concentration (top trader share)
* Volume by size range
* Trading market breakdown
* Real-time trade feed (token, type, amount, price, trader, time)

<br />

### `TDP` Trader Profitability

Trader profitability — PnL and win rate distributions across launchpad traders with performance leaderboard.

**Key data fields**

* PnL distribution by range, win rate distribution, trader leaderboard with PnL, win rate, trade count, and volume

<br />

### `LPR` Launchpad Revenue

Launchpad revenue — fee source breakdown (launch, bonding curve, graduation) and revenue trends over time.

**Key data fields**

* Revenue by fee source (launch fee, buy/sell on bonding curve, graduation fee)
* Total revenue over time

<br />

### `LPC` Launchpad Comparison

Launchpad comparison — cross-platform benchmarking of launch volume, graduation rates, and revenue.

**Key data fields**

* Compare launched count, graduated count, graduation rate, volume, revenue, and avg time to graduate between launchpads over time

***

## Lending

Lending market size, rates, liquidations, and collateral risk modeling.

### `LST` Lending Stats

Lending stats — market size, supply/borrow metrics, market listings, liquidation analysis, collateral risk modeling, and vault performance.

**Key data fields**

* **Key Stats** — total market size, total borrows, total availables
* **Markets** — lending market listings with rates
* **Liquidation** — liquidation overview, all liquidation events, collateral at risk
* **Additional** — news, vaults, interest rates, fees, positions
