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

# Getting Started

> Build on Burst with the upcoming API for market data and protocol state.

Build on top of Burst with the upcoming Burst API.

It will provide structured access to market data, token state, and protocol-level information.

<Warning>
  The Burst API is not yet publicly available.

  It will be released alongside the Burst platform launch.
</Warning>

## What the API will support

The Burst API will allow developers to:

* access token and market data,
* track launches, graduations, and merges,
* build dashboards, bots, and analytics tools,
* and integrate Burst markets into external platforms.

## Availability

The API will launch with the platform.

Full documentation, endpoints, and examples will be published at that time.

<CardGroup cols={2}>
  <Card title="Public release">
    The API is upcoming.

    General access is not open yet.
  </Card>

  <Card title="At launch">
    Endpoints, examples, and auth flows will be published.
  </Card>
</CardGroup>

## Authentication

All API requests will require authentication using an API key.

### API keys

API keys will be generated through the Burst developer portal.

Each account will be able to create multiple keys.

Keys can be revoked at any time.

### Usage

API keys must be included in the request headers.

```http title="Request header" theme={null}
x-api-key: YOUR_API_KEY
```

Authentication will be required for:

* most data endpoints,
* and all sensitive or execution-related endpoints.

## Rate limits

The Burst API will enforce rate limits to protect fair usage and system stability.

Rate limits can apply:

* per account,
* per IP,
* and across all API keys.

Limits may vary based on:

* endpoint type,
* access level,
* and system load.

More sensitive endpoints will have stricter limits.

<Note>
  The API is designed for reliable access, not unrestricted extraction.

  Higher-risk surfaces will have tighter controls.
</Note>

## Access limitations

Not all internal systems will be fully exposed through the API.

Burst prioritizes protocol integrity over maximum surface area.

Some capabilities may be:

* rate limited,
* partially abstracted,
* delayed,
* restricted,
* or partner-gated.

This matters especially for systems such as:

* token deployment,
* execution routing,
* merge logic,
* and metadata resolution.

These are core protocol systems.

Some of them may have limited or controlled API access to prevent abuse.

## Abuse prevention

The Burst API includes protections against:

* brute force attacks,
* spam deployments,
* excessive polling,
* automated abuse patterns,
* and bot-driven manipulation.

That means:

* some endpoints may enforce stricter limits,
* some actions may require additional validation,
* and some capabilities may not be publicly available.

## Example endpoint preview

Below is an example of how Burst API endpoints will be structured.

### Get token market data

```http title="Request" theme={null}
POST /api/v1/data/token
content-type: application/json
x-api-key: YOUR_API_KEY

{
  "mint": "TOKEN_MINT_ADDRESS"
}
```

```json title="Response" theme={null}
{
  "data": {
    "mint": "TOKEN_MINT_ADDRESS",
    "is_migrated": true,
    "is_canonical": true,
    "identity_id": "abc123",
    "current_market_cap_usd": 123456,
    "current_volume_usd": 98765,
    "liquidity_usd": 54321,
    "current_symbol": "TOKEN",
    "current_name": "Token Name",
    "current_image_uri": "https://...",
    "merge_status": "canonical",
    "last_metadata_update": 1710000000
  }
}
```

This reflects Burst-specific concepts such as:

* canonical token state,
* merged markets,
* identity clustering,
* and metadata resolution.

## Streaming support

Realtime data access is planned.

Streaming support may be released in phases.

Expected event coverage includes:

* token launches,
* graduations,
* merge events,
* metadata updates,
* volume updates,
* and leaderboard changes.

## Partner access

Some API capabilities may be reserved for:

* approved integrations,
* routing partners such as Axiom,
* and analytics platforms.

Public API access and partner API access may differ.

## Versioning

The Burst API will be versioned at launch.

```title="Base path" theme={null}
/api/v1/
```

Future updates will aim for backward compatibility where possible.