API reference

Every public endpoint.

31 GET endpoints. Base https://app.cartel.family · OpenAPI 3.1

Market

GET /api/market/live #

The live market: trending tokens across every chain, balanced per chain, with price, 24h move, liquidity and volume.

application/json

https://app.cartel.family/api/market/live

Code

GET /api/majors #

The majors: the large tokens of every chain (listed as their wrapped contract) with live price and 24h move.

application/json 60 / 60s

Parameters (4)

Name	In	Type	Description
`q`	query	string	Filter by symbol or name.
`chain`	query	string	Candles for one asset code: with pair/tf, returns that major's OHLC instead of the list.
`pair`	query	string	Asset code for candles (with chain and tf).
`tf`	query	string	Candle timeframe for the candles form.

https://app.cartel.family/api/majors

Code

GET /api/market/token-prices #

Current price and market cap for several tokens at once.

application/json 120 / 60s

Parameters (1)

Name	In	Type	Description	Value
`mints`*	query	string	Comma-separated token addresses (Solana mints or 0x contracts).

https://app.cartel.family/api/market/token-prices

Code

GET /api/token/info/<mint_address> #

One token as the market sees it: name, symbol, price, liquidity, volume, pair and chain.

application/json

Parameters (2)

Name	In	Type	Description	Value
`mint_address`*	path	string	Token address.
`chain`	query	string	Chain id for a 0x contract (see Chains); omitted means Solana.

https://app.cartel.family/api/token/info/<mint_address>

Code

GET /api/chart/<mint> #

Price history for a token: the one chart endpoint every surface draws from.

application/json

Parameters (4)

Name	In	Type	Description
`mint`*	path	string	Token address.
`chain`	query	string	Chain id for a 0x contract.
`tf`	query	string	Timeframe (as the token page offers).
`pair`	query	string	A specific pair address.

https://app.cartel.family/api/chart/<mint>

Code

GET /api/token/<mint>/candles #

OHLC candles for a token.

application/json

Parameters (2)

Name	In	Type	Description	Value
`mint`*	path	string	Token address.
`range`	query	string	Window, e.g. 1h, 24h, 7d.

https://app.cartel.family/api/token/<mint>/candles

Code

GET /api/token/<mint>/trust #

Safety checks for a token, or "unchecked" when the chain has no checker.

application/json 30 / 60s

Parameters (3)

Name	In	Type	Description
`mint`*	path	string	Token address.
`chain`	query	string	Chain id.
`pair_created_at`	query	integer	Pair creation time (ms) when known; sharpens the age signal.

https://app.cartel.family/api/token/<mint>/trust

Code

GET /api/token/<mint>/family #

Members who hold this token (handles only).

application/json 60 / 60s

Parameters (1)

Name	In	Type	Description	Value
`mint`*	path	string	Token address.

https://app.cartel.family/api/token/<mint>/family

Code

GET /api/dexscreener/search #

Token search by name, ticker or address, in the full pair shape.

application/json

Parameters (1)

Name	In	Type	Description	Value
`q`*	query	string	Name, ticker or address.

https://app.cartel.family/api/dexscreener/search

Code

Social

GET /api/feed/trades #

The trade feed: who bought what, how it is going, who else is in it. The unit of content of the whole product.

application/json

Parameters (5)

Name	In	Type	Description
`filter`	query	string	Feed filter as the app offers (for-you, new, ...).
`limit`	query	integer	Page size.
`before`	query	string	Cursor from the previous page.
`mint`	query	string	Only trades in this token.
`launches`	query	integer	1 to interleave launch events (For you only).

https://app.cartel.family/api/feed/trades

Code

GET /api/leaderboard #

Top traders by realised P&L in a rolling 24h window.

application/json 60 / 60s

https://app.cartel.family/api/leaderboard

Code

GET /api/leaderboard/series #

The whole family's realised profit over time.

application/json 60 / 60s

Parameters (1)

Name	In	Type	Description	Value
`range`	query	string	Window, e.g. 7d, 30d.

https://app.cartel.family/api/leaderboard/series

Code

GET /api/online-count #

How many members are here right now (a heartbeat in the last 3 minutes).

application/json 30 / 60s

https://app.cartel.family/api/online-count

Code

Game

GET /api/game/ladder #

The family-rank ladder: how many members hold each rank (counts only).

application/json 60 / 60s

https://app.cartel.family/api/game/ladder

Code

GET /api/game/season #

This week's season race: handle, rank and score. Never a wallet, id or avatar.

application/json 60 / 60s

https://app.cartel.family/api/game/season

Code

GET /api/game/ranks #

The ranks of up to 60 handles at once.

application/json 120 / 60s

Parameters (1)

Name	In	Type	Description	Value
`handles`*	query	string	Comma-separated handles.

https://app.cartel.family/api/game/ranks

Code

GET /api/game/profile/<handle> #

One member's public game profile: rank, XP, badges.

application/json 120 / 60s

Parameters (1)

Name	In	Type	Description	Value
`handle`*	path	string	The member's handle, without @.

https://app.cartel.family/api/game/profile/<handle>

Code

Launchpad

GET /api/launch/status #

Which launch venues are open on which chains, and the launch fee.

application/json 60 / 60s

https://app.cartel.family/api/launch/status

Code

GET /api/launch/launches #

The launch board: Running (tokens that clear the quality bar, the default) / New / Hot / Near graduation, ours and the outside launchpads.

application/json

Parameters (4)

Name	In	Type	Description
`sort`	query	string	running (default) \| new \| trending \| progress \| graduated
`limit`	query	integer	Rows (default 30).
`launchpad`	query	string	all \| ours \| an outside launchpad id.
`chain`	query	string	all or a chain id.

https://app.cartel.family/api/launch/launches

Code

GET /api/launch/token/<mint> #

One launched token: its curve, creator, graduation state and the members here who hold it.

application/json 60 / 60s

Parameters (1)

Name	In	Type	Description	Value
`mint`*	path	string	The launched token's address.

https://app.cartel.family/api/launch/token/<mint>

Code

Platform

GET /api/platform/landing-stats #

All-time platform figures, as the landing page shows them.

application/json 60 / 60s

https://app.cartel.family/api/platform/landing-stats

Code

GET /api/platform/landing-live #

The latest launches and recent call outcomes, public fields only.

application/json 60 / 60s

https://app.cartel.family/api/platform/landing-live

Code

GET /api/live/since #

What is new since your last call: trades, launches, calls. The first call returns the cursor only.

application/json 90 / 60s

Parameters (4)

Name	In	Type	Description
`trade`	query	integer	Trade cursor from the previous answer.
`launch`	query	integer	Launch cursor.
`call`	query	integer	Call cursor.
`mints`	query	string	Comma-separated tokens whose prices to include.

https://app.cartel.family/api/live/since

Code

GET /api/live/members-in #

How many members are in each of several tokens, with a few faces.

application/json 60 / 60s

Parameters (1)

Name	In	Type	Description	Value
`mints`*	query	string	Comma-separated token addresses.

https://app.cartel.family/api/live/members-in

Code

GET /api/version #

The running commit.

application/json 120 / 60s

https://app.cartel.family/api/version

Code

GET /api/v1/mobile/health #

Platform constants: the fee in bps per leg, the chain list, minimums.

application/json 60 / 60s

https://app.cartel.family/api/v1/mobile/health

Code

GET /api/status/heartbeat #

Platform heartbeat: ok, slow or down, for a status page.

application/json 120 / 60s

https://app.cartel.family/api/status/heartbeat

Code

Cards & links

GET /api/pnl-card/token/<mint>.png #

The token card as a PNG (1200x630): price, 24h move, depth, members in it, the last day's shape.

image/png 60 / 60s

Parameters (1)

Name	In	Type	Description	Value
`mint`*	path	string	Token address.

https://app.cartel.family/api/pnl-card/token/<mint>.png

Code

GET /api/pnl-card/trader/<wallet>.png #

A trader's P&L card as a PNG.

image/png 60 / 60s

Parameters (1)

Name	In	Type	Description	Value
`wallet`*	path	string	The trader's wallet address.

https://app.cartel.family/api/pnl-card/trader/<wallet>.png

Code

GET /api/pnl-card/launch/<mint>.png #

The launch card as a PNG: the one the public channel posts.

image/png 60 / 60s

Parameters (1)

Name	In	Type	Description	Value
`mint`*	path	string	The launched token's address.

https://app.cartel.family/api/pnl-card/launch/<mint>.png

Code

GET /t/<mint> #

The share link for a token: unfurls as its card and opens the token with your code attached.

text/html 60 / 60s

Parameters (3)

Name	In	Type	Description
`mint`*	path	string	Token address.
`chain`	query	string	Chain id for a 0x contract.
`ref`	query	string	Your code.

https://app.cartel.family/t/<mint>

Code