API Access

Manage your API access and usage

{#if !$USER_DATA}

Sign in required

Sign in to get your free API key.

{:else} Today's Usage
{todayUsage.toLocaleString()} requests {maxDailyRequests.toLocaleString()} max

{Math.max(0, maxDailyRequests - todayUsage).toLocaleString()} requests remaining today

API Key

Use this key to authenticate your API requests

{#if apiKeyId} {/if}
{#if apiKey && justCreated}
This is the only time your full API key will be shown. If you lose it, you'll need to create a new one.
{:else if !apiKey && data.apiKey && apiKeyId}

For security reasons, the full API key is only shown once upon creation. If you've lost your key, you'll need to regenerate it.

{:else} {/if} API Documentation

Authentication

{#if authOpen} {:else} {/if}

Include your API key in the Authorization header for all requests:

Get Top Coins

GET /api/v1/top

{#if topCoinsOpen} {:else} {/if}

Returns the top 50 coins by market cap.

Endpoint

Example Response

Get Market Data

GET /api/v1/market

{#if marketDataOpen} {:else} {/if}

Returns paginated market data with filtering and sorting options.

Endpoint

Query Parameters

search - Search by coin name or symbol
sortBy - Sort field: marketCap, currentPrice, change24h, volume24h, createdAt (default: marketCap)
sortOrder - Sort order: asc, desc (default: desc)
priceFilter - Price range: all, under1, 1to10, 10to100, over100 (default: all)
changeFilter - Change filter: all, gainers, losers, hot, wild (default: all)
page - Page number (default: 1)
limit - Items per page, max 100 (default: 12)

Example Response

Get Coin Details

GET /api/v1/coin/{symbol}

{#if coinDetailsOpen} {:else} {/if}

Returns detailed information about a specific coin including price history.

Endpoint

Parameters

symbol - Coin symbol (e.g., "TEST")
timeframe - Optional. Chart timeframe: 1m, 5m, 15m, 1h, 4h, 1d (default: 1m)

Example Response

Get Coin Holders

GET /api/v1/holders/{symbol}

{#if holdersOpen} {:else} {/if}

Returns the top 50 holders of a specific coin.

Endpoint

Parameters

symbol - Coin symbol (e.g., "TEST")
limit - Number of holders to return, max 200 (default: 50)

Example Response

Get Prediction Markets (Hopium)

GET /api/v1/hopium

{#if hopiumOpen} {:else} {/if}

Returns prediction market questions with pagination and filtering options.

Endpoint

Query Parameters

status - Filter by status: ACTIVE, RESOLVED, CANCELLED, ALL (default: ACTIVE)
page - Page number (default: 1)
limit - Items per page, max 100 (default: 20)

Example Response

Get Prediction Market Details

GET /api/v1/hopium/{question_id}

{#if hopiumDetailsOpen} {:else} {/if}

Returns detailed information about a specific prediction market question including recent bets and probability history.

Endpoint

Parameters

question_id - Question ID (e.g., 101)

Example Response

Rate Limiting

{#if rateLimitingOpen} {:else} {/if}
• Daily limit: {maxDailyRequests.toLocaleString()} requests per day
• Cost: 1 credit per API call
• Error response: 429 Too Many Requests when limit exceeded
• Reset: Daily limits reset every 24 hours

Error Responses

{#if errorResponsesOpen} {:else} {/if}

Common Error Codes

• 400 - Bad Request (invalid parameters)
• 401 - Unauthorized (invalid or missing API key)
• 404 - Not Found (coin/question doesn't exist)
• 429 - Too Many Requests (rate limit exceeded)
• 500 - Internal Server Error
 {/if}