swagger: '2.0'
info:
description: 'This is Genius Sports Services Fixture API.
Changelog resume
- 2.0.261 - Ability to filter by WELL-KNOWN external system identifiers e.g optaId, vesselId, fibaId, etc.
- 2.0.196 - Added the ability to retrieve deleted fixtures
- 2.0.193 - Expose outright fixtures with an extra query param (eventTypes) on GET and (eventType) on GetById for fixtures.
- 2.0.107 - Made fixtures round optional for POST and PUT.
Authentication
You need to provide two tokens in every API call. The access_token for Auth0 client AND your API key
- In order to get Auth0 client and API-KEY contact the SBOT team.
- Once you have the client you can make a request to Auth0 to get a token by:
curl --request POST --url https://{env or nothing for prod}.auth.geniussports.com/oauth/token --header ''content-type: application/json'' --data ''{''client_id'':''4Ew9c8DX58O1i0zsrTW9DlLSlDg9Rrt7'',''client_secret'':''client-secret'',''audience'':''https://api.geniussports.com'',''grant_type'':''client_credentials''}'' - Once you the get the response you would need to take the value from the ''access_token'' property. At this point you are ready to get started!
-
- Use the sports/10 call to retrieve Football (sport ID = 10)
curl https://{env or nothing for prod}fixtures.api.geniussports.com/v2/sports?filter=id[equals]:10 -H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ACCESS_TOKEN''
What is new in Fixtures API v2.
- Consistent pagination with up to 200 items per page
- Consistent response using HATEOAS model wrapper (when listing items)
- Sorting by specific field(s) (see each endpoint details for fore info, about which fields you can sort by)
- in order to sort just pass ''sortBy'' query param, example: sortBy=id
- then by sorting, example: sortBy=id,name
- sort by descending: example: sortBy=id:desc,name
- Powerful filter by specific field (see each endpoint details for fore info, about which fields you can filter by)
- in order to filter just pass ''filter'' query param, example: filter=id[equals]:1
- multiple IDs filtering, example: filter=id[in]:1,2,3
- Filter stacking (separate them with ~), example: filter=id[in]:1,2,3~sportId[in]:1,2,3,4,5
- different filter comparators: equals, in, gte, lte, contains, startsWith, notequals, nin:
- filter=id[equals]:1 - Equals comparator works with all data type
- filter=id[notequals]:1 - Not Equals comparator works with all data type
- filter=id[in]:1,2,3 - In comparator works only with integer and decimal values
- filter=id[nin]:1,2,3 - NIN comparator works only with integer and decimal values
- filter=startDate[gte]:2021-07-28~startDate[lte]:2021-07-29 - duplications of filter property allowed only in this ''range'' case
- filter=name[contains]:test
- filter=name[startsWith]:test
- filter=cityName[equals]:null
- filter=cityName[notequals]:null
- Filter by external id. Filter works only the Fixtures system has external provider and have explicitly allowed persisting external ids fir tat source. example: filter=externalIds.optaId[equals]:12345
- Imporoved and consistent structure of the API endpoints
- Each endpoint (which needs) from the hierarchy has exactly 2 endpoints:
- One for listing multiple items - the filtering sorting are implemented by query params
- One for single item by id
- No deleted fixtures by default
- Does not use SpoCoSy database (Party), but the Proposal API database (therefore there is Eventual consistency, and not everything is available right away)
Fixture Tree Structure
- organisations
- venue
- locality
- sports
- competitions
- seasons
- rounds (competitionPhase)
- fixture
- fixturecompetitors
- competitor (team, player, doubles, horse, etc)
Examples
I am interested in round 2 fixtures for the English Premier League
- Use sports call to retrieve the relevant sport ID - in this case ID 10 for Football
curl https://ci.fixtures.api.geniussports.com/v2/sports -H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Use competitions call to see competitions for your sport - in this case ID 36 for ''England Premier League''
curl https://ci.fixtures.api.geniussports.com/v2/competitions?filter=sportId[equals]:10~name[contains]:Premier -H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Use seasons call to see seasons for your competition - in this case you will see the 2017/2018 season as ID 64525
curl https://ci.fixtures.api.geniussports.com/v2/seasons?filter=competitionId[equals]:36 -H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Use rounds call to see rounds for your season - Find Round 2 with ID 338088
curl https://ci.fixtures.api.geniussports.com/v2/rounds?filter=seasonId[equals]:64525 -H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Use fixtures call to get all fixtures we have for Round 2
curl https://ci.fixtures.api.geniussports.com/v2/fixtures?filter=roundId[equals]:338088 -H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN''
I am interested in Arsenal and their players
- You can re-use the 2017/2018 EPL season ID from the example above, ID 64525 to get Season Details
curl https://ci.fixtures.api.geniussports.com/v2/seasons/64525 - ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Find Arsenal in the response with competitor ID 10025 and use this ID to get all Arsenal contracts
curl https://ci.fixtures.api.geniussports.com/v2/competitors/teams/10025 -H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN''
'
version: 2.0.280
title: Fixtures-v2 Competitions Rounds API
contact:
email: sbonboarding@geniussports.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
host: fixtures.api.geniussports.com
basePath: /v2
schemes:
- https
tags:
- name: Rounds
paths:
/rounds:
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
tags:
- Rounds
get:
tags:
- Rounds
summary: Retrieve rounds by ID/s. MAX 200 per page.
description: Returns rounds wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, seasonId, competitionId, sportId, type)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, seasonId, competitionId, sportId, type)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RoundResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- Rounds
summary: Create new round
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateRound
required: true
schema:
$ref: '#/definitions/CreateRound'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/RoundResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- Rounds
summary: Update existing round
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateRound
required: true
schema:
$ref: '#/definitions/UpdateRound'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RoundResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
patch:
tags:
- Rounds
summary: Patch existing round
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: PatchRound
required: true
schema:
$ref: '#/definitions/PatchRound'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RoundResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
/rounds/{id}:
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
tags:
- Rounds
get:
tags:
- Rounds
summary: Retrieve rounds details by ID.
description: Returns rounds details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single rounds ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RoundResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- Rounds
summary: Delete existing round
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/rounds/{id}/competitors:
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
tags:
- Rounds
get:
tags:
- Rounds
summary: Retrieve round competitors by Round ID/s. MAX 200 per page.
description: Returns the competitors which will take part in the round related to the GSS Round Id in the path, wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single rounds ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RoundCompetitorsResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- Rounds
summary: Adds new competitor to the round
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
- in: body
name: CreateRoundCompetitor
required: true
schema:
$ref: '#/definitions/CreateRoundCompetitor'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/RoundResponseModel'
headers:
gs-duplicate-entity-replaced:
type: string
description: Returned when a duplicate entity has been replaced. Value is the 'duplicateEntityId' and the 'originalEntityId'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
/groups/{id}:
delete:
tags:
- Rounds
summary: Delete existing round
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/rounds/{id}/competitors/{competitorId}:
delete:
tags:
- Rounds
summary: Removes competitor added to round
produces:
- application/json
parameters:
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: competitorId
in: path
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
definitions:
UpdateRound:
type: object
required:
- competitors
- enddate
- id
- name
- seasonId
- startdate
- type
properties:
id:
type: integer
format: int64
description: The ID of the round.
title: Round Id
name:
type: string
description: Name of the round.
title: Round name
competitors:
type: array
description: Array of competitors to be added to the round. Competitors are mandatory for rounds of type `Phase` and `Aggregate`. Rounds of type `Round` cannot have competitors
title: Competitors
items:
type: integer
description: Competitors which are associated with the round.
title: Competitors
startdate:
type: string
format: date-time
description: The start date of the round in UTC ISO-8601 format
title: 'Start Date '
enddate:
type: string
format: date-time
description: The end date of the fixture in UTC ISO-8601 format
title: End Date
type:
type: string
description: "The type of round. 0 = Phase \n1 = Round \n2 = AggregateEvent"
title: Type
seasonId:
type: integer
format: int64
description: The ID of the season the round belongs to.
title: Season Id
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/round/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
timezone:
type: string
description: 'The timezone which will be set as default timezone for the competition''s fixtures if timezone is not specified. Possible timezones (splited by '',''): Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anguilla,America/Antigua,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Aruba,America/Asuncion,America/Bahia,America/Barbados,America/Belem,America/Belize,America/Bogota,America/Boise,America/Buenos_Aires,America/Campo_Grande,America/Cancun,America/Caracas,America/Chicago,America/Chihuahua,America/Costa_Rica,America/Cuiaba,America/Curacao,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/El_Salvador,America/Fortaleza,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Petersburg,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indianapolis,America/Jamaica,America/Kentucky/Louisville,America/Kentucky/Monticello,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Managua,America/Manaus,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Mexico_City,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Nassau,America/New_York,America/Panama,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Porto_Velho,America/Port_of_Spain,America/Puerto_Rico,America/Recife,America/Rio_Branco,America/Rosario,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/Tegucigalpa,America/Tijuana,America/Toronto,America/Vancouver,America/Whitehorse,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dubai,Asia/Dushanbe,Asia/Gaza,Asia/Harbin,Asia/Hong_Kong,Asia/Hovd,Asia/Ho_Chi_Minh,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Katmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pyongyang,Asia/Qatar,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimphu,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Madeira,Atlantic/Reykjavik,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Hobart,Australia/Melbourne,Australia/North,Australia/NSW,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,CET,Chile/Continental,CST6CDT,Cuba,EET,Egypt,EST,Etc/GMT,Etc/GMT+1,Etc/GMT+12,Etc/GMT+2,Etc/GMT+3,Etc/GMT+4,Etc/GMT+5,Etc/GMT+6,Etc/GMT+7,Etc/GMT+8,Etc/GMT+9,Etc/GMT-0,Etc/GMT-1,Etc/GMT-2,Etc/GMT-3,Etc/GMT-4,Etc/GMT-5,Etc/GMT-7,Etc/GMT-8,Etc/Greenwich,Etc/UTC,Europe/Amsterdam,Europe/Andorra,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Kaliningrad,Europe/Kiev,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,GB,GB-Eire,GMT,GMT0,Hongkong,Iceland,Indian/Cocos,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Reunion,Iran,Israel,Jamaica,Japan,Libya,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,MST,MST7MDT,NZ,Pacific/Apia,Pacific/Auckland,Pacific/Easter,Pacific/Fiji,Pacific/Guadalcanal,Pacific/Kosrae,Pacific/Noumea,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Tahiti,Poland,Portugal,Singapore,Turkey,UCT,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,UTC,WET'
title: Round timezone
title: Update Round Model
description: This model should be used to update a round object.
AcceptedModel:
type: object
properties:
messages:
type: array
items:
type: string
BadRequestModel:
type: object
properties:
messages:
type: array
items:
type: string
Error:
type: object
required:
- domain
- message
- reason
properties:
reason:
type: string
domain:
type: string
locationType:
type: string
location:
type: string
message:
type: string
JsonbModelViewModel:
type: object
required:
- name
properties:
name:
type: string
description: Name of the property.
title: Property name
value:
type: string
description: Value of the property.
title: Property value
title: Create/Update Property Model
description: This model should be used to create or update single property value for specific property name for specific model.
RoundCompetitorsResponseModel:
type: object
required:
- competitorType
- genderType
- id
- locality
- name
- ref
properties:
id:
type: integer
format: int64
description: Id of the competitor
name:
type: string
description: Name of the competitor
competitorType:
type: string
description: Type of the competitor
ref:
type: string
description: Endpoint to competitor
genderType:
type: string
description: Gender of the competitor
locality:
$ref: '#/definitions/HALEmbededResponse'
ErrorDuplicateModel:
type: object
properties:
messages:
type: array
items:
type: string
geniusSportsConflictId:
type: string
description: This is the official genius sports ID, which you have conflict with.
RoundResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/RoundResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
JsonbModel:
type: object
properties:
name:
type: string
value:
type: string
isDeleted:
type: boolean
Empty:
type: object
CreateRound:
type: object
required:
- competitors
- enddate
- name
- seasonId
- startdate
- type
properties:
name:
type: string
description: Name of the round.
title: Round name
competitors:
type: array
description: Array of competitors to be added to the round. Competitors are mandatory for rounds of type `Phase` and `Aggregate`. Rounds of type `Round` cannot have competitors
title: Competitors
items:
type: integer
description: Competitors which are associated with the round.
title: Competitors
startdate:
type: string
format: date-time
description: The start date of the round in UTC ISO-8601 format
title: 'Start Date '
enddate:
type: string
format: date-time
description: The end date of the fixture in UTC ISO-8601 format
title: End Date
type:
type: string
description: "The type of round. 0 = Phase \n1 = Round \n2 = AggregateEvent"
title: Type
seasonId:
type: integer
format: int64
description: The ID of the season the round belongs to.
title: Season Id
parentRoundId:
type: integer
format: int64
description: The ID of the parent round to which posted round belongs.
title: Parent Round Id
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/round/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
timezone:
type: string
description: 'The timezone which will be set as default timezone for the competition''s fixtures if timezone is not specified. Possible timezones (splited by '',''): Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anguilla,America/Antigua,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Aruba,America/Asuncion,America/Bahia,America/Barbados,America/Belem,America/Belize,America/Bogota,America/Boise,America/Buenos_Aires,America/Campo_Grande,America/Cancun,America/Caracas,America/Chicago,America/Chihuahua,America/Costa_Rica,America/Cuiaba,America/Curacao,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/El_Salvador,America/Fortaleza,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Petersburg,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indianapolis,America/Jamaica,America/Kentucky/Louisville,America/Kentucky/Monticello,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Managua,America/Manaus,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Mexico_City,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Nassau,America/New_York,America/Panama,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Porto_Velho,America/Port_of_Spain,America/Puerto_Rico,America/Recife,America/Rio_Branco,America/Rosario,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/Tegucigalpa,America/Tijuana,America/Toronto,America/Vancouver,America/Whitehorse,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dubai,Asia/Dushanbe,Asia/Gaza,Asia/Harbin,Asia/Hong_Kong,Asia/Hovd,Asia/Ho_Chi_Minh,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Katmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pyongyang,Asia/Qatar,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimphu,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Madeira,Atlantic/Reykjavik,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Hobart,Australia/Melbourne,Australia/North,Australia/NSW,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,CET,Chile/Continental,CST6CDT,Cuba,EET,Egypt,EST,Etc/GMT,Etc/GMT+1,Etc/GMT+12,Etc/GMT+2,Etc/GMT+3,Etc/GMT+4,Etc/GMT+5,Etc/GMT+6,Etc/GMT+7,Etc/GMT+8,Etc/GMT+9,Etc/GMT-0,Etc/GMT-1,Etc/GMT-2,Etc/GMT-3,Etc/GMT-4,Etc/GMT-5,Etc/GMT-7,Etc/GMT-8,Etc/Greenwich,Etc/UTC,Europe/Amsterdam,Europe/Andorra,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Kaliningrad,Europe/Kiev,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,GB,GB-Eire,GMT,GMT0,Hongkong,Iceland,Indian/Cocos,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Reunion,Iran,Israel,Jamaica,Japan,Libya,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,MST,MST7MDT,NZ,Pacific/Apia,Pacific/Auckland,Pacific/Easter,Pacific/Fiji,Pacific/Guadalcanal,Pacific/Kosrae,Pacific/Noumea,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Tahiti,Poland,Portugal,Singapore,Turkey,UCT,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,UTC,WET'
title: Round timezone
title: Create Round Model
description: This model should be used to create a round object.
CreateRoundCompetitor:
type: object
properties:
competitorId:
type: integer
format: int64
description: The id of the competitor which will be added in the round
title: Competitor Id
ExternalIdsViewModel:
type: object
properties:
optaId:
type: string
optaLegacyId:
type: string
fibaId:
type: string
vesselId:
type: string
statsEngineId:
type: string
description: External system identifiers. Key represents the external system name (e.g., 'optaId', 'optaLegacyId', 'fibaId', 'vesselId','statsEngineId'), value represents the identifier. The property also allows filtering by specific external system identifiers. For example '?filter=externalIds.optaId[equals]:12345' to filter entities with a specific Opta ID.
ErrorModel:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
error:
$ref: '#/definitions/Error'
RoundResponseModel:
type: object
required:
- competition
- createdOn
- endDate
- id
- name
- season
- sport
- startDate
- type
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/round/metadata
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
type:
type: string
description: Phase, Round, AggregateEvent
season:
$ref: '#/definitions/HALEmbededResponse'
sport:
$ref: '#/definitions/HALEmbededResponse'
competition:
$ref: '#/definitions/HALEmbededResponse'
parentRound:
$ref: '#/definitions/HALEmbededResponse'
timezone:
$ref: '#/definitions/HALEmbededResponse'
RoundCompetitorsResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/RoundCompetitorsResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
HALEmbededResponse:
type: object
required:
- id
- name
- ref
properties:
id:
type: integer
format: int64
name:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
ref:
type: string
PatchRound:
type: object
required:
- id
properties:
id:
type: integer
format: int64
description: The ID of the round.
title: Id
startDate:
type: string
format: date-time
description: The start date of the round in UTC ISO-8601 format
title: Start Date
endDate:
type: string
format: date-time
description: The end date of the round in UTC ISO-8601 format
title: End Date
title: Patch Round Model
description: This model should be used to propose a partial update/patch to a round.
securityDefinitions:
Auth0:
type: apiKey
name: Authorization
in: header
x-amazon-apigateway-authtype: oauth2
api_key:
type: apiKey
name: x-api-key
in: header
x-amazon-apigateway-security-policy: TLS_1_0