API reference

API overview

The Zpad app runs on this API. Anyone can read coin data with it.

Address

The API lives on the app's own address. Every path in these docs is relative, for example /api/v1/coins. To call it, put the address you open Zpad on in front of the path.

The examples show the full address once this page has loaded in your browser.

Format

Requests and answers are JSON, except the launch form, which is sent as multipart form data.
Answers under /api/v1 come in one envelope: success, message and data.
Three parts answer plain JSON without the envelope: the launch routes (/api/v1/launch/...), sign in (/api/auth) and the Solana relay (/api/rpc). Their pages say so.

The envelope

{
  "success": true,
  "message": "<what happened, in plain words>",
  "data": <the answer>
}

How to read the shapes

number, string and boolean stand for a value of that type.
Values in angle brackets, like "<coin address>", are examples of what goes there.
a | b means either one.
Every other value is exactly what the API sends.

Units

Kind	Unit
SOL amounts	Numbers in SOL, unless the field says lamports
Lamports	Strings. 1 SOL is 1,000,000,000 lamports
USD amounts	Numbers, or strings where the field says so
Prices	SOL per token, as a decimal string
Token amounts	Whole tokens (6 decimals already applied), except holder totals, which are raw units
Times	Milliseconds for coin and trade times, seconds for candles, holders and points history, ISO 8601 strings elsewhere
Addresses and signatures	Base58 strings

Caching

Answer	Cached
Coin lists, search, holders, prices, rates, leagues	15 seconds at the edge, then refreshed in the background
One coin, its trades, candles and chat	5 seconds at the edge
Anything for the signed in wallet, every change and every error	Never

Sections

Page	What it covers
Authentication	Wallet sign in, the session cookie and the CSRF header
Rate limits	How many requests each route takes
Errors	Error shapes and status codes
Coins	Coin lists, search, one coin, trades, holders, candles and chat
Chat and favorites	Posting messages and saving favorites
Trading	Building trades, following transactions and the SOL price
Launch	Launching a coin from code
Account	Your coins, favorites, holdings and settings
Points and tickets	Tickets, redeeming, points, leagues and the graduation bonus
Referrals	Referral links, visits and claims
Solana relay	The site's own Solana connection

Good to know

The API serves the Zpad pages first. Shapes follow what the pages need.
Routes under /api/cron are internal jobs. They need the server's own secret and are not part of the API.
Changes are listed in the Changelog.