Skip to content
rare
⌘K
Marketplace API

Getting started

Quickstart

The rare.market API base URL, a first request for the top collections on Sui, and what the response contains.

The rare.market API is a JSON REST API over HTTPS. It serves the same data as rare.market: collections, items, listings from every venue, offers, activity, holders and wallets on Sui.

Base URL

Text
https://rare.market/api/v1

Paths in these docs are relative to the base URL. GET /collections means https://rare.market/api/v1/collections.

Reads need no account or key. See Authentication for API keys and higher limits.

Make a first request

Get the top two collections by 24 hour volume:

GET/collections
curl "https://rare.market/api/v1/collections?window=24h&sort=volume&limit=2"
Response
{
  "data": [
    {
      "slug": "popkins",
      "name": "Popkins",
      "imageUrl": "https://storage.claynosaurz.com/popkins/images/0x817dac94fff3a567b80e23a3b55fca2fd108641e0dd06fc614e5ecc0acbb4e03",
      "verified": true,
      "rank": 1,
      "supply": 25000,
      "floorMist": "68040000000",
      "floorChangePct": 0,
      "topOfferMist": "48000000000",
      "volumeMist": "1697809900000",
      "volumeChangePct": -58.83,
      "sales": 24,
      "listedCount": 412,
      "owners": 3643,
      "uniqueOwnersPct": 14.61,
      "marketCapMist": "1701000000000000"
    },
    {
      "slug": "mystic-yetis",
      "name": "Mystic Yetis",
      "imageUrl": "https://indexer.mypinata.cloud/ipfs/bafkreid6owvnhp2v2muf4yrk4v3hjonhposfgsnd5zirfzgbyutxoasxay",
      "verified": true,
      "rank": 2,
      "supply": 5555,
      "floorMist": "26748930000",
      "floorChangePct": 0,
      "topOfferMist": "15300000000",
      "volumeMist": "1177818600000",
      "volumeChangePct": 737.92,
      "sales": 54,
      "listedCount": 494,
      "owners": 1897,
      "uniqueOwnersPct": 34.58,
      "marketCapMist": "148590306150000"
    }
  ],
  "nextCursor": "eyJzbHVnIjoibXlzdGljLXlldGlzIiwicmFuayI6Mn0",
  "total": 968,
  "hiddenArt": 274,
  "next": "eyJzbHVnIjoibXlzdGljLXlldGlzIiwicmFuayI6Mn0",
  "units": { "amount": "MIST", "decimals": 9, "symbol": "SUI" }
}

What comes back

  • A page. Lists return { data, next, total? }. Pass next back as cursor to get the next page; null means there are no more. nextCursor carries the same value. See Pagination.
  • Amounts in MIST. Fields ending in Mist are decimal strings of MIST (1 SUI = 1,000,000,000 MIST). "68040000000" is 68.04 SUI. Every JSON object response repeats this in units. Parse them with BigInt or Decimal, never as floats. See Amounts and decimals.
  • All-in floors. floorMist is the lowest price a buyer pays across every venue, including venue fees and creator royalty.
  • Unknown is null. A collection with no listings has floorMist: null.
  • Slugs. Use slug to address a collection in other calls, for example GET /collections/popkins/items.
  • Errors. Any non-2xx response has the body { "error": { "code", "message" } }. See Errors.

Next steps

Collections and statsCollection details, rankings and stats.Listings across venuesEvery live listing with its all-in price.Rate limitsHow many requests you can make and how to back off.API referenceEvery endpoint and response shape.
--
TPS:--