Overview
The vibe.market API is the production HTTP interface behind vibe.market. It exposes packs and card metadata, collections, market activity, game discovery, creator drafts, allowlists, recovery tools, chat, leaderboards, and platform analytics on Base. The reference in this tab documents the complete routable API surface. Unless an endpoint says otherwise, requests and responses use JSON.Base URL
chainId: 8453) is the default wherever a chain is optional.
Create an API key
Most endpoints require a free caller-specific API key:API-KEY header:
Authentication model
The API has two independent authentication layers:
Endpoints that show both security requirements need both headers. A Bearer
token never replaces an API key unless the endpoint explicitly lists only
Bearer authentication.
The OpenSea-compatible collection and token metadata routes are public and do
not require either credential.
Quick starts
Discover featured games
List an owner’s packs
Read collection activity incrementally
cursor value. Cursors are
endpoint-specific: activity uses a block-number cursor, while /recent uses a
timestamp-objectId cursor.
Response conventions
Most application routes return a top-levelsuccess boolean plus named data:
data envelope. The OpenSea metadata
routes return standard metadata objects directly, and /unboxing-disallowed
returns { "disallowed": boolean }.
Errors normally use this shape:
status, available, ready, or receiptFound where the reference
documents a successful negative result.
Values and identifiers
- EVM addresses are
0x-prefixed, 20-byte strings. - Transaction hashes are
0x-prefixed, 32-byte strings. - Token IDs may exceed JavaScript’s safe integer range in external systems; preserve identifier strings when your client library provides them that way.
- Onchain prices and rewards are returned as decimal strings in Wei unless a
field explicitly ends in
UsdorEth. - Rarity codes are
0not assigned,1Common,2Rare,3Epic,4Legendary, and5Mythic. - Pack status is one of
minted,opened,rarity_assigned, orburned.
Pagination
Page-based endpoints returnpage, limit, total, and totalPages.
Cursor-based endpoints return a next cursor when another page may exist. Treat
cursor values as opaque even when their current format is documented.
Limits vary by endpoint. The OpenAPI reference records the actual default and
maximum for each route; do not assume one global page size.
Image delivery
Responses normally rewrite recognized CDN image URLs through the vibe.market image proxy. Server-side integrations that want the originalimagedelivery.net URLs can send:
Rate limits
Standard keys receive these per-IP allowances. Approved keys may have a higher multiplier.
For API-key routes, a missing key, invalid key, and exhausted quota intentionally
share the same
429 response:
429. Contact
gm@vibechain.com for higher limits.
HTTP status guide
Caching and freshness
Read endpoints use endpoint-specific server caches, generally from 5 seconds for rapidly changing pack/game state to 5 minutes for stable metadata and analytics. Several hot endpoints also returnCache-Control headers.
- Honor response cache headers when present.
- Do not assume all list endpoints have the same freshness window.
- Use
/contractAddress/{contractAddressOrSlug}/readywhile newly created metadata is processing. - Use
/events/{txHash}only as an authenticated recovery path after normal indexing has not produced the expected state. - Treat chat stream data and collection events as refresh signals; refetch the durable resource after a gap.
Creator workflow
The usual offchain-to-onchain flow is:- Create or autosave a draft with
POST /metadata/draft/poll. - Add and finalize an allowlist if the launch is gated.
- Deploy the collection from a wallet linked to the signed-in account.
- Attach the transaction with
POST /metadata/confirm. - Poll readiness and read the published game by address or slug.
- Use
PUT /metadata/{contractAddress}for later metadata revisions.