- Blitz Rocket API DocumentationGetting StartedAPI ReferenceWebhooksReferral Tracking
API Reference
Complete reference for all Blitz Rocket REST API v1 endpoints
On this page
API Reference
The Blitz Rocket REST API v1 provides endpoints for managing contests, entries, bonus actions, purchases, and more. All endpoints are prefixed with /api/v1.
Endpoint Overview
| Resource | Endpoint | Methods | Auth |
|---|---|---|---|
| Contests | /api/v1/contests | GET | Public |
| Contest Detail | /api/v1/contests/:contestId | GET | Public |
| Entries | /api/v1/contests/:contestId/entries | GET, POST | Public / Private |
| Entry Detail | /api/v1/entries/:entryId | GET, PUT | Public / Private |
| Disqualify | /api/v1/entries/:entryId/disqualify | POST | Private |
| Points | /api/v1/entries/:entryId/points | POST | Private |
| Bonus Actions | /api/v1/entries/:entryId/bonus-actions | GET | Public |
| Complete Action | /api/v1/entries/:entryId/bonus-actions/:id/complete | POST | Public |
| Purchases | /api/v1/contests/:contestId/purchases | POST | Private |
| Leaderboard | /api/v1/contests/:contestId/leaderboard | GET | Public |
| Analytics | /api/v1/contests/:contestId/analytics | GET | Public |
Authentication
All endpoints require an API key passed via the x-api-key header or apiKey query parameter. See Authentication for details.
Key Type Permissions
- Public key — Can access all
GETendpoints and bonus action completion - Private key — Can access all endpoints including
POSTandPUToperations