Skip to content

docs: fix README endpoint table — remove non-existent /v1/ prefix #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0x-SquidSol wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix README endpoint table — remove non-existent /v1/ prefix #170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 27 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,22 +58,33 @@ pnpm test

## API Endpoints

| Method | Endpoint | Description |
|--------|------------------------|--------------------------------|
| GET | `/health` | Health check |
| GET | `/docs` | OpenAPI documentation |
| GET | `/v1/markets` | List all markets |
| GET | `/v1/markets/:address` | Single market details |
| GET | `/v1/prices` | Current prices |
| GET | `/v1/prices/history` | Price history (OHLCV) |
| GET | `/v1/trades` | Trade history |
| GET | `/v1/funding` | Current funding rates |
| GET | `/v1/funding/history` | Funding rate history |
| GET | `/v1/open-interest` | Open interest data |
| GET | `/v1/insurance` | Insurance fund info |
| GET | `/v1/stats` | Platform statistics |
| GET | `/v1/crank` | Crank status |
| WS | `/ws` | WebSocket for live updates |
| Method | Endpoint | Description |
|--------|---------------------------------|--------------------------------|
| GET | `/health` | Health check |
| GET | `/docs` | OpenAPI documentation |
| GET | `/markets` | List all markets |
| GET | `/markets/:slab` | Single market details (on-chain) |
| GET | `/markets/stats` | All market stats |
| GET | `/markets/:slab/stats` | Single market stats |
| GET | `/markets/:slab/trades` | Trade history for a market |
| GET | `/markets/:slab/volume` | 24h volume for a market |
| GET | `/markets/:slab/prices` | Price history for a market |
| GET | `/prices/markets` | Current prices for all markets |
| GET | `/prices/:slab` | Oracle price history |
| GET | `/trades/recent` | Recent trades (global) |
| GET | `/funding/global` | Funding rates for all markets |
| GET | `/funding/:slab` | Funding rate for a market |
| GET | `/funding/:slab/history` | Funding rate history |
| GET | `/funding/:slab/historySince` | Funding history since timestamp |
| GET | `/open-interest/:slab` | Open interest data |
| GET | `/insurance/:slab` | Insurance fund info |
| GET | `/stats` | Platform statistics |
| GET | `/crank/status` | Crank status |
| GET | `/oracle/resolve/:mint` | Oracle price resolution |
| GET | `/chart/:mint` | OHLCV candle data |
| GET | `/api/adl/rankings` | ADL rankings |
| GET | `/ws/stats` | WebSocket metrics (auth required) |
| WS | `/` | WebSocket for live updates |

## Dependencies

Expand Down
Loading