v1
latestOpenAPI 3.1.02026-07-13143194365.4 KBList giveaways
List giveaways with optional filtering.
Authenticated filters (require Bearer token):
- my_giveaways=true: Giveaways created by the authenticated account
- my_entries=true: Giveaways the authenticated account has entered
Public filters (can combine with any filter):
- exclude_planned=true: Exclude giveaways that haven't started yet
- status: Filter by giveaway status
- include_stats=true: Embed per-giveaway stats on each item. Use this to avoid N+1 calls to GET /v1/giveaway/{id} just to populate stats.
Query parameters
Filter to giveaways created by authenticated account
Filter to giveaways created by authenticated account
Filter to giveaways the authenticated account has entered
Filter to giveaways the authenticated account has entered
Exclude giveaways that haven't started yet (start_at > now)
Exclude giveaways that haven't started yet (start_at > now)
Status states for giveaways.
State machine:
- active: Giveaway is accepting entries (tips within window)
- ended: Giveaway window has passed, ready for drawing
- drawn: Winners have been selected
- cancelled: Giveaway was cancelled before drawing
Filter by status
When true, each returned item populates its stats field (total_entries, unique_participants, total_tips_usd) using a single batched query. Frontends should prefer this over looping GET /v1/giveaway/{id} for each item.
When true, each returned item populates its stats field (total_entries, unique_participants, total_tips_usd) using a single batched query. Frontends should prefer this over looping GET /v1/giveaway/{id} for each item.
Max results
Max results
Pagination offset
Pagination offset
Headers
Bearer <account_jwt>
Bearer <account_jwt>
Response
Successful Response