{"openapi":"3.1.0","info":{"title":"Submarine API","version":"1.0.0","description":"Market data for every token Submarine follows on Zero (chain 84532): its own launches, other launchpads' and any ERC-20 with trades. Free and read only; trading is done by signing transactions against the contracts in /health's deployment. Amounts are ZRO in whole units unless a field says otherwise. Every caller: 1200 requests a minute per IP (IPv6 by /64), bursts of 600; of those, 300 a minute may be heavy reads (holders, bubbles, wallet history, leaderboards, stats) that are not served from the few seconds they are kept. Past either, 429 with retry-after. /quote and /builder routes: 30 requests a minute per IP without a key, 300 a minute per key with one (x-api-key header or ?key=); every keyed or limited answer carries x-ratelimit-limit, x-ratelimit-remaining and x-ratelimit-reset. Get a key by signing in with your wallet (POST /builder/nonce, then /builder/login) and POST /builder/keys. Errors are { message }, and on /quote and /builder routes also { error: { code, message } }."},"servers":[{"url":"https://app.submarine.live","description":"Zero, chain 84532"}],"security":[{},{"apiKey":[]}],"tags":[{"name":"Trading"},{"name":"Tokens"},{"name":"Market"},{"name":"Wallets"},{"name":"Leaderboard"},{"name":"Social"},{"name":"Staking"},{"name":"Builders"},{"name":"Protocol"},{"name":"Meta"}],"paths":{"/health":{"get":{"tags":["Protocol"],"summary":"Chain id, the block followed and read, and the contract addresses","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/status":{"get":{"tags":["Protocol"],"summary":"Each service checked every minute: state, uptime over 24 h, 7 d and 90 d, a bar per day, incidents","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}}}}},"/api/v1/openapi.json":{"get":{"tags":["Protocol"],"summary":"This document","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/tokens":{"get":{"tags":["Tokens"],"summary":"Tokens with price, market cap, change and volume","parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["new","volume","progress","mcap","active"],"default":"new"},"description":"Order"},{"name":"window","in":"query","required":false,"schema":{"type":"string","enum":["1h","6h","1d","24h","7d"],"default":"1d"},"description":"What volume_24h, trades_24h and change_24h cover; the field names stay"},{"name":"spark","in":"query","required":false,"schema":{"type":"string","enum":["1"]},"description":"Adds `spark`, closing prices over the window oldest first: 12 points for 1h, 24 for 6h and 1d, 42 for 7d"},{"name":"stage","in":"query","required":false,"schema":{"type":"string","enum":["curve","graduating","graduated","external"]},"description":"Where it trades"},{"name":"launchpad","in":"query","required":false,"schema":{"type":"string","examples":["terminal","terminal,somepad"]},"description":"terminal for Submarine, or launchpad ids from /api/v1/launchpads, comma separated"},{"name":"creator","in":"query","required":false,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Launched by"},{"name":"addresses","in":"query","required":false,"schema":{"type":"string"},"description":"Only these tokens, comma separated (up to 200)"},{"name":"q","in":"query","required":false,"schema":{"type":"string"},"description":"Name, ticker or address"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":50},"description":"How many"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0},"description":"Skip"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tokens":{"type":"array","items":{"$ref":"#/components/schemas/Token"}}}}}}}}}},"/api/v1/tokens/{address}":{"get":{"tags":["Tokens"],"summary":"One token, with change over 5 m, 1 h and 6 h, flow over 24 h and what its fee has paid","parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/tokens/{address}/candles":{"get":{"tags":["Tokens"],"summary":"OHLCV in ZRO, oldest first","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"},{"name":"interval","in":"query","required":false,"schema":{"type":"integer","enum":[1,5,60,300,900,3600,14400,86400],"default":60},"description":"Seconds per candle"},{"name":"before","in":"query","required":false,"schema":{"type":"integer","description":"Unix seconds"},"description":"Only candles before this, to page back"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":4000,"default":300},"description":"How many"}]}},"/api/v1/tokens/{address}/trades":{"get":{"tags":["Tokens"],"summary":"Latest trades, newest first","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"},{"name":"trader","in":"query","required":false,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Only this wallet"},{"name":"traders","in":"query","required":false,"schema":{"type":"string"},"description":"Only these wallets, comma separated"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50},"description":"How many"}]}},"/api/v1/tokens/{address}/holders":{"get":{"tags":["Tokens"],"summary":"Largest holders","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":20},"description":"How many"}]}},"/api/v1/tokens/{address}/holders/labelled":{"get":{"tags":["Tokens"],"summary":"Largest holders with labels: dev, insider, sniper, bundle, whale, fresh, smart, bot, cluster","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100},"description":"How many"}]}},"/api/v1/tokens/{address}/holders/pnl":{"get":{"tags":["Tokens"],"summary":"Largest holders with cost basis and profit by average cost, marked to the price now","parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100},"description":"How many"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoldersPnl"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/tokens/{address}/bubbles":{"get":{"tags":["Tokens"],"summary":"The bubble map: holders sized by share, transfers between them, and the clusters they form","parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":150,"default":60},"description":"How many"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bubbles"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/tokens/{address}/clusters":{"get":{"tags":["Tokens"],"summary":"The same map in its raw form","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/tokens/{address}/traders":{"get":{"tags":["Tokens"],"summary":"Everyone who traded it, by profit marked to the price now","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"description":"How many"}]}},"/api/v1/tokens/{address}/first-buyers":{"get":{"tags":["Tokens"],"summary":"The first buyers in order and what each has done since","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"}]}},"/api/v1/tokens/{address}/dev":{"get":{"tags":["Tokens"],"summary":"Its creator's every move, and wallets the creator paid in it","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"}]}},"/api/v1/tokens/{address}/risk":{"get":{"tags":["Tokens"],"summary":"Risk figures and all-time high","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"}]}},"/api/v1/tokens/{address}/security":{"get":{"tags":["Tokens"],"summary":"What the chain says about its safety: owner, pool","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"}]}},"/api/v1/tokens/{address}/orderbook":{"get":{"tags":["Tokens"],"summary":"Every limit order on it and what rested at each moment","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"}]}},"/api/v1/tokens/{address}/viewers":{"get":{"tags":["Tokens"],"summary":"How many pages have it open","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Token contract"},{"name":"id","in":"query","required":false,"schema":{"type":"string"},"description":"Your page id, to count yourself"}]}},"/api/v1/pulse/{column}":{"get":{"tags":["Market"],"summary":"New launches, those near their pool, and those just moved","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"column","in":"path","required":true,"schema":{"type":"string","enum":["new","near","migrated"]},"description":"Column"}]}},"/api/v1/trending":{"get":{"tags":["Market"],"summary":"Most traded tokens over a window","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"window","in":"query","required":false,"schema":{"type":"string","enum":["1m","5m","1h","6h","24h"],"default":"1h"},"description":"Window"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["volume","change","trades"]},"description":"Order"}]}},"/api/v1/search":{"get":{"tags":["Market"],"summary":"Tokens by name, ticker or address, and wallets by address prefix","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"},"description":"What to look for"}]}},"/api/v1/market/trades":{"get":{"tags":["Market"],"summary":"Latest trades on every token","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":30},"description":"How many"},{"name":"traders","in":"query","required":false,"schema":{"type":"string"},"description":"Only these wallets, comma separated"}]}},"/api/v1/market/stats":{"get":{"tags":["Market"],"summary":"Token counts, and volume, trades and traders over 24 h","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/launchpads":{"get":{"tags":["Market"],"summary":"Launchpads this terminal trades and indexes","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/launchpads/stats":{"get":{"tags":["Market"],"summary":"Each launchpad over 24 h, and contracts minting tokens that no file names yet","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/radar":{"get":{"tags":["Market"],"summary":"Wallets early on several of the given tokens","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"tokens","in":"query","required":false,"schema":{"type":"string"},"description":"Up to 10, comma separated; the five busiest when left out"}]}},"/api/v1/inflow":{"get":{"tags":["Market"],"summary":"What the given wallets bought and sold over a window","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"wallets","in":"query","required":true,"schema":{"type":"string"},"description":"Comma separated"},{"name":"window","in":"query","required":false,"schema":{"type":"string","enum":["1m","5m","1h","6h","24h"]},"description":"Window"}]}},"/api/v1/zro-price":{"get":{"tags":["Market"],"summary":"ZRO in dollars","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/leaderboard":{"get":{"tags":["Leaderboard"],"summary":"Without kind: traders by profit marked to the price now (the older shape). With kind: traders by realised profit, creators by fees earned, or points","parameters":[{"name":"kind","in":"query","required":false,"schema":{"type":"string","enum":["traders","creators","points"]},"description":"Which board. Left out, the older traders list"},{"name":"window","in":"query","required":false,"schema":{"type":"string","enum":["1d","24h","7d","30d","all"]},"description":"With kind: default 7d; points are always all time. Without kind: 24h or 7d, all time if left out"},{"name":"address","in":"query","required":false,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"With kind: also answer where this wallet stands, as `me`"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100},"description":"How many"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Board"},{"type":"object","properties":{"traders":{"type":"array","items":{"type":"object","additionalProperties":true}}}}]}}}}}}},"/api/v1/points/leaders":{"get":{"tags":["Leaderboard"],"summary":"Points leaders","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"description":"How many"}]}},"/api/v1/points/rules":{"get":{"tags":["Leaderboard"],"summary":"How points are counted","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/points/{address}":{"get":{"tags":["Leaderboard"],"summary":"A wallet's points and place","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"}]}},"/api/v1/airdrop":{"get":{"tags":["Leaderboard"],"summary":"The airdrop: its share of supply, its value now, and the points totals","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/wallet/{address}":{"get":{"tags":["Wallets"],"summary":"Holdings, latest trades, totals, launches and closed positions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"}]}},"/api/v1/wallet/{address}/pnl":{"get":{"tags":["Wallets"],"summary":"Profit on every token traded or held, by average cost, and the totals","parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletPnl"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/wallet/{address}/trades":{"get":{"tags":["Wallets"],"summary":"Every trade, compact","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":20000,"default":5000},"description":"How many"}]}},"/api/v1/wallet/{address}/record":{"get":{"tags":["Wallets"],"summary":"Win rate and record over 7 or 30 days","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"},{"name":"days","in":"query","required":false,"schema":{"type":"integer","enum":[7,30]},"description":"Days"}]}},"/api/v1/wallets":{"get":{"tags":["Wallets"],"summary":"Records of several wallets at once","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"addresses","in":"query","required":true,"schema":{"type":"string"},"description":"Comma separated, up to 200"}]}},"/api/v1/profiles":{"get":{"tags":["Wallets"],"summary":"Names and pictures","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"a","in":"query","required":true,"schema":{"type":"string"},"description":"Wallets, comma separated, up to 100"}]}},"/api/v1/orders":{"get":{"tags":["Wallets"],"summary":"Limit orders, stops and DCA","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"owner","in":"query","required":false,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Placed by"},{"name":"token","in":"query","required":false,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"On"},{"name":"open","in":"query","required":false,"schema":{"type":"string","enum":["0","1"]},"description":"Open or closed"}]}},"/api/v1/orders/{id}/fills":{"get":{"tags":["Wallets"],"summary":"An order's fills","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"},"description":"Order id"}]}},"/api/v1/referrals/{address}":{"get":{"tags":["Wallets"],"summary":"Referral link, credits and claims","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"}]}},"/api/v1/vault/{address}":{"get":{"tags":["Wallets"],"summary":"Copy vault: follows, exits and movements","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"}]}},"/api/v1/protocol/stats":{"get":{"tags":["Protocol"],"summary":"Totals, the range against the one before, a series and leaders","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"range","in":"query","required":false,"schema":{"type":"string","enum":["24h","7d","30d"]},"description":"All time if left out"}]}},"/api/v1/stats/more":{"get":{"tags":["Protocol"],"summary":"Users new and active, revenue by source and where it went, each launchpad's share, and a live feed","parameters":[{"name":"range","in":"query","required":false,"schema":{"type":"string","enum":["24h","7d","30d"]},"description":"All time if left out"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsMore"}}}}}}},"/api/v1/buyback":{"get":{"tags":["Protocol"],"summary":"The treasury buying back the Submarine token: rounds, spent, burned, next","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/stream":{"get":{"tags":["Market"],"summary":"Server-sent events: trade, launch, graduated, order, dev, vault","responses":{"200":{"description":"text/event-stream"}}}},"/api/v1/quote":{"get":{"tags":["Trading"],"operationId":"quote","summary":"Best price for a buy or sale through the router, and the transaction that does it","description":"Quotes the venue the router itself would pick (bestBuy / bestSell over every venue it lists) and, with `trader`, builds the router call and checks it against the chain with eth_estimateGas from that wallet. With `builder` (a code or an address) the call is buyPartner / sellPartner with kind 2, which pays the builder the router's partner share of the terminal's cut at no cost to the trader; `builder.applied` says whether it was (not on the builder's own trades). A sale needs the router approved for the tokens: when the allowance is short, `approvals` holds that transaction and the sale is built but not checked until it lands.","parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"The token to buy or sell"},{"name":"side","in":"query","required":true,"schema":{"type":"string","enum":["buy","sell"]},"description":"buy pays ZRO for the token, sell pays the token for ZRO"},{"name":"amount","in":"query","required":true,"schema":{"type":"string","examples":["25","0.5"]},"description":"What is paid, in whole units: ZRO for a buy, tokens for a sale"},{"name":"trader","in":"query","required":false,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"The wallet that will sign. With it the answer carries `transaction`; without it, a quote only. Alias: recipient"},{"name":"builder","in":"query","required":false,"schema":{"type":"string"},"description":"Your builder code or wallet address: the router pays you its partner share of the terminal's cut on this trade. Alias: ref"},{"name":"slippageBps","in":"query","required":false,"schema":{"type":"integer","minimum":10,"maximum":5000,"default":100},"description":"How far below the quote the trade may fill"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quote"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited, see retry-after","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Busy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Trading"],"operationId":"quotePost","summary":"The same, with the parameters as a JSON body","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["token","side","amount"],"properties":{"token":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"side":{"type":"string","enum":["buy","sell"]},"amount":{"type":"string","examples":["25","0.5"]},"trader":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"builder":{"type":"string"},"slippageBps":{"type":"integer","minimum":10,"maximum":5000,"default":100}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quote"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited, see retry-after","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Busy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/staking":{"get":{"tags":["Staking"],"summary":"Staking of the platform token: totals, the reward stream, the fee-free threshold and every funding","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Staking"}}}}}}},"/api/v1/staking/{wallet}":{"get":{"tags":["Staking"],"summary":"A wallet's stake, what it can claim now (read from the contract), whether it trades fee-free, and its history","parameters":[{"name":"wallet","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StakingWallet"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/vault":{"get":{"tags":["Wallets"],"summary":"The copy vault as a whole: paused, guardian, the copy fee new follows get, and the fees taken","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/partners":{"get":{"tags":["Social"],"summary":"Everyone the router has paid as a partner, most first","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"kind","in":"query","required":false,"schema":{"type":"string","enum":["call","builder"]},"description":"Only callers or only builders"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"description":"How many"}]}},"/api/v1/partners/{address}":{"get":{"tags":["Social"],"summary":"What the router has paid a wallet as a caller (kind 1) and as a builder (kind 2)","parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerEarnings"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/calls":{"get":{"tags":["Social"],"summary":"Calls: latest, by ZRO bought through them, from wallets you follow, or your own","parameters":[{"name":"tab","in":"query","required":false,"schema":{"type":"string","enum":["latest","bought","following","mine","top"],"default":"latest"},"description":"Which list; top is the callers board"},{"name":"callers","in":"query","required":false,"schema":{"type":"string"},"description":"following: wallets, comma separated"},{"name":"caller","in":"query","required":false,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"mine, or any tab: only this caller"},{"name":"token","in":"query","required":false,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Only calls on this token"},{"name":"window","in":"query","required":false,"schema":{"type":"string","enum":["1d","7d","30d","all"]},"description":"Made within"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50},"description":"How many"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0},"description":"Skip"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tab":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Call"}}}}}}}}},"post":{"tags":["Social"],"summary":"Make a call, signed by the caller with personal_sign over the text below","description":"The text, with addresses lowercase: \"Submarine call\\nWallet: <address>\\nToken: <token>\\nNote: <note or (none)>\\nTime: <unix seconds>\". The time must be within ten minutes of now and later than this wallet's last signed change. One live call per coin per caller; one call every 20 s.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["address","token","time","signature"],"properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"token":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"note":{"type":"string","maxLength":200},"time":{"type":"integer","description":"Unix seconds"},"signature":{"type":"string","description":"0x... 65-byte personal_sign signature"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Call"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited, see retry-after","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/calls/top":{"get":{"tags":["Social"],"summary":"Callers by the average peak multiple of their calls, then by how many went 2x","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"window","in":"query","required":false,"schema":{"type":"string","enum":["1d","7d","30d","all"],"default":"30d"},"description":"Calls made within"},{"name":"address","in":"query","required":false,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Also answer where this caller stands, as `me`"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100},"description":"How many"}]}},"/api/v1/calls/{id}":{"get":{"tags":["Social"],"summary":"One call with its figures","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{6,16}$"},"description":"Call id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Call"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/clans":{"get":{"tags":["Social"],"summary":"Clans ranked by their members' realised profit, volume or holdings","parameters":[{"name":"window","in":"query","required":false,"schema":{"type":"string","enum":["7d","30d","all"],"default":"7d"},"description":"Window for profit and volume"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["pnl","volume","volume_24h","holdings","members"],"default":"pnl"},"description":"Order"},{"name":"q","in":"query","required":false,"schema":{"type":"string"},"description":"Tag or name"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100},"description":"How many"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}},"post":{"tags":["Social"],"summary":"Change a clan, signed by the wallet making the change","description":"Actions: create, edit (owner), join, cancel (a request), approve, reject and kick (owner), leave. The signed text, addresses lowercase, fields that don't apply a dash: \"Submarine clan\\nAction: <action>\\nWallet: <address>\\nClan: <TAG>\\nMember: <member or ->\\nName: <name or ->\\nImage: <https link or ->\\nTime: <unix seconds>\".","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action","address","tag","time","signature"],"properties":{"action":{"type":"string","enum":["create","edit","join","cancel","approve","reject","kick","leave"]},"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"tag":{"type":"string","pattern":"^[A-Z0-9]{2,5}$"},"member":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"name":{"type":"string"},"image":{"type":"string"},"time":{"type":"integer","description":"Unix seconds"},"signature":{"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/clans/{tag}":{"get":{"tags":["Social"],"summary":"One clan: its rank, members with their figures, and open requests","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"},"description":"Clan tag"},{"name":"window","in":"query","required":false,"schema":{"type":"string","enum":["7d","30d","all"]},"description":"Window"}]}},"/api/v1/clans/of/{address}":{"get":{"tags":["Social"],"summary":"The clan a wallet is in or asking to join","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"address","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"description":"Wallet"}]}},"/api/v1/builder/nonce":{"post":{"tags":["Builders"],"summary":"A one-time text for a wallet to sign in with (personal_sign), valid five minutes","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["address"],"properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"nonce":{"type":"string"},"message":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited, see retry-after","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/builder/login":{"post":{"tags":["Builders"],"summary":"Sign in: the text from /builder/nonce, signed by the wallet. Uses the nonce up","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["address","signature"],"properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"signature":{"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"session":{"type":"string"},"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited, see retry-after","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/builder/logout":{"post":{"tags":["Builders"],"security":[{"session":[]}],"summary":"End the session","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/api/v1/builder/me":{"get":{"tags":["Builders"],"security":[{"session":[]}],"summary":"Your keys, code, requests, and volume and earnings from Partner events (kind 2)","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/builder/keys":{"post":{"tags":["Builders"],"security":[{"session":[]}],"summary":"A new API key, shown once and stored only as its hash (5 per wallet)","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","maxLength":40}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"prefix":{"type":"string"},"label":{"type":["string","null"]}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/builder/keys/{id}/revoke":{"post":{"tags":["Builders"],"security":[{"session":[]}],"summary":"Revoke a key","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"},"description":"Key id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/builder/code":{"post":{"tags":["Builders"],"security":[{"session":[]}],"summary":"Claim or change your builder code","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/builder/code/{code}":{"get":{"tags":["Builders"],"summary":"The wallet a builder code pays","parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string"},"description":"Builder code"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/meta/{hash}":{"get":{"tags":["Meta"],"summary":"Saved token metadata: picture, description, links","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"parameters":[{"name":"hash","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{64}$"},"description":"sha256 of the JSON"}]}}},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key"},"session":{"type":"http","scheme":"bearer","description":"The session from /builder/login"}},"schemas":{"Error":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"Token":{"type":"object","additionalProperties":true,"properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"name":{"type":"string"},"symbol":{"type":"string"},"creator":{"type":["string","null"],"pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"source":{"type":"string","enum":["terminal","external"]},"launchpad":{"type":["string","null"]},"price":{"type":"number","description":"ZRO per token"},"market_cap":{"type":"number","description":"ZRO, in whole units"},"volume_24h":{"type":"number","description":"ZRO over the window asked for, a day by default"},"trades_24h":{"type":"integer"},"change_24h":{"type":"number","description":"Over the window asked for; 0.1 is +10%"},"holders":{"type":"integer"},"progress":{"type":"number","description":"Along its curve, 0 to 1"},"graduated":{"type":"boolean"},"tradable":{"type":"boolean"},"spark":{"type":"array","items":{"type":"number"},"description":"With spark=1 only"},"fee_bps":{"type":"integer","description":"Its fee now, the 1% base included; a creator can only lower it"},"dev_fee_bps":{"type":"integer","description":"The creator's own part on top of the base"},"max_wallet":{"type":["number","null"],"description":"Tokens one wallet may hold until max_wallet_until; null for none"},"max_wallet_until":{"type":["integer","null"],"description":"Unix seconds"},"max_wallet_active":{"type":"boolean"},"fee_changes":{"type":"array","description":"One token only: every fee cut, on the launchpad (fee_bps, dev_fee_bps) and on the pool (earners_bps, burn_bps)","items":{"type":"object","additionalProperties":true}}}},"Quote":{"type":"object","properties":{"token":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"symbol":{"type":["string","null"]},"side":{"type":"string","enum":["buy","sell"]},"venue":{"type":"object","properties":{"index":{"type":"integer"},"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"name":{"type":"string"},"routerFeeBps":{"type":"integer"}}},"amountIn":{"type":"string","pattern":"^[0-9]+$","description":"An amount in the smallest unit (wei for ZRO, the token's own decimals for tokens), as a string. On this testnet 1 ZRO is 0.0001 of the native coin, so the ZRO side in wei is ZRO × 1e18 / 10000"},"amountOut":{"type":"string","pattern":"^[0-9]+$","description":"An amount in the smallest unit (wei for ZRO, the token's own decimals for tokens), as a string. On this testnet 1 ZRO is 0.0001 of the native coin, so the ZRO side in wei is ZRO × 1e18 / 10000"},"minAmountOut":{"type":"string","pattern":"^[0-9]+$","description":"An amount in the smallest unit (wei for ZRO, the token's own decimals for tokens), as a string. On this testnet 1 ZRO is 0.0001 of the native coin, so the ZRO side in wei is ZRO × 1e18 / 10000"},"amountInFormatted":{"type":"string"},"amountOutFormatted":{"type":"string"},"minAmountOutFormatted":{"type":"string"},"price":{"type":"number","description":"ZRO per token"},"slippageBps":{"type":"integer"},"tokenFeeBps":{"type":["integer","null"],"description":"One of ours: its fee, the 1% base included"},"trader":{"type":["string","null"],"pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"builder":{"type":["object","null"],"properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"kind":{"type":"integer","const":2},"applied":{"type":"boolean"},"reason":{"type":["string","null"]}}},"deadline":{"type":"integer","description":"Unix seconds"},"approvals":{"type":"array","items":{"$ref":"#/components/schemas/Tx"},"description":"A sale: the approval to send first when the allowance is short"},"transaction":{"oneOf":[{"$ref":"#/components/schemas/Tx"},{"type":"null"}]},"note":{"type":["string","null"]},"chainId":{"type":"integer"}}},"Tx":{"type":"object","properties":{"from":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"to":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"data":{"type":"string"},"value":{"type":"string","pattern":"^[0-9]+$","description":"An amount in the smallest unit (wei for ZRO, the token's own decimals for tokens), as a string. On this testnet 1 ZRO is 0.0001 of the native coin, so the ZRO side in wei is ZRO × 1e18 / 10000"},"chainId":{"type":"integer"},"gas":{"type":["string","null"],"description":"Estimated; null when it waits for an approval"}}},"Staking":{"type":"object","properties":{"contract":{"type":["string","null"],"pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"token":{"type":["object","null"],"additionalProperties":true},"threshold":{"type":"number","description":"Tokens a wallet stakes, or stakes and holds, to trade without the terminal's cut; 0 is off"},"total_staked":{"type":"number"},"staked_share":{"type":["number","null"]},"stakers":{"type":"integer"},"reward_rate_per_day":{"type":["number","null"],"description":"ZRO streamed a day now"},"stream_ends":{"type":["integer","null"],"description":"Unix seconds"},"funded_week":{"type":["number","null"]},"total_funded":{"type":"number","description":"ZRO, in whole units"},"total_paid":{"type":"number","description":"ZRO, in whole units"},"from_treasury":{"type":"number","description":"ZRO, in whole units"},"apr":{"type":["number","null"],"description":"At the current stream and the token price; 0.1 is 10%"},"funded":{"type":"array","items":{"type":"object","properties":{"tx_hash":{"type":"string"},"ts":{"type":"integer","description":"Unix seconds"},"from":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"from_treasury":{"type":"boolean"},"amount":{"type":"number","description":"ZRO, in whole units"},"rate_per_day":{"type":"number","description":"ZRO, in whole units"},"finish":{"type":"integer","description":"Unix seconds"}}}},"live":{"type":"boolean","description":"Whether the contract answered; without it the figures are from events"}}},"StakingWallet":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"staked":{"type":"number"},"held":{"type":"number"},"earned":{"type":["number","null"],"description":"Claimable now, from earnedOf"},"claimed":{"type":"number","description":"ZRO, in whole units"},"fee_free":{"type":["boolean","null"]},"events":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"PartnerEarnings":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"earned":{"type":"number","description":"ZRO, in whole units"},"calls":{"$ref":"#/components/schemas/PartnerKind"},"builder":{"$ref":"#/components/schemas/PartnerKind"},"recent":{"type":"array","items":{"type":"object","properties":{"tx_hash":{"type":"string"},"ts":{"type":"integer","description":"Unix seconds"},"token":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"symbol":{"type":["string","null"]},"trader":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"kind":{"type":"string","enum":["call","builder"]},"amount":{"type":"number","description":"ZRO, in whole units"}}}}}},"PartnerKind":{"type":"object","properties":{"earned":{"type":"number","description":"ZRO, in whole units"},"trades":{"type":"integer"},"wallets":{"type":"integer"},"tokens":{"type":"integer"},"volume":{"type":"number","description":"ZRO, in whole units"},"last_ts":{"type":["integer","null"],"description":"Unix seconds"}}},"Call":{"type":"object","properties":{"id":{"type":"string"},"caller":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"token":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"symbol":{"type":"string"},"note":{"type":["string","null"]},"created_at":{"type":"integer","description":"Unix seconds"},"ends_at":{"type":"integer","description":"Unix seconds"},"live":{"type":"boolean"},"share_path":{"type":"string","description":"The coin page with ?call=<id>; trades from it credit the caller for seven days"},"share_url":{"type":["string","null"]},"market_cap_at":{"type":"number","description":"ZRO, in whole units"},"market_cap_now":{"type":"number","description":"ZRO, in whole units"},"market_cap_peak":{"type":"number","description":"ZRO, in whole units"},"peak_multiple":{"type":"number"},"now_multiple":{"type":"number"},"buyers":{"type":"integer"},"bought":{"type":"number","description":"ZRO, in whole units"},"earned":{"type":"number","description":"Partner payments to the caller (kind 1) on this coin in the call's seven days"},"caller_sold":{"type":"boolean"}}},"Dashboard":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"code":{"type":["string","null"]},"keys":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"prefix":{"type":"string"},"label":{"type":["string","null"]},"createdAt":{"type":"string"},"lastUsedAt":{"type":["string","null"]},"revoked":{"type":"boolean"},"requestsToday":{"type":"integer"}}}},"last30Days":{"type":"object","properties":{"requests":{"type":"integer"},"quotes":{"type":"integer"},"transactions":{"type":"integer"},"daily":{"type":"array","items":{"type":"object"}}}},"onChain":{"type":"object","properties":{"volumeZro":{"type":"number","description":"ZRO, in whole units"},"earnedZro":{"type":"number","description":"ZRO, in whole units"},"trades":{"type":"integer"},"wallets":{"type":"integer"}}},"limits":{"type":"object","properties":{"keyed":{"type":"integer"},"anonymous":{"type":"integer"},"maxKeys":{"type":"integer"}}}}},"Board":{"type":"object","properties":{"kind":{"type":"string","enum":["traders","creators","points"]},"window":{"type":"string"},"total":{"type":"integer","description":"Rows on the whole board"},"removed":{"type":"integer","description":"Creators: taken off for selling or sending away more than dump_share of their own buy"},"dump_share":{"type":"number"},"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TraderRow"},{"$ref":"#/components/schemas/CreatorRow"},{"$ref":"#/components/schemas/PointsRow"}]}},"me":{"description":"The row for `address`, or null"}}},"TraderRow":{"type":"object","properties":{"rank":{"type":"integer"},"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"realised":{"type":"number","description":"Profit from sales in the window, by average cost over all time"},"volume":{"type":"number","description":"ZRO, in whole units"},"trades":{"type":"integer"},"sells":{"type":"integer"},"wins":{"type":"integer"},"best":{"oneOf":[{"type":"object","properties":{"token":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"symbol":{"type":"string"},"uri":{"type":["string","null"]},"realised":{"type":"number","description":"ZRO, in whole units"}}},{"type":"null"}]}}},"CreatorRow":{"type":"object","properties":{"rank":{"type":"integer"},"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"fees":{"type":"number","description":"The creator's part of every fee in the window"},"launches":{"type":"integer"},"graduated":{"type":"integer"},"volume":{"type":"number","description":"ZRO, in whole units"},"trades":{"type":"integer"},"best":{"oneOf":[{"type":"object","properties":{"token":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"symbol":{"type":"string"},"uri":{"type":["string","null"]},"market_cap":{"type":"number","description":"ZRO, in whole units"},"graduated":{"type":"boolean"}}},{"type":"null"}]}}},"PointsRow":{"type":"object","properties":{"rank":{"type":"integer"},"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"points":{"type":"integer"},"traded":{"type":"number","description":"ZRO, in whole units"},"on_coins":{"type":"number","description":"ZRO, in whole units"},"elsewhere":{"type":"number","description":"ZRO, in whole units"}}},"Position":{"type":"object","properties":{"spent":{"type":"number","description":"ZRO, in whole units"},"received":{"type":"number","description":"ZRO, in whole units"},"bought":{"type":"number"},"sold":{"type":"number"},"avg_entry":{"type":"number","description":"ZRO per token paid on average"},"value":{"type":"number","description":"ZRO, in whole units"},"realized":{"type":"number","description":"From sales, by average cost; everything once nothing is held"},"unrealized":{"type":"number","description":"ZRO, in whole units"},"pnl":{"type":"number","description":"ZRO, in whole units"},"pnl_pct":{"type":["number","null"]}}},"WalletPnl":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"totals":{"type":"object","additionalProperties":true,"properties":{"value":{"type":"number","description":"ZRO, in whole units"},"spent":{"type":"number","description":"ZRO, in whole units"},"received":{"type":"number","description":"ZRO, in whole units"},"realized":{"type":"number","description":"ZRO, in whole units"},"unrealized":{"type":"number","description":"ZRO, in whole units"},"pnl":{"type":"number","description":"ZRO, in whole units"},"positions":{"type":"integer"},"open":{"type":"integer"},"wins":{"type":"integer"},"losses":{"type":"integer"},"win_rate":{"type":["number","null"]},"trades":{"type":"integer"}}},"positions":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Position"},{"type":"object","properties":{"token":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"symbol":{"type":"string"},"name":{"type":"string"},"held":{"type":"number"},"trades":{"type":"integer"},"open":{"type":"boolean"},"first_ts":{"type":["integer","null"],"description":"Unix seconds"},"last_ts":{"type":["integer","null"],"description":"Unix seconds"}}}]}}}},"HoldersPnl":{"type":"object","properties":{"price":{"type":"number"},"holders":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Position"},{"type":"object","properties":{"rank":{"type":"integer"},"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"amount":{"type":"number"},"share":{"type":"number"},"buys":{"type":"integer"},"sells":{"type":"integer"},"first_buy":{"type":["integer","null"],"description":"Unix seconds"},"last_trade":{"type":["integer","null"],"description":"Unix seconds"},"labels":{"type":"array","items":{"type":"string"}}}}]}}}},"Bubbles":{"type":"object","properties":{"price":{"type":"number"},"nodes":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"amount":{"type":"number"},"share":{"type":"number"},"value":{"type":"number","description":"ZRO, in whole units"},"cluster":{"type":["integer","null"],"description":"Which cluster, numbered from 1; null when alone"},"labels":{"type":"array","items":{"type":"string"}}}}},"links":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"target":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"amount":{"type":"number","description":"Tokens sent, all time"}}}},"clusters":{"type":"array","items":{"type":"object","properties":{"cluster":{"type":"integer"},"wallets":{"type":"integer"},"share":{"type":"number"},"members":{"type":"array","items":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"}}}}},"clustered_share":{"type":"number","description":"Supply held by linked wallets"}}},"StatsMore":{"type":"object","additionalProperties":true,"properties":{"range":{"type":"string"},"bucket":{"type":"integer","description":"Seconds per point of user_series"},"users":{"type":"object","properties":{"active":{"type":"integer"},"new":{"type":"integer"},"returning":{"type":"integer"},"returning_share":{"type":"number"}}},"user_series":{"type":"array","items":{"type":"object","properties":{"t":{"type":"integer","description":"Unix seconds"},"active":{"type":"integer"},"new":{"type":"integer"},"returning":{"type":"integer"}}}},"revenue":{"type":"object","additionalProperties":true},"launchpads":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"volume":{"type":"number","description":"ZRO, in whole units"},"share":{"type":"number"},"trades":{"type":"integer"},"traders":{"type":"integer"},"tokens_traded":{"type":"integer"},"launched":{"type":"integer"}}}},"feed":{"type":"array","description":"The newest 30 trades, launches and graduations, newest first; /api/v1/stream has them live","items":{"type":"object","additionalProperties":true,"properties":{"type":{"type":"string","enum":["trade","launch","graduated"]},"ts":{"type":"integer","description":"Unix seconds"},"token":{"type":"string","pattern":"^0x[0-9a-fA-F]{40}$","description":"An EVM address; answers give it lowercase"},"symbol":{"type":"string"}}}}}},"Status":{"type":"object","properties":{"checked_every":{"type":"integer"},"overall":{"type":"string","enum":["up","partial","down"]},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","examples":["indexer","rpc","keeper","web"]},"name":{"type":"string"},"state":{"type":"string","enum":["up","down","stale","unknown"]},"checked":{"type":["integer","null"],"description":"Unix seconds"},"ms":{"type":["integer","null"]},"note":{"type":["string","null"]},"uptime_24h":{"type":["number","null"]},"uptime_7d":{"type":["number","null"]},"uptime_90d":{"type":["number","null"]},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"integer","description":"Unix seconds"},"uptime":{"type":["number","null"]},"checks":{"type":"integer"}}}}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"service":{"type":"string"},"name":{"type":"string"},"started":{"type":"integer","description":"Unix seconds"},"ended":{"type":["integer","null"],"description":"Unix seconds"},"minutes":{"type":"integer"},"note":{"type":["string","null"]}}}}}}}}}