A separate API from the main odds feed for checking resulting post event
openapi: 3.0.1
info:
title: Results API
description: This is a Results API Server
version: 1.0.0
servers:
- url: https://resultsapi.mustardsystems.com/v1
description: Mustard IMG Results API
- url: https://resultsapi-staging.mustardsystems.com/v1
description: Mustard IMG Staging Results API
tags:
- name: healthcheck
description: Check the service is running
- name: results data
description: Everything results related
paths:
/ping:
get:
tags:
- healthcheck
summary: Check if service is up
responses:
'200':
description: successful operation
content:
text/plain:
schema:
type: string
example: pong
/market/{market_id}:
get:
tags:
- results data
summary: Find market by ID
description: Returns results for a single market
parameters:
- name: market_id
in: path
description: ID of market to return
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Market'
/markets:
post:
tags:
- results data
summary: Find markets by IDs
requestBody:
description: List of market_ids to get results for.
content:
application/json:
schema:
$ref: '#/components/schemas/MarketIDsReq'
required: true
responses:
'200':
description: Returns results for multiple markets
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfMarkets'
x-codegen-request-body-name: body
/event/{event_id}:
get:
tags:
- results data
summary: Find score by event ID
description: Returns score field for a single event
parameters:
- name: event_id
in: path
description: ID of event to return score field
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
components:
schemas:
SelectionResult:
type: object
properties:
selection_id:
type: string
example: bar_selection_id
result:
type: object
properties: {}
Market:
type: object
properties:
market_id:
type: string
example: foo_market_id
results:
type: array
items:
$ref: '#/components/schemas/SelectionResult'
ArrayOfMarkets:
type: array
items:
$ref: '#/components/schemas/Market'
MarketIDsReq:
type: object
properties:
market_ids:
type: array
items:
type: string
Event:
type: object
properties:
event_id:
type: string
example: foo_event_id
score:
type: object
properties: {}
securitySchemes:
basicAuth:
type: http
scheme: basic
security:
- basicAuth: []
FAQ
Is there a concurrent connection limit?
There is no connection limit, but the service uses a pool of database connections and when those are exhausted there may be a delay until those connections are released.
Is there a limit on requests? Either rate limiting or number of markets per request?
Yes, requests are rate limited to ensure the availability of the service at times of high demand.
How long after a market or selection has been resulted in the odds feed will it be made available in the results API and how long will those results persist on the results API.
The results should be made available almost instantaneously as will be written to the database upon successful settlement.
We intend to remove the results after 2 weeks, although that functionality has not yet been implemented. If you feel that's too short, please let us know.
If results are made available in the results API and then a resettlement occurs on the odds feed how is that reflected in the results API?
The database will be updated upon resettlement.
Will results still be available in the odds feed?
Yes resulting will not change in the odds feed. This service is primarily for checking results post round/tournament.