home

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/nonceGet the message to signPublic
POST/api/auth/verifyExchange the signed message for a tokenPublic
GET/api/auth/meThe signed-in account and its cashSigned in
POST/api/auth/logoutEnd this sign-in tokenSigned in
POST/api/auth/logout-allEnd every sign-in token of the accountSigned in
POST/api/auth/usernameSet or change the public usernameSigned in

Markets and rounds Market data

GET/api/marketsEvery crypto marketPublic
GET/api/markets/upcomingMarkets announced but not trading yetPublic
GET/api/markets/summaryEvery market at once: live round, best prices, last resultsPublic
GET/api/markets/:asset/:tf/currentThe live round of a marketPublic
GET/api/markets/:asset/:tf/roundsSettled rounds of a market, newest firstPublic
GET/api/rounds/:slugOne round, past, live or upcomingPublic
GET/api/rounds/:slug/holdersThe largest holders of Up and DownPublic
GET/api/rounds/:slug/activityThe last 100 trades of a market with who took themPublic

Order book, trades and fees Market data

GET/api/orderbook/:slugThe order book of one sidePublic
GET/api/trades/:slugThe last 100 trades, newest firstPublic
GET/api/volume/:slugVolume and trade countPublic
GET/api/feesTaker fee rate, maker rebate and the smallest orderPublic
GET/api/noticeA notice to every trader, if there is onePublic
GET/api/stats24-hour volume, trades and traders, per market and in totalPublic

Event markets Market data

GET/api/eventsEvery event marketPublic
GET/api/events/:slugOne event marketPublic
GET/api/event-groupsQuestions with their outcomes and pricesPublic
GET/api/event-groups/:idOne question with its outcomesPublic
GET/api/event-groups/:id/holdersThe largest holders of each outcomePublic

Order endpoints Trading

POST/api/ordersPlace an orderSigned in
POST/api/orders/batchPlace up to 15 orders in one requestSigned in
DELETE/api/orders/:idCancel one open orderSigned in
DELETE/api/ordersCancel all your open orders, or those of one marketSigned in
POST/api/splitTurn USDC into as many Up and Down sharesSigned in
POST/api/mergeTurn pairs of Up and Down shares back into USDCSigned in

Account endpoints Account

GET/api/accountCash, positions and open orders in one readSigned in
GET/api/balanceCashSigned in
GET/api/positionsOpen positionsSigned in
GET/api/ordersOpen orders, newest firstSigned in
GET/api/activityTrades, splits, merges, payouts and cancels, newest firstSigned in
GET/api/settledSettled positions, newest firstSigned in
GET/api/feedTrades and deposits or withdrawals in one list, newest firstSigned in
GET/api/pnlRealized profit and loss, fees, win rate and a chartSigned in
GET/api/transactionsLatest deposits and withdrawalsSigned in
GET/api/rewards/liquidityYour liquidity points and what your resting orders earn nowSigned in

Leaderboard and profiles Account

GET/api/leaderboardTop 100 traders by realized profit and lossPublic
GET/api/profilesFind traders by name prefix or full wallet addressPublic
GET/api/profiles/:handleA traderPublic
GET/api/profiles/:handle/pnlA trader's profit and loss (as /pnl)Public
GET/api/profiles/:handle/positionsA trader's open positions (as /positions)Public
GET/api/profiles/:handle/activityA trader's trades and payouts, without cancelsPublic
GET/api/profiles/:handle/settledA trader's settled positions (as /settled)Public

Funds endpoints Deposits and withdrawals

GET/api/fundsThe chain facts a client needsPublic
GET/api/funds/walletUSDC in your wallet, your cash in the program, USDC on its waySigned in
POST/api/funds/refreshAfter a deposit or withdrawal: read the program nowSigned in
POST/api/relayPrepare a transaction of yours for the wallet to signSigned in
POST/api/relay/submitSend a prepared transaction after your wallet signed itSigned in
POST/api/withdraw-nowAn immediate withdrawal, for the wallet to signSigned in
POST/api/withdraw/quoteWhat a withdrawal to another network deliversSigned in
GET/api/deposit/optionsNetworks and tokens a deposit can come fromPublic
POST/api/deposit/addressYour own deposit address for a token on a networkSigned in
POST/api/deposit/recoverFind a deposit sent with another token or on another networkSigned in