## Use cases

Things you can build with the CoinWorldCap API, each written as the calls to make and the
order to make them in. Every call carries your key in `X-Api-Key`
([Authentication](#authentication)). A value in angle brackets, such as `<id>`, is one you take
from the response of an earlier call.

Look a thing up by `slug` once, then use the `id` that comes back —
[Best practices and FAQ](#best-practices-and-faq) says why.

### Research tokenized real-world assets

Tokenized stocks, commodities, currencies, government securities, ETFs and real estate: which
are the biggest, who issues them, where the underlying asset trades, and how their prices have
moved.

```bash
# 1. The ten biggest tokenized commodities by market cap
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/rwa?type=commodity&sort=market_cap:desc&limit=10"

# 2. One of them in full, by the slug of a row above: its profile, every token that
#    tracks it, and its traditional markets
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/rwa/info?slug=<slug>"

# 3. The issuers behind the tokens, biggest first
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/rwa/issuers?limit=10"

# 4. Later, refresh the prices of the RWAs you follow in one call, by the ids from step 1
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/rwa?id=<id>,<id>"

# 5. One RWA's daily history over a range, by an id from step 1
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/rwa/history?id=<id>&time_start=2026-01-01T00:00:00Z&time_end=2026-03-31T00:00:00Z"
```

`last_price_change_time` on each row is when its values last changed. Older history points can
carry a price only. See [`/rwa`](#get-openapiv1rwa),
[`/rwa/info`](#get-openapiv1rwainfo), [`/rwa/issuers`](#get-openapiv1rwaissuers) and
[`/rwa/history`](#get-openapiv1rwahistory).

### Compare earn yields for a coin

Where a coin can be staked, lent or saved, at what rate, and how that rate has moved — with
promotional rates kept apart, so that one platform's short-lived offer does not decide the
comparison.

```bash
# 1. The coin's id
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/assets?slug=ethereum"

# 2. Every platform's products for it
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/earn?id=<id>"

# 3. How one platform's rates have moved, day by day, by a provider_id from step 2
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/earn/history?id=<id>&provider_id=<provider_id>"
```

Compare platforms on `providers[].apy_min` and `providers[].apy_max`, which leave out products
with `is_promo` set. The history is kept per product, and a renamed product starts a new series.
See [`/earn`](#get-openapiv1earn) and [`/earn/history`](#get-openapiv1earnhistory).

### Monitor funding rates and open interest

Where a coin's perpetual contracts trade, what they pay in funding, and how funding and open
interest move over time.

```bash
# 1. The coin's id
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/assets?slug=bitcoin"

# 2. Its ten perpetual contracts with the most open interest, across exchanges
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/derivatives/pairs?id=<id>&category=perpetual&sort=open_interest_usd:desc&limit=10"

# 3. The ten exchanges with the most perpetual open interest
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/derivatives/exchanges?category=perpetual&limit=10"

# 4. The coin's funding rate, open interest and basis, hour by hour
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/derivatives/history?id=<id>&interval=1h"
```

A row of `/derivatives/pairs` is one contract on one exchange; a point of `/derivatives/history`
combines the coin's perpetual contracts that pass our filters ([Data methodology](#derivatives)). See
[`/derivatives/pairs`](#get-openapiv1derivativespairs),
[`/derivatives/exchanges`](#get-openapiv1derivativesexchanges) and
[`/derivatives/history`](#get-openapiv1derivativeshistory).

### Research a chain's market

How big each chain's market is, how it has changed, and which asset a contract address on that
chain belongs to.

```bash
# 1. The ten chains with the most 24-hour volume
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/chains?sort=volume_24h:desc&limit=10"

# 2. One chain by slug, for its id
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/chains?slug=ethereum"

# 3. The asset behind a contract address on that chain, with every chain it is deployed on
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/assets?chain_id=<id>&contract_address=0xdAC17F958D2ee523a2206206994597C13D831ec7&fields=platforms"

# 4. The chain's daily market cap and volume, newest days
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/chains/history?id=<id>"
```

`chain_id` is our chain `id` from `/chains`, not an EVM chain id. See
[`/chains`](#get-openapiv1chains), [`/assets`](#get-openapiv1assets) and
[`/chains/history`](#get-openapiv1chainshistory).

### Discover and follow DEX tokens

New and trending tokens on decentralized exchanges, then one token's trades, liquidity, holders,
pools and price candles.

```bash
# 1. The chains the New list covers
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/dex/chains?list=new"

# 2. New tokens on Solana, with New's own filters sent explicitly: at least $10,000 of
#    liquidity, high-risk ones left out
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/dex/tokens?list=new&chain_slug=solana&liquidity_min=10000&hide_high_risk=true&limit=10"

# 3. Or find a token by name, symbol or address
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/dex/search?q=pepe"

# 4. One token, by the chain_slug and address of a row above
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/dex/tokens/info?chain_slug=<chain_slug>&address=<address>"

# 5. Its recent trades, liquidity changes, holders and pools
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/dex/tokens/trades?chain_slug=<chain_slug>&address=<address>"
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/dex/tokens/liquidity?chain_slug=<chain_slug>&address=<address>"
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/dex/tokens/holders?chain_slug=<chain_slug>&address=<address>"
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/dex/tokens/pools?chain_slug=<chain_slug>&address=<address>"

# 6. Price candles, hour by hour, of the token found in step 3
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/dex/tokens/history?chain_slug=<chain_slug>&address=<address>&interval=1h"
```

A DEX token is named by `chain_slug` and `address`, not by the `id` on its row, and
`data_time` and `stale` say how fresh its data is — see
[DEX tokens: what the endpoints share](#dex-tokens-what-the-endpoints-share). Page through
trades with `next_cursor` ([`/dex/tokens/trades`](#get-openapiv1dextokenstrades)). Not every
token has candles — one without them answers `points: []` — and the newest candle may still be
open ([`/dex/tokens/history`](#get-openapiv1dextokenshistory)).

### Check the team behind a project

Who works on a project or an exchange, and what else those people are involved in.

```bash
# 1. The project's team
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/assets/team?slug=uniswap"

# 2. One member in full: the projects and exchanges they are tied to, and their investments
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/people/info?id=<id>"

# 3. An exchange's team
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/exchanges/team?slug=binance"

# 4. Or start from a name
curl -H "X-Api-Key: <your-api-key>" \
  "https://open-api.coinworldcap.com/openapi/v1/people?q=vitalik"
```

See [`/assets/team`](#get-openapiv1assetsteam), [`/exchanges/team`](#get-openapiv1exchangesteam),
[`/people`](#get-openapiv1people) and [`/people/info`](#get-openapiv1peopleinfo).
