> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vibechain.com/llms.txt
> Use this file to discover all available pages before exploring further.

# vibe.market API Introduction

> Welcome to the vibe.market Boosterbox API

## Overview

The vibe.market Boosterbox API provides programmatic access to manage boosterboxes, games, and related metadata on the vibe.market platform.

Start by creating a **free API key**! We use API keys to prevent abuse.

```bash theme={null}
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "description": "YOUR_DESCRIPTION",
    "email": "YOUR_EMAIL"
  }' \
  https://build.vibechain.com/apikey/create
```

| Field         | Description                               |
| ------------- | ----------------------------------------- |
| `DESCRIPTION` | The name and description of the project.  |
| `EMAIL`       | Your email address for any notifications. |

You'll use this API key as a request header in your HTTP request (`API-KEY`).

## Base URL

All API endpoints are available at:

```
https://build.vibechain.com/vibe/boosterbox
```

## Authentication

Most read endpoints are publicly accessible without authentication.

## Rate Limiting

The API implements different rate limits to ensure fair usage - if you hit limits, reach out to us at [gm@vibechain.com](mailto:gm@vibechain.com).

## Response Format

All endpoints return responses in a consistent JSON format:

```json theme={null}
{
  "success": true,
  "data": {
    // Response data
  }
}
```

Error responses follow the same format:

```json theme={null}
{
  "success": false,
  "message": "Error description"
}
```

## Common Parameters

### Chain ID

Most endpoints accept a `chainId` parameter. The default is `8453` (Base mainnet).

### Pagination

List endpoints support pagination with:

* `page`: Page number (default: 1)
* `limit`: Results per page (default varies by endpoint)
* `cursor`: Some endpoints use cursor-based pagination

### Filtering

Many endpoints support filtering by:

* `status`: Filter by boosterbox status
* `rarity`: Filter by rarity level (0-4)
* `contractAddress`: Filter by specific contract
* `gameId`: Filter by game ID

## Getting Started

1. **Browse Games**: Use `/games` or `/featured` to discover available games
2. **Get Contract Info**: Use `/contractAddress/{address}` to get details about a specific game
3. **View Boosterboxes**: Use `/owner/{address}` to see boxes owned by an address
4. **Check Metadata**: Use `/metadata` endpoints to view card metadata and odds

## Support

For API support or to report issues, please contact the vibe.market team through the official channels.