Welcome to the official documentation for integrating with the Basta auction platform.
Complete guide to setting up your Basta account and accessing the APIs.
- Create your user account
- Set up your business account
- Generate API keys
- Make your first API call
Overview of Basta's GraphQL APIs and their purposes.
- Management API for back-office operations
- Client API for user-facing interactions
- Authentication methods
Administrative API for managing auctions, inventory, and bidder tokens.
- Creating and managing auctions
- Item management
- Bidder token generation
- Code examples in TypeScript and Ruby
Public-facing API for auction browsing and bidding.
- Public queries (no auth required)
- Authenticated bidding
- User-scoped operations
- Code examples with popular frameworks
Real-time updates via WebSockets.
- WebSocket connection setup
- Authentication with bidder tokens
- saleActivity subscription
- Code examples for React, TypeScript, Ruby, Python
🪝 Webhooks
Complete type definitions and documentation for all webhook events.
- TypeScript type definitions with type guards
- RBS (Ruby type signatures) for static type checking
- All 18+ action types and payload structures
Step-by-step guides for common tasks.
📚 Glossary
Definitions and explanations of auction terms and concepts.
- Auction mechanics (StartingBid, Reserve, Bid Increment Table)
- Bid types (NORMAL, MAX, REACTIVE, OFFER)
- Timing concepts (ClosingMethod, ClosingTimeCountdown)
This documentation is designed for:
- Third-party integrators building on Basta platform
- Partners implementing webhook consumers
- Developers building applications that interact with Basta APIs
- Internal teams needing reference implementations
- New to Basta? Start with the Getting Started Guide
- Building an integration? Check out the First Auction Tutorial
- Receiving webhooks? See the Webhooks Documentation
- Need real-time updates? Explore GraphQL Subscriptions
For integration support and questions:
- Email: hi@basta.app
- Documentation: docs.basta.ai