Reference
All endpoints
Every public endpoint of the Seeryx API on one page, by method and path, with whether it needs a sign-in, linked to its full reference.
Endpoints
Every public endpoint, by section. Paths start at /api; each links to its full reference.
Sign-in endpoints Authentication
| POST | /api/auth/nonce | Get the message to sign | Public |
| POST | /api/auth/verify | Exchange the signed message for a token | Public |
| GET | /api/auth/me | The signed-in account and its cash | Signed in |
| POST | /api/auth/logout | End this sign-in token | Signed in |
| POST | /api/auth/logout-all | End every sign-in token of the account | Signed in |
| POST | /api/auth/username | Set or change the public username | Signed in |
Markets and rounds Market data
| GET | /api/markets | Every crypto market | Public |
| GET | /api/markets/upcoming | Markets announced but not trading yet | Public |
| GET | /api/markets/summary | Every market at once: live round, best prices, last results | Public |
| GET | /api/markets/:asset/:tf/current | The live round of a market | Public |
| GET | /api/markets/:asset/:tf/rounds | Settled rounds of a market, newest first | Public |
| GET | /api/rounds/:slug | One round, past, live or upcoming | Public |
| GET | /api/rounds/:slug/holders | The largest holders of Up and Down | Public |
| GET | /api/rounds/:slug/activity | The last 100 trades of a market with who took them | Public |
Order book, trades and fees Market data
| GET | /api/orderbook/:slug | The order book of one side | Public |
| GET | /api/trades/:slug | The last 100 trades, newest first | Public |
| GET | /api/volume/:slug | Volume and trade count | Public |
| GET | /api/fees | Taker fee rate, maker rebate and the smallest order | Public |
| GET | /api/notice | A notice to every trader, if there is one | Public |
| GET | /api/stats | 24-hour volume, trades and traders, per market and in total | Public |
Event markets Market data
| GET | /api/events | Every event market | Public |
| GET | /api/events/:slug | One event market | Public |
| GET | /api/event-groups | Questions with their outcomes and prices | Public |
| GET | /api/event-groups/:id | One question with its outcomes | Public |
| GET | /api/event-groups/:id/holders | The largest holders of each outcome | Public |
Order endpoints Trading
| POST | /api/orders | Place an order | Signed in |
| POST | /api/orders/batch | Place up to 15 orders in one request | Signed in |
| DELETE | /api/orders/:id | Cancel one open order | Signed in |
| DELETE | /api/orders | Cancel all your open orders, or those of one market | Signed in |
| POST | /api/split | Turn USDC into as many Up and Down shares | Signed in |
| POST | /api/merge | Turn pairs of Up and Down shares back into USDC | Signed in |
Account endpoints Account
| GET | /api/account | Cash, positions and open orders in one read | Signed in |
| GET | /api/balance | Cash | Signed in |
| GET | /api/positions | Open positions | Signed in |
| GET | /api/orders | Open orders, newest first | Signed in |
| GET | /api/activity | Trades, splits, merges, payouts and cancels, newest first | Signed in |
| GET | /api/settled | Settled positions, newest first | Signed in |
| GET | /api/feed | Trades and deposits or withdrawals in one list, newest first | Signed in |
| GET | /api/pnl | Realized profit and loss, fees, win rate and a chart | Signed in |
| GET | /api/transactions | Latest deposits and withdrawals | Signed in |
| GET | /api/rewards/liquidity | Your liquidity points and what your resting orders earn now | Signed in |
Leaderboard and profiles Account
| GET | /api/leaderboard | Top 100 traders by realized profit and loss | Public |
| GET | /api/profiles | Find traders by name prefix or full wallet address | Public |
| GET | /api/profiles/:handle | A trader | Public |
| GET | /api/profiles/:handle/pnl | A trader's profit and loss (as /pnl) | Public |
| GET | /api/profiles/:handle/positions | A trader's open positions (as /positions) | Public |
| GET | /api/profiles/:handle/activity | A trader's trades and payouts, without cancels | Public |
| GET | /api/profiles/:handle/settled | A trader's settled positions (as /settled) | Public |
Funds endpoints Deposits and withdrawals
| GET | /api/funds | The chain facts a client needs | Public |
| GET | /api/funds/wallet | USDC in your wallet, your cash in the program, USDC on its way | Signed in |
| POST | /api/funds/refresh | After a deposit or withdrawal: read the program now | Signed in |
| POST | /api/relay | Prepare a transaction of yours for the wallet to sign | Signed in |
| POST | /api/relay/submit | Send a prepared transaction after your wallet signed it | Signed in |
| POST | /api/withdraw-now | An immediate withdrawal, for the wallet to sign | Signed in |
| POST | /api/withdraw/quote | What a withdrawal to another network delivers | Signed in |
| GET | /api/deposit/options | Networks and tokens a deposit can come from | Public |
| POST | /api/deposit/address | Your own deposit address for a token on a network | Signed in |
| POST | /api/deposit/recover | Find a deposit sent with another token or on another network | Signed in |