<aside>
Version: v4
Format: RESTful API (OpenAPI 3.0)
Authentication: Cookie
Environments: Sandbox & Production
</aside>
Developer notes
- All endpoints are served via HTTPS.
- Payloads are JSON-based with structured request and response schemas.
- Extensive query filtering (e.g. pagination, states, category filters) is available.
Core API domains are outlined below.
1. Auctions & Lot Management
iRostrum’s API provides robust controls for creating, managing, and retrieving auctions and their associated lots.
Auction Features:
- Create and edit auctions (Timed, Live)
- Upload auction imagery and supporting documents
- Configure contacts, viewings, notices, and footers
- Publish/unpublish auctions
- Access financial summaries and bidder analytics
Lot Management:
- Create, delete, and import lots (individually or in bulk)
- Set bidding rules, descriptions, catalogue data, and images
- Withdraw or sell lots (direct sale or auction-based)