Overview

Getting Started

The Blitz Rocket API is a RESTful API that uses standard HTTP methods and returns JSON responses. All endpoints are accessible via https://blitzrocket.com/api/v1.

Prerequisites

Before making API calls, you'll need:

1. A Blitz Rocket account — Sign up at blitzrocket.com if you haven't already
2. A team — Create or join a team in your Blitz Rocket dashboard
3. An API key — Generate one from your team settings page

API Key Types

Blitz Rocket offers two types of API keys:

Making Requests

All requests must include your API key. You can pass it as a header or query parameter:

curl -X GET https://blitzrocket.com/api/v1/contests \
  -H "x-api-key: your_api_key_here"

curl -X GET "https://blitzrocket.com/api/v1/contests?apiKey=your_api_key_here"

CORS Support

All API v1 endpoints support Cross-Origin Resource Sharing (CORS), allowing you to make requests from browser-based applications. The following headers are set on all responses:

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, x-api-key

Content Type

For POST and PUT requests, send your request body as JSON with the Content-Type: application/json header.

Pagination

Endpoints that return lists support pagination with the following query parameters:

Paginated responses include a pagination object:

{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}