Appearance
Welcome & data model
Welcome! This is the documentation of the XS2Event REST API. The API is described in the OpenAPI format; a detailed description of all entities and endpoints can be found in the OpenAPI specification.
In addition to our API, we support integrations through the industry-standard platforms Rezdy and Octo.
New here? Head to the Quickstart to make your first call in under a minute.
Resources
Our model consists of the following layered entities. These entities are available as HTTP resources.
Catalogue
- Tournament: a season-bound, time-ordered sequence of events for a given sport type, season and tournament type.
- Venue: a fixed location (by GPS) in which a sports event can be held.
- Team: events with teams, such as football, always have two teams linked.
- Event: the actual sports event at a specific venue on a specific date (or several days). Optionally involving two teams.
- Category: a specific section of a venue. Tickets are always part of ONE category.
- Ticket: the entrance voucher for a single event, which you buy from us.
Ordering
- Reservation: a temporary ticket allocation (optional, but recommended).
- Booking: the ticket purchase. See the booking flow.
Entity relation diagram
Tournament
A tournament is specified according to:
- Season: 24/25 or 2025
- SportType: Soccer, Motorsport, Tennis, Boxing
- Tournament type: CUP or LEAGUE
- Name
- Region (country or global, e.g., F1)
Our tournaments are seasonal. For example, for the "Premier League" there will also be historical tournaments.
How events are offered
An event can be played as part of a competition or cup. In the case of a competition, the teams, venue, and date are known upfront. In the case of a cup, only the dates are known, and in some situations, the location of the final or semi-finals.
In our system, the minimum required data to offer an event is:
- date
- location (venue)
- tournament
Please note that the date may change and is usually fixed 14 days prior to the start of the event.
Examples
- Manchester United vs Arsenal in the Premier League on date xyz. (Soccer, League)
- TT Assen 2025 in the MotoGP on date xyz (Motorsport, League)
- FA Cup Final at Wembley on date xyz (Soccer, Cup)
Next steps
- Authentication & access: get an API key and call the API
- Find events & tickets: fetch the catalogue step by step
- Rate limits & caching: how often to refresh each resource