# Endpoint Catalog
> Every Ozmium /v1 endpoint with its USDC price and purpose - data reads, alpha, transaction builders for swaps, vaults, loans and perps, prop desk, and referrals.
Source: https://docs.ozmium.org/agents/endpoints/
Keywords: ozmium api endpoints, v1 endpoint catalog, crypto price api usdc, transaction builder api, base mainnet calldata api
Updated: 2026-07-27
---

Base URL: `https://ozmium.org/v1`

:::note The live catalog is authoritative
The catalog at [`/v1`](https://ozmium.org/v1) is free, complete, and generated from the running
service. This page is the readable version. If the two ever disagree, the live catalog wins.
:::

## Data Endpoints - $0.001 per Call

| Endpoint | Returns |
|---|---|
| `GET /v1/prices?symbols=BTC,ETH` | Two labeled venues per symbol: Coinbase exchange spot with 24h stats, and the [gTrade](https://gains.trade) leg `{ gains: { pairIndex, mark, index } }`. `mark` is what fills on Gains; `index` is the oracle spot liquidations use. The cross-venue spread is real, tradeable divergence. Covers Gains-listed symbols Coinbase does not carry. |
| `GET /v1/crowd?symbols=BTC,ETH` | Live gTrade crowd positioning: long vs short split in percent and USD, both sides, total book, plus `bookSharePct` - each pair's share of the whole Gains open book. 90 percent long on a pair holding 4 percent of the venue's money is a very different signal than 90 percent long on a rounding error. |
| `GET /v1/signals?symbols=ETH,BTC` | Multi-indicator TA bundle - RSI, MACD, Bollinger, VWAP, trend, candlestick pattern - reduced to a directional bias and a conviction score. |
| `GET /v1/candles?product=ETH-USD&days=30` | OHLCV series. |
| `GET /v1/swap/price` | Expected output, route, and fees. |
| `GET /v1/portfolio/{address}` | Token balances with confidence-gated USD valuation. Never a fabricated zero. |
| `GET /v1/positions/{address}` | Open leveraged perp positions: size, leverage, liquidation price, PnL. |
| `GET /v1/pending-orders/{address}` | Resting limit and stop orders that have **not** filled. These hold collateral but are not positions. |
| `GET /v1/history/{address}` | Closed-trade ledger with entry, exit, and reason: TP, SL, or LIQ. |
| `GET /v1/stats/{address}` | Trading scorecard: trades, win rate, net USD, gross profit and loss, profit factor, mean R-multiple expectancy, average win and loss, best and worst. The natural input to a risk-sizing agent. |
| `GET /v1/earn/vaults` | Morpho and Aave vault list with live APY. |
| `GET /v1/loan/markets` | Floating-rate collateral markets with LLTV, borrow APY, and liquidity. |
| `GET /v1/loan/fixed` | Every live [Morpho Midnight](https://docs.morpho.org) fixed-rate, fixed-term book: marketId, tokens, LLTV, oracle, maturity, and both sides' implied APRs (borrow is best bid, lend is best ask). |
| `GET /v1/risk/pairs` | Tradeable Gains gTrade pairs with pairIndex, max leverage, and spread. |
| `GET /v1/ideas/asset/{sym}` | Does one named market have a worthwhile leverage edge right now, and what would be better instead or as a hedge? Direction, range-survival leverage, entry, stop, target, liquidation, edge. |

## Alpha Endpoints

| Endpoint | Price | Returns |
|---|---|---|
| `GET /v1/ta/{sym}?gran=900` | $0.005 | The complete chart read for one symbol at your timeframe (1m, 5m, 15m, 1H, 1D) - everything the Ozmium chart shows a human, as data. |
| `GET /v1/ideas/compare?a=ETH&b=BTC` | $0.005 | Relative-strength / pairs-trade read. When one leg sits near the top of its recent range and the other near its bottom, the spread is stretched and mean reversion favors long-the-laggard, short-the-leader. Plus each leg's own edge. |
| `POST /v1/prop/quote` | $0.005 | What the prop desk would charge for a given action, and whether the paying wallet qualifies. |
| `GET /v1/ideas?worthwhileness=strict` | $0.008 | The strict shortlist: only the highest-conviction setups sitting on a 52-week extreme, one per direction per category. |
| `GET /v1/ideas?limit=6` | $0.01 | Ranked long and short leverage setups across every category - crypto, forex, energy, metals, indices, stocks. About a year of daily candles reduced to a composite technical signal, ranked by edge times leveraged profit per unit time. Each executable via `/v1/tx/risk/open`. |
| `GET /v1/arbitrage?target=cbBTC&budget=100&taker=0x..` | $0.01 | Ranked, **fee-netted** cross-asset and DEX-versus-Coinbase arbitrage routes into the target. Each executable via `/v1/tx/swap`. |
| `GET /v1/ta/scan?symbols=BTC,ETH,SOL` | $0.01 | Cross-asset buy/sell dominance in one call for up to eight symbols across 1m, 5m, and 15m. |
| `GET /v1/loan/analysis/{address}` | $0.01 | Borrow-position risk analysis. |
| `GET /v1/ideas/summary` | $0.01 | Market-wide edge aggregate: single best long and best short across all markets, top long and short per category, and breadth counts. |
| `GET /v1/ideas?worthwhileness=loose&limit=16` | $0.01 | The fuller field including marginal plays, for coverage or hedge scanning. |
| `GET /v1/alpha` | $0.01 | The whole alpha stack in one call - arbitrage routes, ranked ideas, and the TA bundle. Cheaper and faster than polling the three separately. |

## Transaction Builders - $0.01 per Call

Every builder returns ready-to-sign `{ to, data, value }` encoded for Base mainnet. You broadcast from
your own wallet. Ozmium never signs.

**Basics**

- `POST /v1/tx/swap` - spot swap on Base (CDP Trade API plus [Permit2](https://docs.uniswap.org/contracts/permit2/overview)).
- `POST /v1/tx/send` - transfer a token or ETH.
- `POST /v1/tx/tip` - fund the Ozmium prop desk. No return promised.
- `POST /v1/tx/burn` - burn OZ to the dead address and rank on the onchain burn ladder.

**Earn**

- `POST /v1/tx/earn/deposit`, `/v1/tx/earn/withdraw` - ERC-4626 Morpho vault supply and redeem.
- `POST /v1/tx/earn/aave/supply`, `/v1/tx/earn/aave/withdraw` - Aave supply and withdraw.

**Borrow**

- `POST /v1/tx/loan/supply-collateral`, `/borrow`, `/repay`, `/withdraw-collateral` - the [Morpho Blue](https://docs.morpho.org)
  floating-rate lifecycle.
- `POST /v1/tx/fixed/supply-collateral`, `/borrow`, `/repay`, `/withdraw-collateral` - Morpho Midnight
  fixed rate. The borrow builder quotes the live bid book for your target and encodes the takes in
  order, clamped by a slippage-guarded worst price. The rate locks at execution to the market
  maturity.

**Leverage**

- `POST /v1/tx/risk/open`, `/v1/tx/risk/close`, `/v1/tx/risk/modify` - Gains gTrade perps with USDC
  collateral, up to 200x, with exact scaling handled for you: leverage x1e3, prices x1e10, USDC 6dp,
  slippage x1e3. `modify` takes `action: tp | sl | leverage` and adjusts an open position **without
  closing it**. A leverage decrease auto-prepends the USDC approve for the collateral top-up.

**Liquidity**

- `POST /v1/tx/lp/aero/add`, `/v1/tx/lp/aero/remove` - [Aerodrome](https://aerodrome.finance) vAMM OZ/USDC, with ERC-20 approves
  for both sides prepended when the live allowance is short.
- `POST /v1/tx/lp/uni/add`, `/v1/tx/lp/uni/remove` - [Uniswap v3](https://app.uniswap.org) OZ/WETH 1 percent pool at **full
  range**, bundled multicall, ETH auto-wrapped and excess refunded. On remove, `liquidity: 0`
  **collects fees only** - that is the claim path.

## Prop Desk

| Endpoint | Price | Notes |
|---|---|---|
| `POST /v1/prop/quote` | $0.005 | OZ cost, match factor, and eligibility. Needs `actionId` plus that action's parameters. |
| `POST /v1/prop/execute` | $0.01 | Runs the action. Needs `actionId`, parameters, and `payTxHash` (agents) or `burnTxHash` (humans). |

The x402 fee does **not** authorize a prop action. See [Prop](/guides/prop-desk/).

## Free

| Endpoint | Returns |
|---|---|
| `GET /v1` | The full catalog and live prices |
| `GET /v1/referrals/{wallet}` | Your referral tally and amount owed |
| `GET /v1/oz-credit/{wallet}` | Your prepaid OZ credit balance and the rail's full terms |

## Paying Half

Every price on this page is the USDC price. Prepaid OZ credit covers the same calls at **half** of it
and is exempt from congestion surge. See [the credit rail](/agents/x402/#paying-in-oz-the-credit-rail).

## Related

- [x402 Payments](/agents/x402/)
- [Integration Notes](/agents/integration/)
- [Agent API Overview](/agents/overview/)