API Reference

REST API

Integrate TokenKickstarter data into your applications using our REST API. Access presales, tokens, locks, and user data programmatically.

Base URL

https://api.tokenkickstarter.io/v1

Authentication

API Key

Include your API key in the X-API-Key header for authenticated requests.

X-API-Key: your_api_key_here

JWT Token

For user-specific operations, use a JWT token obtained through SIWE authentication.

Authorization: Bearer eyJhbGc...

Endpoints

GET/api/presales

Get all presales with optional filters

statuschainpagelimit
GET/api/presales/:id

Get details of a specific presale

id (required)
GET/api/tokens

Get all tokens created on the platform

chaincreatorpagelimit
GET/api/locks

Get all liquidity locks

tokenownerpagelimit
GET/api/user/:address

Get user profile and activity

address (required)

Response Format

All responses are returned in JSON format with a consistent structure:

{
  "success": true,
  "data": {
    "id": "abc123",
    "name": "Example Token",
    "symbol": "EXT",
    "status": "live",
    "raised": "125000000000000000000",
    "softCap": "100000000000000000000",
    "hardCap": "500000000000000000000",
    "startTime": 1704067200,
    "endTime": 1704672000
  },
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 1
  }
}

Error Codes

400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
404Not Found - Resource doesn't exist
429Too Many Requests - Rate limit exceeded
500Server Error - Something went wrong

Rate Limiting

API requests are rate-limited to ensure fair usage. See our rate limits documentation for details on limits and how to handle 429 responses.

Continue Learning

Explore Web3 integration or learn about webhooks for real-time updates.