API Documentation
v1.0 • REST API
Integrate Jumpwait into your applications with our REST API. Create waitlists, manage entries, and enable position trading programmatically.
Getting Started
The Jumpwait API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.
https://api.jumpwait.com/v1🚧 API Status: The public API is currently in beta. Some endpoints may change before the stable release. Contact us at api@jumpwait.com for early access.
Authentication
Authenticate API requests using Bearer tokens. You can generate API keys from your dashboard settings.
Endpoints
/api/v1/waitlistsList all public waitlists
/api/v1/waitlists/:idGet a specific waitlist by ID
/api/v1/waitlists/:id/joinJoin a waitlist
/api/v1/waitlists/:id/entriesList entries in a waitlist
/api/v1/entries/:idGet details of a specific entry
/api/v1/entries/:id/listList your position for sale
/api/v1/entries/:id/listRemove your position from sale
/api/v1/bidsList bids on your positions
/api/v1/bidsPlace a bid on a position
/api/v1/bids/:id/acceptAccept a bid on your position
Webhooks
Receive real-time notifications when events happen in your waitlists. Configure webhook endpoints in your business dashboard.
Available Events
entry.created- New signup on your waitlistentry.listed- Position listed for salebid.placed- New bid on a positiontrade.completed- Position successfully traded
Rate Limits
API requests are rate limited to ensure fair usage.
Error Handling
The API uses conventional HTTP response codes to indicate success or failure.
200Success400Bad Request - Invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - Insufficient permissions404Not Found - Resource doesn't exist429Rate Limited - Too many requests500Server Error - Something went wrongReady to integrate?
Request API access to start building with Jumpwait.
Request API Access