swagger: '2.0' info: description: 'This is Genius Sports Services Fixture API.

Changelog resume

Authentication

You need to provide two tokens in every API call. The access_token for Auth0 client AND your API key

What is new in Fixtures API v2.

Fixture Tree Structure

Examples

I am interested in round 2 fixtures for the English Premier League


I am interested in Arsenal and their players

' version: 2.0.280 title: Fixtures-v2 Competitions competitors/players 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: competitors/players description: Groups the operations related to competitors of type Player paths: /competitors/players: get: tags: - competitors/players summary: Retrieve competitors (players) by ID/s. MAX 200 per page. description: Returns competitors (players) 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, sportId, genderType, localityId, venueId, competitorStatusType)' 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, sportId, genderType, localityId, venueId, competitorStatusType)' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/PlayerCompetitorResponseModelHATEOASReponseModel' 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: - competitors/players summary: Create new player 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: CreatePlayerCompetitor required: true schema: $ref: '#/definitions/CreatePlayerCompetitor' responses: '520': description: Unknown error schema: $ref: '#/definitions/ErrorModel' '201': description: Created schema: $ref: '#/definitions/PlayerCompetitorResponseModel' 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: [] put: tags: - competitors/players summary: Update existing player 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: UpdatePlayerCompetitor required: true schema: $ref: '#/definitions/UpdatePlayerCompetitor' responses: '200': description: Success schema: $ref: '#/definitions/PlayerCompetitorResponseModel' '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: [] /competitors/players/{id}: get: tags: - competitors/players summary: Retrieve competitors (players) details by ID. description: Returns competitors (players) 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 competitors (players) ID to return details for required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/PlayerCompetitorResponseModel' 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: [] /competitors/players/{id}/rounds: get: tags: - competitors/players summary: Retrieve rounds in which the Player will take part by Team ID/s. MAX 200 per page. description: Returns the rounds in which the player will take part by GSS Player 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 competitors (players) ID to return details for required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CompetitorRoundsResponseModelHATEOASReponseModel' 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: [] /competitors/players/{id}/seasons: get: tags: - competitors/players summary: Retrieve seasons in which the Player will take part by Team ID/s. MAX 200 per page. description: Returns the seasons in which the player will take part by GSS Player 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 competitors (players) ID to return details for required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/CompetitorSeasonsResponseModelHATEOASReponseModel' 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: [] definitions: Error: type: object required: - domain - message - reason properties: reason: type: string domain: type: string locationType: type: string location: type: string message: type: string CreatePersonViewModel: type: object required: - firstName - genderType - lastName - localityId - useNickname properties: firstName: type: string description: The first name of the person title: First Name maxLength: 256 lastName: type: string description: The last name of the person title: Last Name maxLength: 256 nickName: type: string description: The nickname of the person title: Nickname maxLength: 128 useNickname: type: boolean description: Whether the nickname should be used instead of the name of the person when displaying the person. If the useNickname property is set to true nickname is required! title: Is active localityId: type: integer format: int64 description: Id of the country,virtual place, etc. of the person! title: Locality Id dateOfBirth: type: string format: date-time description: The date of birth of the person title: Date of birth genderType: $ref: '#/definitions/PersonGenderType' sports: type: array description: Array of sport Ids to be added to the person. title: Sports items: type: integer description: Sports to which the person belongs to. title: Sports CompetitorStatusType: type: integer title: Competitor Status Type format: int32 description: 'This property defines the possible status types which can be set as integer values. Each integer value is associated with relevant status type as follows: 0 - Active; 1 - Retired; 2 - Unattached.' enum: - '0' - '1' - '2' CompetitorRoundsResponseModel: type: object required: - genderType - id - name - ref properties: id: type: integer format: int64 description: Id of the round name: type: string description: Name of the round ref: type: string description: Endpoint to round genderType: type: string description: Gender of the competitor locality: $ref: '#/definitions/HALEmbededResponse' PlayerCompetitorResponseModelHATEOASReponseModel: type: object properties: page: type: integer format: int32 pageSize: type: integer format: int32 totalItems: type: integer format: int64 items: type: array items: $ref: '#/definitions/PlayerCompetitorResponseModel' self: type: string previous: type: string next: type: string first: type: string last: type: string BadRequestModel: type: object properties: messages: type: array items: type: string UpdatePlayerCompetitor: type: object required: - competitorStatusType - id properties: metadataProperties: type: array items: $ref: '#/definitions/JsonbModelViewModel' id: type: integer format: int64 minimum: 1.0 competitorStatusType: $ref: '#/definitions/CompetitorStatusType' 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' CompetitorSeasonsResponseModelHATEOASReponseModel: type: object properties: page: type: integer format: int32 pageSize: type: integer format: int32 totalItems: type: integer format: int64 items: type: array items: $ref: '#/definitions/CompetitorSeasonsResponseModel' self: type: string previous: type: string next: type: string first: type: string last: type: string PersonGenderType: type: integer title: Gender Type format: int32 description: 'This property defines the possible person gender types which can be set as integer values. Each integer value is associated with relevant gender type as follows: 0 - Undefined; 1 - Male; 2 - Female;' enum: - '0' - '1' - '2' AcceptedModel: type: object properties: messages: type: array items: type: string CompetitorRoundsResponseModelHATEOASReponseModel: type: object properties: page: type: integer format: int32 pageSize: type: integer format: int32 totalItems: type: integer format: int64 items: type: array items: $ref: '#/definitions/CompetitorRoundsResponseModel' self: type: string previous: type: string next: type: string first: type: string last: type: string PersonForPlayerResponseModel: type: object required: - createdOn - firstName - fullName - genderType - id - isActive - lastName - locality - ref - updatesCount - useNickname properties: id: type: integer format: int64 createdOn: type: string format: date-time modifiedOn: type: string format: date-time updatesCount: type: integer format: int32 fullName: type: string nickName: type: string useNickname: type: boolean firstName: type: string lastName: type: string genderType: type: string dateOfBirth: type: string format: date-time isActive: type: boolean locality: $ref: '#/definitions/HALEmbededResponse' sports: type: array items: $ref: '#/definitions/HALEmbededResponse' ref: 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 CompetitorSeasonsResponseModel: type: object required: - id - name - ref properties: id: type: integer format: int64 description: Id of the season name: type: string description: Name of the season ref: type: string description: Endpoint to season 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. 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. PlayerCompetitorResponseModel: type: object required: - competitorStatusType - createdOn - id - name - person - sport - 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 items: $ref: '#/definitions/JsonbModel' externalIds: $ref: '#/definitions/ExternalIdsViewModel' name: type: string sport: $ref: '#/definitions/HALEmbededResponse' genderType: type: string locality: $ref: '#/definitions/HALEmbededResponse' competitorStatusType: type: string person: $ref: '#/definitions/PersonForPlayerResponseModel' isProtected: type: boolean description: Whether the competitor is protected or not. JsonbModel: type: object properties: name: type: string value: type: string isDeleted: type: boolean CreatePlayerCompetitor: type: object required: - sportId properties: metadataProperties: type: array items: $ref: '#/definitions/JsonbModelViewModel' personId: type: integer format: int64 description: If the person is already existing set its Id, otherwise leave it empty and populate the person object minimum: 1.0 sportId: type: integer format: int64 description: Id of the sport in which the competitor can be used minimum: 1.0 person: description: Person information if not been created early, if the person already exists - leave empty. $ref: '#/definitions/CreatePersonViewModel' 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