Opti-X Sports Inventory REST API
Opti-X uses inventory data to provide valuable recommendations to your users. The Opti-X Sports Inventory API ensures that Opti-X is always using the most up-to-date inventory information for your Brand.
Get Started
To get started you will need access to the API Keys in the Developer Tools at Opti-X opti-x.optimove.net from there you can get the x-brand-key and the Service x-api-key to access this API.
Records
Opti-X inventory consists of Sporting Events that describe Markets that bets can be placed on with users making specific Selections as part of their betslip. Events are categorised by their Sports Category, Class and Type.
Category
Represents the top-level Sports Category in the inventory. Some examples of this are Football, Tennis, or Golf
Class
Represents a subclass of this Sports Category. This is often used to group by country. If Class is not important to your Brand, then it can duplicate the information from the Category as a 1:1 relationship
Type
The type of Sporting Event. For example, the championship or league that the Events are part of.
Event
This is the Sporting Event that will occur on a specific date. This might be a match between two teams, or a race between many participants.
Market
The outcome that a bet can be placed on. For example the overall winner, or the first scorer.
Selection
The option from the Market that the user is betting on occurring. For example, the winning team, or the player.
Methods
The API allows create (POST), update (PUT), and delete (DELETE) actions on the records. Each method accepts up to 500 separate records rather than making individual calls for every data point. However it is important that they are ordered correctly (The Event will need to appear in the request ahead of any Market that references it).
Responses
The API will statically validate the request to ensure that it is valid, returning a success: true response if all records accepted. It will return an error message explaining the data issue if the validation fails, please refer to this documentation to identify the cause of the error. The API may also return success: false if not all records were recorded successfully, this can happen if there is a sudden spike in requests, and the client should back-off and try all the records again at a lower rate for some time.