Fixtures-v1 API Reference

This is Genius Sports Services Fixture API.

Changelog

1.1.38 - Add extraInningsRunnerOnSecondBase property to Competition, Season, Round and Fixture models
1.1.37 - Update fixture model to set CompetitionId to string (the returned model property type is string so this change brings the swagger in line)
1.1.36 - Update documentation to have new team email address
1.1.35 - add sport ID to competitor object, add active to contracts object, add isProtected to player properties in the competitor object
1.1.34 - add numberOfInnings and numberOfExtraInnings in Round, Fixture and Competition objects
1.1.33 - update kinesis streams, add extraTimeHalfDuration for Round
1.1.32 - add penaltyShootouts property in Round, Fixture and Competition objects, correct docs for deleted attribute, add regularHalfDuration in Rounds
1.1.31 - add FirstLegId and SecondLegId properties in Fixture objects
1.1.30 - add federation property in Round, Fixture, Competition objects
1.1.29 - add finalSetTieBreakStarts and finalSetTieBreakWinnerFirst properties in Round, Fixture, Competition objects
1.1.28 - modify description of /contracts/{competitorIds} call
1.1.26 - add onlyFixtures parameter to the /h2h/{competitorIds}/fixtures and /competitors/{competitorIds}/fixtures calls
1.1.25 - increase the ID limit for the /contracts/{competitorIds} call
1.1.24 - add HAL structured links for paging on sports/{competitionIds}/fixtures and /competitions/{competitionIds}/fixtures calls
1.1.23 - removing fixture properties regionId and location, removing a competitor parameter parentCompetitor and adding the property weight under fixture competitor
1.1.22 - adding rotation codes properties
1.1.21 - adding todatetime to cacheKeyParameters
1.1.20 - adding new properties
1.1.19 - adding a new param in the H2H calls, adding the missing competitor types
1.1.14 - correcting docs for path parameters

API Calls

You need to provide 2 information in every API call. The IdToken for your Cognito user AND your API key

Use the sports/10 call to retrieve Football (sport ID = 10)
- curl https://api.geniussports.com/Fixtures-v1/STAGE/sports/10 -H 'Content-Type: application/json' -H 'x-api-key: YOUR_API_KEY' -H 'Authorization: YOUR_ID_TOKEN'

Get Cognito Token

See the Auth API for details

Fixture Tree Structure

sports (sportproperty)

competitions (competitionproperty)

seasons (seasonproperty)

rounds (roundproperty)

fixtures (fixtureproperty) (venue)

fixturecompetitors (fixturecompetitorproperty)

competitor (teamproperty OR playerproperty)

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://api.geniussports.com/Fixtures-v1/STAGE/sports -H 'Content-Type: application/json' -H 'x-api-key: YOUR_API_KEY' -H 'Authorization: YOUR_ID_TOKEN'
Use competitions call to see competitions for your sport - in this case ID 36 for 'England Premier League'
curl https://api.geniussports.com/Fixtures-v1/STAGE/sports/10/competitions -H 'Content-Type: application/json' -H 'x-api-key: YOUR_API_KEY' -H 'Authorization: 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://api.geniussports.com/Fixtures-v1/STAGE/competitions/36/seasons -H 'Content-Type: application/json' -H 'x-api-key: YOUR_API_KEY' -H 'Authorization: YOUR_ID_TOKEN'
Use rounds call to see rounds for your season - Find Round 2 with ID 338088
curl https://api.geniussports.com/Fixtures-v1/STAGE/seasons/64525/rounds -H 'Content-Type: application/json' -H 'x-api-key: YOUR_API_KEY' -H 'Authorization: YOUR_ID_TOKEN'
Use fixtures call to get all fixtures we have for Round 2
curl https://api.geniussports.com/Fixtures-v1/STAGE/rounds/338088/fixtures -H 'Content-Type: application/json' -H 'x-api-key: YOUR_API_KEY' -H 'Authorization: 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
curl https://api.geniussports.com/Fixtures-v1/STAGE/seasoncompetitors/64525 - 'Content-Type: application/json' -H 'x-api-key: YOUR_API_KEY' -H 'Authorization: YOUR_ID_TOKEN'
Find Arsenal in the response with competitor ID 10025 and use this ID to get all Arsenal contracts
curl https://api.geniussports.com/Fixtures-v1/STAGE/contracts/10025 -H 'Content-Type: application/json' -H 'x-api-key: YOUR_API_KEY' -H 'Authorization: YOUR_ID_TOKEN'

API Endpoint

https://api.geniussports.com/Fixtures-v1/PRODPRM

Contact: OTF@geniussports.com

Schemes: https

Version: 1.1.38

Authentication

CognitoPool

type

apiKey

name

Authorization

header

x-amazon-apigateway-authtype

cognito_user_pools

api_key

type

apiKey

name

x-api-key

header

regions

Region details

regions

Retrieve all regions

GET /regions

Returns regions

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

200 OK

Regions

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Region not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "regions": [
      {
        "deleted": "boolean",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "typeName": "string",
        "id": "integer (int64)",
        "updates": "integer (int64)"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

regions

Retrieve region/s by ID/s

GET /regions/{regionIds}

Returns region/s

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

regionIds: string

in path

Comma separated list of IDs of region/s to return

200 OK

Regions

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Sport not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "regions": [
      {
        "deleted": "boolean",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "typeName": "string",
        "id": "integer (int64)",
        "updates": "integer (int64)"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

sports

Sport details

sports

Retrieve all sports

GET /sports

Returns all sports

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

200 OK

Sports

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Sport not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "sports": [
      {
        "deleted": "boolean",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "id": "integer (int64)",
        "sportproperty": {
          "needsUnitsOfPlay": "boolean",
          "recreateEventsThreshold": "integer (int32)"
        },
        "updates": "integer (int64)"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

sports

Retrieve sport by ID/s

GET /sports/{sportIds}

Returns sport/s

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

sportIds: string

in path

Comma separated list of IDs of sport/s to return

200 OK

Sports

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Sport not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "sports": [
      {
        "deleted": "boolean",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "id": "integer (int64)",
        "sportproperty": {
          "needsUnitsOfPlay": "boolean",
          "recreateEventsThreshold": "integer (int32)"
        },
        "updates": "integer (int64)"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

competitions

Competition details

competitions

Retrieve competition by ID/s. MAX 500 IDs at a time.

GET /competitions/{competitionIds}

Returns competition/s

competitionIds: string

in path

Comma separated list of IDs for competition/s to return

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

200 OK

Competitions

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Competition not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "competitions": [
      {
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "gender": "string",
        "competitionproperty": {
          "sets": "integer (int32)",
          "surface": "string",
          "finalSet": "string",
          "sponsorName": "string",
          "competitionType": "string",
          "association": "string",
          "isTour": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "handicapRace": "boolean",
          "defaultTimeZone": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "regionId": "integer (int64)",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "currency": "string",
          "location": "string",
          "extraTime": "string",
          "scoringSystem": "string",
          "shortName": "string",
          "awayGoalsAfterExtraTime": "string",
          "longName": "string",
          "varRule": "boolean",
          "usesTBDTeams": "boolean",
          "regularHalfDuration": "integer (int32)",
          "extraTimeHalfDuration": "integer (int32)",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "updates": "integer (int64)"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

competitions

Retrieve competition by sport ID/s

GET /sports/{sportIds}/competitions

Returns competition/s by sport/s

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

sportIds: string

in path

Comma separated list of IDs for competition/s to return

200 OK

Competitions

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Competition not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "competitions": [
      {
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "gender": "string",
        "competitionproperty": {
          "sets": "integer (int32)",
          "surface": "string",
          "finalSet": "string",
          "sponsorName": "string",
          "competitionType": "string",
          "association": "string",
          "isTour": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "handicapRace": "boolean",
          "defaultTimeZone": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "regionId": "integer (int64)",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "currency": "string",
          "location": "string",
          "extraTime": "string",
          "scoringSystem": "string",
          "shortName": "string",
          "awayGoalsAfterExtraTime": "string",
          "longName": "string",
          "varRule": "boolean",
          "usesTBDTeams": "boolean",
          "regularHalfDuration": "integer (int32)",
          "extraTimeHalfDuration": "integer (int32)",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "updates": "integer (int64)"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

seasons

Season details

seasons

Retrieve all seasons for given competition/s. MAX 500 IDs at a time.

GET /competitions/{competitionIds}/seasons

Returns all seasons for given competition/s. MAX 500 IDs at a time.

competitionIds: string

in path

Comma separated list of IDs for competition/s to return

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

200 OK

Seasons

successful operation

400 Bad Request

ErrorModel

Invalid URL

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "seasons": [
      {
        "competitionId": "integer (int64)",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "parentSeason": "integer (int64)",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonproperty": {
          "endDate": "string",
          "timezone": "string",
          "sponsorName": "string",
          "outrightDate": "string",
          "outrightIsStart": "boolean",
          "fullDescription": "string",
          "shortName": "string",
          "startDate": "string",
          "longName": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "locked": "string"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

seasons

Retrieve season by ID. MAX 500 IDs at a time.

GET /seasons/{seasonIds}

Returns season/s. MAX 500 IDs at a time.

seasonIds: string

in path

Comma separated list of IDs for season/s to return

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

200 OK

Seasons

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Season not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "seasons": [
      {
        "competitionId": "integer (int64)",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "parentSeason": "integer (int64)",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonproperty": {
          "endDate": "string",
          "timezone": "string",
          "sponsorName": "string",
          "outrightDate": "string",
          "outrightIsStart": "boolean",
          "fullDescription": "string",
          "shortName": "string",
          "startDate": "string",
          "longName": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "locked": "string"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

rounds

Round details

rounds

Retrieve round by ID. MAX 500 IDs at a time.

GET /rounds/{roundIds}

Returns round/s. MAX 500 IDs at a time.

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

roundIds: string

in path

Comma separated list of IDs for round/s to return. MAX 500 IDs at a time.

200 OK

Rounds

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Round not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "rounds": [
      {
        "id": "integer (int64)",
        "name": "string",
        "sportId": "integer (int64)",
        "sportName": "string",
        "competitionId": "integer (int64)",
        "competitionName": "string",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "parentRound": "integer (int64)",
        "startDate": "string",
        "endDate": "string",
        "type": "string",
        "roundproperty": {
          "sets": "integer (int32)",
          "surface": "string",
          "timezone": "string",
          "finalSet": "string",
          "association": "string",
          "awayGoalsAfterNormalTime": "string",
          "handicapRace": "boolean",
          "fixtureFormat": "string",
          "extraTimeHalfDuration": "integer (int32)",
          "roundNumber": "integer (int32)",
          "isProtected": "boolean",
          "regularHalfDuration": "integer (int32)",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "location": "string",
          "extraTime": "string",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "updates": "integer (int64)",
        "deleted": "boolean",
        "lastUpdate": "string",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        }
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

rounds

Retrieve all rounds for given season/s. MAX 500 IDs at a time.

GET /seasons/{seasonIds}/rounds

Returns all rounds for given season/s. MAX 500 IDs at a time.

seasonIds: string

in path

Comma separated list of IDs for season/s to return

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

200 OK

Rounds

successful operation

400 Bad Request

ErrorModel

Invalid URL

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "rounds": [
      {
        "id": "integer (int64)",
        "name": "string",
        "sportId": "integer (int64)",
        "sportName": "string",
        "competitionId": "integer (int64)",
        "competitionName": "string",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "parentRound": "integer (int64)",
        "startDate": "string",
        "endDate": "string",
        "type": "string",
        "roundproperty": {
          "sets": "integer (int32)",
          "surface": "string",
          "timezone": "string",
          "finalSet": "string",
          "association": "string",
          "awayGoalsAfterNormalTime": "string",
          "handicapRace": "boolean",
          "fixtureFormat": "string",
          "extraTimeHalfDuration": "integer (int32)",
          "roundNumber": "integer (int32)",
          "isProtected": "boolean",
          "regularHalfDuration": "integer (int32)",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "location": "string",
          "extraTime": "string",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "updates": "integer (int64)",
        "deleted": "boolean",
        "lastUpdate": "string",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        }
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

fixtures

Fixture details

fixtures

Retrieve all fixtures for a given competition

GET /competitions/{competitionIds}/fixtures

Returns all fixtures for a given competition for any given date range.NB max date range is 7 days, if the range is more than 7 days HAL paging links will be included in the response. Query params todate and fromdate can be set - if not this call defaults to returning from today and 1 week forward.

todate: string

in query

Fixture date i.e. 2017-02-26 (YYYY-MM-DD)

competitionIds: string

in path

Single competition ID to return fixtures for

fixtureType: string

in query

Type of fixture - Match, VirtualMatch, SeasonOutright, PartialOutright, AggregateEvent. Default "Match"

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

onlyFixtures: string

in query

Only include fixtures - i.e. no fixture competitors nor venues. Default false.

fromdate: string

in query

Fixture date i.e. 2017-02-24 (YYYY-MM-DD)

withCompetitors: string

in query

should the fixtures have competitors set or not (i.e. not TBD, Qualifiers etc). Default false.

200 OK

Fixtures

successful operation

400 Bad Request

ErrorModel

Invalid URL

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "fixtures": [
      {
        "venue": {
          "deleted": "boolean",
          "venueType": "string",
          "regionId": "integer (int64)",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "neutral": "string",
          "venueproperty": {
            "par": "string",
            "surface": "string",
            "built": "string",
            "city": "string",
            "fieldDimensions": "string",
            "latitude": "string",
            "architect": "string",
            "length": "string",
            "opened": "string",
            "capacity": "string",
            "location": "string",
            "longitude": "string",
            "constructionCost": "string"
          },
          "id": "integer (int64)",
          "updates": "integer (int64)"
        },
        "competitionId": "string",
        "statusType": "string",
        "fixturecompetitors": [
          {
            "number": "integer (int64)",
            "deleted": "boolean",
            "_links": {
              "curies": [
                {
                  "templated": "boolean",
                  "name": "string",
                  "href": "string"
                }
              ],
              "self": {
                "templated": "boolean",
                "href": "string"
              }
            },
            "competitor": {
              "deleted": "boolean",
              "gender": "string",
              "_links": {
                "curies": [
                  {
                    "templated": "boolean",
                    "name": "string",
                    "href": "string"
                  }
                ],
                "self": {
                  "templated": "boolean",
                  "href": "string"
                }
              },
              "lastUpdate": "string",
              "name": "string",
              "id": "integer (int64)",
              "updates": "integer (int64)",
              "sportId": "integer (int64)",
              "type": "string",
              "teamproperty": {
                "awayShirtSecondary": "string",
                "conference": "string",
                "toBeDecided": "boolean",
                "awayShirtPrimary": "string",
                "ageCategory": "string",
                "homePage": "string",
                "startingPitcherId": "integer (int64)",
                "shortName": "string",
                "fullDescription": "string",
                "youth": "string",
                "special": "string",
                "division": "string",
                "homeShirtSecondary": "string",
                "isProtected": "string",
                "homeShirtPrimary": "string",
                "reserve": "string",
                "comment": "string",
                "isNationalTeam": "boolean"
              },
              "playerproperty": {
                "owner": "string",
                "lastName": "string",
                "nickName": "string",
                "weight": "number",
                "fullDescription": "string",
                "dam": "string",
                "firstName": "string",
                "horseSex": "string",
                "dob": "string",
                "trainer": "string",
                "position": "string",
                "sire": "string",
                "shortName": "string",
                "height": "number",
                "status": "string",
                "hand": "string",
                "isProtected": "string"
              }
            },
            "lastUpdate": "string",
            "id": "integer (int64)",
            "updates": "integer (int64)",
            "fixturecompetitorproperty": {
              "form": "string",
              "saddleNo": "integer (int32)",
              "winnerOfEventId": "integer (int64)",
              "tackle": "string",
              "silkDescription": "string",
              "gateNo": "integer (int32)",
              "jockey": "integer (int64)",
              "weight": "integer (int64)",
              "startingPitcher": "string"
            }
          }
        ],
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "roundName": "string",
        "fixtureproperty": {
          "raceType": "string",
          "regularHalfDuration": "integer (int32)",
          "distance": "string",
          "timezone": "string",
          "groundQuality": "string",
          "neutralField": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "unitsOfPlay": "integer (int32)",
          "bestOf": "integer (int32)",
          "bestOfNum": "integer (int32)",
          "extraTime": "string",
          "sets": "integer (int32)",
          "surface": "string",
          "hasLineups": "boolean",
          "finalSet": "string",
          "handicapRace": "boolean",
          "extraTimeHalfDuration": "integer (int32)",
          "round": "string",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "association": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "rotationCodeHome": "string",
          "rotationCodeAway": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "FirstLegId": "integer (int32)",
          "SecondLegId": "integer (int32)",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "type": "string",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)",
        "startDate": "string"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

fixtures

Retrieve all fixtures for a given competitor

GET /competitors/{competitorIds}/fixtures

Returns all fixtures for a given competitor

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

todatetime: string

in query

Fixture datetime i.e. 2017-02-26T00:00:00 (YYYY-MM-DDTHH:MM:SS)

onlyFixtures: string

in query

Only include fixtures - i.e. no fixture competitors nor venues. Default false.

last: string

in query

Last X fixtures to retrieve. Default is 5

competitorIds: string

in path

Single competitor ID to return fixtures for

competitionId: string

in query

Only look for fixtures in the given Competition ID

200 OK

Fixtures

successful operation

400 Bad Request

ErrorModel

Invalid URL

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "fixtures": [
      {
        "venue": {
          "deleted": "boolean",
          "venueType": "string",
          "regionId": "integer (int64)",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "neutral": "string",
          "venueproperty": {
            "par": "string",
            "surface": "string",
            "built": "string",
            "city": "string",
            "fieldDimensions": "string",
            "latitude": "string",
            "architect": "string",
            "length": "string",
            "opened": "string",
            "capacity": "string",
            "location": "string",
            "longitude": "string",
            "constructionCost": "string"
          },
          "id": "integer (int64)",
          "updates": "integer (int64)"
        },
        "competitionId": "string",
        "statusType": "string",
        "fixturecompetitors": [
          {
            "number": "integer (int64)",
            "deleted": "boolean",
            "_links": {
              "curies": [
                {
                  "templated": "boolean",
                  "name": "string",
                  "href": "string"
                }
              ],
              "self": {
                "templated": "boolean",
                "href": "string"
              }
            },
            "competitor": {
              "deleted": "boolean",
              "gender": "string",
              "_links": {
                "curies": [
                  {
                    "templated": "boolean",
                    "name": "string",
                    "href": "string"
                  }
                ],
                "self": {
                  "templated": "boolean",
                  "href": "string"
                }
              },
              "lastUpdate": "string",
              "name": "string",
              "id": "integer (int64)",
              "updates": "integer (int64)",
              "sportId": "integer (int64)",
              "type": "string",
              "teamproperty": {
                "awayShirtSecondary": "string",
                "conference": "string",
                "toBeDecided": "boolean",
                "awayShirtPrimary": "string",
                "ageCategory": "string",
                "homePage": "string",
                "startingPitcherId": "integer (int64)",
                "shortName": "string",
                "fullDescription": "string",
                "youth": "string",
                "special": "string",
                "division": "string",
                "homeShirtSecondary": "string",
                "isProtected": "string",
                "homeShirtPrimary": "string",
                "reserve": "string",
                "comment": "string",
                "isNationalTeam": "boolean"
              },
              "playerproperty": {
                "owner": "string",
                "lastName": "string",
                "nickName": "string",
                "weight": "number",
                "fullDescription": "string",
                "dam": "string",
                "firstName": "string",
                "horseSex": "string",
                "dob": "string",
                "trainer": "string",
                "position": "string",
                "sire": "string",
                "shortName": "string",
                "height": "number",
                "status": "string",
                "hand": "string",
                "isProtected": "string"
              }
            },
            "lastUpdate": "string",
            "id": "integer (int64)",
            "updates": "integer (int64)",
            "fixturecompetitorproperty": {
              "form": "string",
              "saddleNo": "integer (int32)",
              "winnerOfEventId": "integer (int64)",
              "tackle": "string",
              "silkDescription": "string",
              "gateNo": "integer (int32)",
              "jockey": "integer (int64)",
              "weight": "integer (int64)",
              "startingPitcher": "string"
            }
          }
        ],
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "roundName": "string",
        "fixtureproperty": {
          "raceType": "string",
          "regularHalfDuration": "integer (int32)",
          "distance": "string",
          "timezone": "string",
          "groundQuality": "string",
          "neutralField": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "unitsOfPlay": "integer (int32)",
          "bestOf": "integer (int32)",
          "bestOfNum": "integer (int32)",
          "extraTime": "string",
          "sets": "integer (int32)",
          "surface": "string",
          "hasLineups": "boolean",
          "finalSet": "string",
          "handicapRace": "boolean",
          "extraTimeHalfDuration": "integer (int32)",
          "round": "string",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "association": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "rotationCodeHome": "string",
          "rotationCodeAway": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "FirstLegId": "integer (int32)",
          "SecondLegId": "integer (int32)",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "type": "string",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)",
        "startDate": "string"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

fixtures

Retrieve fixture by ID/s. MAX 500 IDs at a time.

GET /fixtures/{fixtureIds}

Returns fixture/s. MAX 500 IDs at a time.

withCompetitors: string

in query

should the fixtures have competitors set or not (i.e. not TBD, Qualifiers etc). Default false.

fixtureType: string

in query

Type of fixture - Match, VirtualMatch, SeasonOutright, PartialOutright, AggregateEvent. Default "Match"

fixtureIds: string

in path

Comma separated list of IDs for fixture/s to return

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

onlyFixtures: string

in query

Only include fixtures - i.e. no fixture competitors nor venues. Default false.

200 OK

Fixtures

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Fixture not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "fixtures": [
      {
        "venue": {
          "deleted": "boolean",
          "venueType": "string",
          "regionId": "integer (int64)",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "neutral": "string",
          "venueproperty": {
            "par": "string",
            "surface": "string",
            "built": "string",
            "city": "string",
            "fieldDimensions": "string",
            "latitude": "string",
            "architect": "string",
            "length": "string",
            "opened": "string",
            "capacity": "string",
            "location": "string",
            "longitude": "string",
            "constructionCost": "string"
          },
          "id": "integer (int64)",
          "updates": "integer (int64)"
        },
        "competitionId": "string",
        "statusType": "string",
        "fixturecompetitors": [
          {
            "number": "integer (int64)",
            "deleted": "boolean",
            "_links": {
              "curies": [
                {
                  "templated": "boolean",
                  "name": "string",
                  "href": "string"
                }
              ],
              "self": {
                "templated": "boolean",
                "href": "string"
              }
            },
            "competitor": {
              "deleted": "boolean",
              "gender": "string",
              "_links": {
                "curies": [
                  {
                    "templated": "boolean",
                    "name": "string",
                    "href": "string"
                  }
                ],
                "self": {
                  "templated": "boolean",
                  "href": "string"
                }
              },
              "lastUpdate": "string",
              "name": "string",
              "id": "integer (int64)",
              "updates": "integer (int64)",
              "sportId": "integer (int64)",
              "type": "string",
              "teamproperty": {
                "awayShirtSecondary": "string",
                "conference": "string",
                "toBeDecided": "boolean",
                "awayShirtPrimary": "string",
                "ageCategory": "string",
                "homePage": "string",
                "startingPitcherId": "integer (int64)",
                "shortName": "string",
                "fullDescription": "string",
                "youth": "string",
                "special": "string",
                "division": "string",
                "homeShirtSecondary": "string",
                "isProtected": "string",
                "homeShirtPrimary": "string",
                "reserve": "string",
                "comment": "string",
                "isNationalTeam": "boolean"
              },
              "playerproperty": {
                "owner": "string",
                "lastName": "string",
                "nickName": "string",
                "weight": "number",
                "fullDescription": "string",
                "dam": "string",
                "firstName": "string",
                "horseSex": "string",
                "dob": "string",
                "trainer": "string",
                "position": "string",
                "sire": "string",
                "shortName": "string",
                "height": "number",
                "status": "string",
                "hand": "string",
                "isProtected": "string"
              }
            },
            "lastUpdate": "string",
            "id": "integer (int64)",
            "updates": "integer (int64)",
            "fixturecompetitorproperty": {
              "form": "string",
              "saddleNo": "integer (int32)",
              "winnerOfEventId": "integer (int64)",
              "tackle": "string",
              "silkDescription": "string",
              "gateNo": "integer (int32)",
              "jockey": "integer (int64)",
              "weight": "integer (int64)",
              "startingPitcher": "string"
            }
          }
        ],
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "roundName": "string",
        "fixtureproperty": {
          "raceType": "string",
          "regularHalfDuration": "integer (int32)",
          "distance": "string",
          "timezone": "string",
          "groundQuality": "string",
          "neutralField": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "unitsOfPlay": "integer (int32)",
          "bestOf": "integer (int32)",
          "bestOfNum": "integer (int32)",
          "extraTime": "string",
          "sets": "integer (int32)",
          "surface": "string",
          "hasLineups": "boolean",
          "finalSet": "string",
          "handicapRace": "boolean",
          "extraTimeHalfDuration": "integer (int32)",
          "round": "string",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "association": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "rotationCodeHome": "string",
          "rotationCodeAway": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "FirstLegId": "integer (int32)",
          "SecondLegId": "integer (int32)",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "type": "string",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)",
        "startDate": "string"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

fixtures

Retrieve all head-to-head fixtures for given competitors. Requires TWO IDs

GET /h2h/{competitorIds}/fixtures

Returns all head-to-head fixtures for given competitors. Requires TWO IDs

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

todatetime: string

in query

Fixture datetime i.e. 2017-02-26T00:00:00 (YYYY-MM-DDTHH:MM:SS)

onlyFixtures: string

in query

Only include fixtures - i.e. no fixture competitors nor venues. Default false.

last: string

in query

Last X fixtures to retrieve. Default is 5

competitorIds: string

in path

Comma separated list of IDs for competitors. Requires TWO IDs

competitionId: string

in query

Only look for fixtures in the given Competition ID

200 OK

Fixtures

successful operation

400 Bad Request

ErrorModel

Invalid URL

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "fixtures": [
      {
        "venue": {
          "deleted": "boolean",
          "venueType": "string",
          "regionId": "integer (int64)",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "neutral": "string",
          "venueproperty": {
            "par": "string",
            "surface": "string",
            "built": "string",
            "city": "string",
            "fieldDimensions": "string",
            "latitude": "string",
            "architect": "string",
            "length": "string",
            "opened": "string",
            "capacity": "string",
            "location": "string",
            "longitude": "string",
            "constructionCost": "string"
          },
          "id": "integer (int64)",
          "updates": "integer (int64)"
        },
        "competitionId": "string",
        "statusType": "string",
        "fixturecompetitors": [
          {
            "number": "integer (int64)",
            "deleted": "boolean",
            "_links": {
              "curies": [
                {
                  "templated": "boolean",
                  "name": "string",
                  "href": "string"
                }
              ],
              "self": {
                "templated": "boolean",
                "href": "string"
              }
            },
            "competitor": {
              "deleted": "boolean",
              "gender": "string",
              "_links": {
                "curies": [
                  {
                    "templated": "boolean",
                    "name": "string",
                    "href": "string"
                  }
                ],
                "self": {
                  "templated": "boolean",
                  "href": "string"
                }
              },
              "lastUpdate": "string",
              "name": "string",
              "id": "integer (int64)",
              "updates": "integer (int64)",
              "sportId": "integer (int64)",
              "type": "string",
              "teamproperty": {
                "awayShirtSecondary": "string",
                "conference": "string",
                "toBeDecided": "boolean",
                "awayShirtPrimary": "string",
                "ageCategory": "string",
                "homePage": "string",
                "startingPitcherId": "integer (int64)",
                "shortName": "string",
                "fullDescription": "string",
                "youth": "string",
                "special": "string",
                "division": "string",
                "homeShirtSecondary": "string",
                "isProtected": "string",
                "homeShirtPrimary": "string",
                "reserve": "string",
                "comment": "string",
                "isNationalTeam": "boolean"
              },
              "playerproperty": {
                "owner": "string",
                "lastName": "string",
                "nickName": "string",
                "weight": "number",
                "fullDescription": "string",
                "dam": "string",
                "firstName": "string",
                "horseSex": "string",
                "dob": "string",
                "trainer": "string",
                "position": "string",
                "sire": "string",
                "shortName": "string",
                "height": "number",
                "status": "string",
                "hand": "string",
                "isProtected": "string"
              }
            },
            "lastUpdate": "string",
            "id": "integer (int64)",
            "updates": "integer (int64)",
            "fixturecompetitorproperty": {
              "form": "string",
              "saddleNo": "integer (int32)",
              "winnerOfEventId": "integer (int64)",
              "tackle": "string",
              "silkDescription": "string",
              "gateNo": "integer (int32)",
              "jockey": "integer (int64)",
              "weight": "integer (int64)",
              "startingPitcher": "string"
            }
          }
        ],
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "roundName": "string",
        "fixtureproperty": {
          "raceType": "string",
          "regularHalfDuration": "integer (int32)",
          "distance": "string",
          "timezone": "string",
          "groundQuality": "string",
          "neutralField": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "unitsOfPlay": "integer (int32)",
          "bestOf": "integer (int32)",
          "bestOfNum": "integer (int32)",
          "extraTime": "string",
          "sets": "integer (int32)",
          "surface": "string",
          "hasLineups": "boolean",
          "finalSet": "string",
          "handicapRace": "boolean",
          "extraTimeHalfDuration": "integer (int32)",
          "round": "string",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "association": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "rotationCodeHome": "string",
          "rotationCodeAway": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "FirstLegId": "integer (int32)",
          "SecondLegId": "integer (int32)",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "type": "string",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)",
        "startDate": "string"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

fixtures

Retrieve all fixtures for a given round/

GET /rounds/{roundIds}/fixtures

Returns all fixtures for a given round

roundIds: string

in path

Single round ID to return fixtures for

todate: string

in query

Fixture date i.e. 2017-02-26 (YYYY-MM-DD)

fixtureType: string

in query

Type of fixture - Match, VirtualMatch, SeasonOutright, PartialOutright, AggregateEvent. Default "Match"

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

onlyFixtures: string

in query

Only include fixtures - i.e. no fixture competitors nor venues. Default false.

fromdate: string

in query

Fixture date i.e. 2017-02-24 (YYYY-MM-DD)

withCompetitors: string

in query

should the fixtures have competitors set or not (i.e. not TBD, Qualifiers etc). Default false.

200 OK

Fixtures

successful operation

400 Bad Request

ErrorModel

Invalid URL

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "fixtures": [
      {
        "venue": {
          "deleted": "boolean",
          "venueType": "string",
          "regionId": "integer (int64)",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "neutral": "string",
          "venueproperty": {
            "par": "string",
            "surface": "string",
            "built": "string",
            "city": "string",
            "fieldDimensions": "string",
            "latitude": "string",
            "architect": "string",
            "length": "string",
            "opened": "string",
            "capacity": "string",
            "location": "string",
            "longitude": "string",
            "constructionCost": "string"
          },
          "id": "integer (int64)",
          "updates": "integer (int64)"
        },
        "competitionId": "string",
        "statusType": "string",
        "fixturecompetitors": [
          {
            "number": "integer (int64)",
            "deleted": "boolean",
            "_links": {
              "curies": [
                {
                  "templated": "boolean",
                  "name": "string",
                  "href": "string"
                }
              ],
              "self": {
                "templated": "boolean",
                "href": "string"
              }
            },
            "competitor": {
              "deleted": "boolean",
              "gender": "string",
              "_links": {
                "curies": [
                  {
                    "templated": "boolean",
                    "name": "string",
                    "href": "string"
                  }
                ],
                "self": {
                  "templated": "boolean",
                  "href": "string"
                }
              },
              "lastUpdate": "string",
              "name": "string",
              "id": "integer (int64)",
              "updates": "integer (int64)",
              "sportId": "integer (int64)",
              "type": "string",
              "teamproperty": {
                "awayShirtSecondary": "string",
                "conference": "string",
                "toBeDecided": "boolean",
                "awayShirtPrimary": "string",
                "ageCategory": "string",
                "homePage": "string",
                "startingPitcherId": "integer (int64)",
                "shortName": "string",
                "fullDescription": "string",
                "youth": "string",
                "special": "string",
                "division": "string",
                "homeShirtSecondary": "string",
                "isProtected": "string",
                "homeShirtPrimary": "string",
                "reserve": "string",
                "comment": "string",
                "isNationalTeam": "boolean"
              },
              "playerproperty": {
                "owner": "string",
                "lastName": "string",
                "nickName": "string",
                "weight": "number",
                "fullDescription": "string",
                "dam": "string",
                "firstName": "string",
                "horseSex": "string",
                "dob": "string",
                "trainer": "string",
                "position": "string",
                "sire": "string",
                "shortName": "string",
                "height": "number",
                "status": "string",
                "hand": "string",
                "isProtected": "string"
              }
            },
            "lastUpdate": "string",
            "id": "integer (int64)",
            "updates": "integer (int64)",
            "fixturecompetitorproperty": {
              "form": "string",
              "saddleNo": "integer (int32)",
              "winnerOfEventId": "integer (int64)",
              "tackle": "string",
              "silkDescription": "string",
              "gateNo": "integer (int32)",
              "jockey": "integer (int64)",
              "weight": "integer (int64)",
              "startingPitcher": "string"
            }
          }
        ],
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "roundName": "string",
        "fixtureproperty": {
          "raceType": "string",
          "regularHalfDuration": "integer (int32)",
          "distance": "string",
          "timezone": "string",
          "groundQuality": "string",
          "neutralField": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "unitsOfPlay": "integer (int32)",
          "bestOf": "integer (int32)",
          "bestOfNum": "integer (int32)",
          "extraTime": "string",
          "sets": "integer (int32)",
          "surface": "string",
          "hasLineups": "boolean",
          "finalSet": "string",
          "handicapRace": "boolean",
          "extraTimeHalfDuration": "integer (int32)",
          "round": "string",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "association": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "rotationCodeHome": "string",
          "rotationCodeAway": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "FirstLegId": "integer (int32)",
          "SecondLegId": "integer (int32)",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "type": "string",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)",
        "startDate": "string"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

fixtures

Retrieve all fixtures for a given season

GET /seasons/{seasonIds}/fixtures

Returns all fixtures for a given season

todate: string

in query

Fixture date i.e. 2017-02-26 (YYYY-MM-DD)

fixtureType: string

in query

Type of fixture - Match, VirtualMatch, SeasonOutright, PartialOutright, AggregateEvent. Default "Match"

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

onlyFixtures: string

in query

Only include fixtures - i.e. no fixture competitors nor venues. Default false.

fromdate: string

in query

Fixture date i.e. 2017-02-24 (YYYY-MM-DD)

withCompetitors: string

in query

should the fixtures have competitors set or not (i.e. not TBD, Qualifiers etc). Default false.

seasonIds: string

in path

Single season ID to return fixtures for

200 OK

Fixtures

successful operation

400 Bad Request

ErrorModel

Invalid URL

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "fixtures": [
      {
        "venue": {
          "deleted": "boolean",
          "venueType": "string",
          "regionId": "integer (int64)",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "neutral": "string",
          "venueproperty": {
            "par": "string",
            "surface": "string",
            "built": "string",
            "city": "string",
            "fieldDimensions": "string",
            "latitude": "string",
            "architect": "string",
            "length": "string",
            "opened": "string",
            "capacity": "string",
            "location": "string",
            "longitude": "string",
            "constructionCost": "string"
          },
          "id": "integer (int64)",
          "updates": "integer (int64)"
        },
        "competitionId": "string",
        "statusType": "string",
        "fixturecompetitors": [
          {
            "number": "integer (int64)",
            "deleted": "boolean",
            "_links": {
              "curies": [
                {
                  "templated": "boolean",
                  "name": "string",
                  "href": "string"
                }
              ],
              "self": {
                "templated": "boolean",
                "href": "string"
              }
            },
            "competitor": {
              "deleted": "boolean",
              "gender": "string",
              "_links": {
                "curies": [
                  {
                    "templated": "boolean",
                    "name": "string",
                    "href": "string"
                  }
                ],
                "self": {
                  "templated": "boolean",
                  "href": "string"
                }
              },
              "lastUpdate": "string",
              "name": "string",
              "id": "integer (int64)",
              "updates": "integer (int64)",
              "sportId": "integer (int64)",
              "type": "string",
              "teamproperty": {
                "awayShirtSecondary": "string",
                "conference": "string",
                "toBeDecided": "boolean",
                "awayShirtPrimary": "string",
                "ageCategory": "string",
                "homePage": "string",
                "startingPitcherId": "integer (int64)",
                "shortName": "string",
                "fullDescription": "string",
                "youth": "string",
                "special": "string",
                "division": "string",
                "homeShirtSecondary": "string",
                "isProtected": "string",
                "homeShirtPrimary": "string",
                "reserve": "string",
                "comment": "string",
                "isNationalTeam": "boolean"
              },
              "playerproperty": {
                "owner": "string",
                "lastName": "string",
                "nickName": "string",
                "weight": "number",
                "fullDescription": "string",
                "dam": "string",
                "firstName": "string",
                "horseSex": "string",
                "dob": "string",
                "trainer": "string",
                "position": "string",
                "sire": "string",
                "shortName": "string",
                "height": "number",
                "status": "string",
                "hand": "string",
                "isProtected": "string"
              }
            },
            "lastUpdate": "string",
            "id": "integer (int64)",
            "updates": "integer (int64)",
            "fixturecompetitorproperty": {
              "form": "string",
              "saddleNo": "integer (int32)",
              "winnerOfEventId": "integer (int64)",
              "tackle": "string",
              "silkDescription": "string",
              "gateNo": "integer (int32)",
              "jockey": "integer (int64)",
              "weight": "integer (int64)",
              "startingPitcher": "string"
            }
          }
        ],
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "roundName": "string",
        "fixtureproperty": {
          "raceType": "string",
          "regularHalfDuration": "integer (int32)",
          "distance": "string",
          "timezone": "string",
          "groundQuality": "string",
          "neutralField": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "unitsOfPlay": "integer (int32)",
          "bestOf": "integer (int32)",
          "bestOfNum": "integer (int32)",
          "extraTime": "string",
          "sets": "integer (int32)",
          "surface": "string",
          "hasLineups": "boolean",
          "finalSet": "string",
          "handicapRace": "boolean",
          "extraTimeHalfDuration": "integer (int32)",
          "round": "string",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "association": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "rotationCodeHome": "string",
          "rotationCodeAway": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "FirstLegId": "integer (int32)",
          "SecondLegId": "integer (int32)",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "type": "string",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)",
        "startDate": "string"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

fixtures

Retrieve fixtures by sport

GET /sports/{sportIds}/fixtures

Returns all fixtures for a given sport for any given SINGLE day, if more than one day HAL paging links will be included in the response. Query params fromdate and todate can be set - if not this call defaults to returning today's fixtures

todate: string

in query

Fixture date i.e. 2017-02-26 (YYYY-MM-DD)

fixtureType: string

in query

Type of fixture - Match, VirtualMatch, SeasonOutright, PartialOutright, AggregateEvent. Default "Match"

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

onlyFixtures: string

in query

Only include fixtures - i.e. no fixture competitors nor venues. Default false.

fromdate: string

in query

Fixture date i.e. 2017-02-24 (YYYY-MM-DD)

withCompetitors: string

in query

should the fixtures have competitors set or not (i.e. not TBD, Qualifiers etc). Default false.

sportIds: string

in path

Single sport ID to return fixtures for

200 OK

Fixtures

successful operation

400 Bad Request

ErrorModel

Invalid date or sport supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "fixtures": [
      {
        "venue": {
          "deleted": "boolean",
          "venueType": "string",
          "regionId": "integer (int64)",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "neutral": "string",
          "venueproperty": {
            "par": "string",
            "surface": "string",
            "built": "string",
            "city": "string",
            "fieldDimensions": "string",
            "latitude": "string",
            "architect": "string",
            "length": "string",
            "opened": "string",
            "capacity": "string",
            "location": "string",
            "longitude": "string",
            "constructionCost": "string"
          },
          "id": "integer (int64)",
          "updates": "integer (int64)"
        },
        "competitionId": "string",
        "statusType": "string",
        "fixturecompetitors": [
          {
            "number": "integer (int64)",
            "deleted": "boolean",
            "_links": {
              "curies": [
                {
                  "templated": "boolean",
                  "name": "string",
                  "href": "string"
                }
              ],
              "self": {
                "templated": "boolean",
                "href": "string"
              }
            },
            "competitor": {
              "deleted": "boolean",
              "gender": "string",
              "_links": {
                "curies": [
                  {
                    "templated": "boolean",
                    "name": "string",
                    "href": "string"
                  }
                ],
                "self": {
                  "templated": "boolean",
                  "href": "string"
                }
              },
              "lastUpdate": "string",
              "name": "string",
              "id": "integer (int64)",
              "updates": "integer (int64)",
              "sportId": "integer (int64)",
              "type": "string",
              "teamproperty": {
                "awayShirtSecondary": "string",
                "conference": "string",
                "toBeDecided": "boolean",
                "awayShirtPrimary": "string",
                "ageCategory": "string",
                "homePage": "string",
                "startingPitcherId": "integer (int64)",
                "shortName": "string",
                "fullDescription": "string",
                "youth": "string",
                "special": "string",
                "division": "string",
                "homeShirtSecondary": "string",
                "isProtected": "string",
                "homeShirtPrimary": "string",
                "reserve": "string",
                "comment": "string",
                "isNationalTeam": "boolean"
              },
              "playerproperty": {
                "owner": "string",
                "lastName": "string",
                "nickName": "string",
                "weight": "number",
                "fullDescription": "string",
                "dam": "string",
                "firstName": "string",
                "horseSex": "string",
                "dob": "string",
                "trainer": "string",
                "position": "string",
                "sire": "string",
                "shortName": "string",
                "height": "number",
                "status": "string",
                "hand": "string",
                "isProtected": "string"
              }
            },
            "lastUpdate": "string",
            "id": "integer (int64)",
            "updates": "integer (int64)",
            "fixturecompetitorproperty": {
              "form": "string",
              "saddleNo": "integer (int32)",
              "winnerOfEventId": "integer (int64)",
              "tackle": "string",
              "silkDescription": "string",
              "gateNo": "integer (int32)",
              "jockey": "integer (int64)",
              "weight": "integer (int64)",
              "startingPitcher": "string"
            }
          }
        ],
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "roundName": "string",
        "fixtureproperty": {
          "raceType": "string",
          "regularHalfDuration": "integer (int32)",
          "distance": "string",
          "timezone": "string",
          "groundQuality": "string",
          "neutralField": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "unitsOfPlay": "integer (int32)",
          "bestOf": "integer (int32)",
          "bestOfNum": "integer (int32)",
          "extraTime": "string",
          "sets": "integer (int32)",
          "surface": "string",
          "hasLineups": "boolean",
          "finalSet": "string",
          "handicapRace": "boolean",
          "extraTimeHalfDuration": "integer (int32)",
          "round": "string",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "association": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "rotationCodeHome": "string",
          "rotationCodeAway": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "FirstLegId": "integer (int32)",
          "SecondLegId": "integer (int32)",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "type": "string",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)",
        "startDate": "string"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

competitors

Competitor details

competitors

Retrieve competitor (Team OR Player) ID/s. MAX 500 IDs at a time.

GET /competitors/{competitorIds}

Returns competitor/s. MAX 500 IDs at a time.

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

competitorIds: string

in path

Comma separated list of IDs for teams/s to return players for

200 OK

Competitors

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Team not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "competitors": [
      {
        "deleted": "boolean",
        "gender": "string",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "id": "integer (int64)",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "type": "string",
        "teamproperty": {
          "awayShirtSecondary": "string",
          "conference": "string",
          "toBeDecided": "boolean",
          "awayShirtPrimary": "string",
          "ageCategory": "string",
          "homePage": "string",
          "startingPitcherId": "integer (int64)",
          "shortName": "string",
          "fullDescription": "string",
          "youth": "string",
          "special": "string",
          "division": "string",
          "homeShirtSecondary": "string",
          "isProtected": "string",
          "homeShirtPrimary": "string",
          "reserve": "string",
          "comment": "string",
          "isNationalTeam": "boolean"
        },
        "playerproperty": {
          "owner": "string",
          "lastName": "string",
          "nickName": "string",
          "weight": "number",
          "fullDescription": "string",
          "dam": "string",
          "firstName": "string",
          "horseSex": "string",
          "dob": "string",
          "trainer": "string",
          "position": "string",
          "sire": "string",
          "shortName": "string",
          "height": "number",
          "status": "string",
          "hand": "string",
          "isProtected": "string"
        }
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

competitors

Retrieve contract/s (Team OR Player) ID/s. MAX 200 IDs at a time.

GET /contracts/{competitorIds}

Returns contracts. MAX 200 IDs at a time.

isActive: string

in query

If the relation is active or not. Default true.

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

competitorIds: string

in path

Comma separated list of IDs for teams/s to return players for

200 OK

Contracts

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Team not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "contracts": [
      {
        "role": "string",
        "shirtNumber": "string",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitor": {
          "deleted": "boolean",
          "gender": "string",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "id": "integer (int64)",
          "updates": "integer (int64)",
          "sportId": "integer (int64)",
          "type": "string",
          "teamproperty": {
            "awayShirtSecondary": "string",
            "conference": "string",
            "toBeDecided": "boolean",
            "awayShirtPrimary": "string",
            "ageCategory": "string",
            "homePage": "string",
            "startingPitcherId": "integer (int64)",
            "shortName": "string",
            "fullDescription": "string",
            "youth": "string",
            "special": "string",
            "division": "string",
            "homeShirtSecondary": "string",
            "isProtected": "string",
            "homeShirtPrimary": "string",
            "reserve": "string",
            "comment": "string",
            "isNationalTeam": "boolean"
          },
          "playerproperty": {
            "owner": "string",
            "lastName": "string",
            "nickName": "string",
            "weight": "number",
            "fullDescription": "string",
            "dam": "string",
            "firstName": "string",
            "horseSex": "string",
            "dob": "string",
            "trainer": "string",
            "position": "string",
            "sire": "string",
            "shortName": "string",
            "height": "number",
            "status": "string",
            "hand": "string",
            "isProtected": "string"
          }
        },
        "dateTo": "string",
        "id": "integer (int64)",
        "type": "string",
        "dateFrom": "string",
        "active": "boolean"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

competitors

Retrieve all competitors for a given round

GET /roundcompetitors/{roundIds}

Returns all competitors for a given round

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

roundIds: string

in path

Single round ID to return competitors for

200 OK

RoundCompetitors

successful operation

400 Bad Request

ErrorModel

Invalid URL

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "roundcompetitors": [
      {
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitor": {
          "deleted": "boolean",
          "gender": "string",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "id": "integer (int64)",
          "updates": "integer (int64)",
          "sportId": "integer (int64)",
          "type": "string",
          "teamproperty": {
            "awayShirtSecondary": "string",
            "conference": "string",
            "toBeDecided": "boolean",
            "awayShirtPrimary": "string",
            "ageCategory": "string",
            "homePage": "string",
            "startingPitcherId": "integer (int64)",
            "shortName": "string",
            "fullDescription": "string",
            "youth": "string",
            "special": "string",
            "division": "string",
            "homeShirtSecondary": "string",
            "isProtected": "string",
            "homeShirtPrimary": "string",
            "reserve": "string",
            "comment": "string",
            "isNationalTeam": "boolean"
          },
          "playerproperty": {
            "owner": "string",
            "lastName": "string",
            "nickName": "string",
            "weight": "number",
            "fullDescription": "string",
            "dam": "string",
            "firstName": "string",
            "horseSex": "string",
            "dob": "string",
            "trainer": "string",
            "position": "string",
            "sire": "string",
            "shortName": "string",
            "height": "number",
            "status": "string",
            "hand": "string",
            "isProtected": "string"
          }
        },
        "roundName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

competitors

Retrieve all competitors for a given season

GET /seasoncompetitors/{seasonIds}

Returns all competitors for a given season

seasonIds: string

in path

Single season ID to return competitors for

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

200 OK

SeasonCompetitors

successful operation

400 Bad Request

ErrorModel

Invalid URL

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "seasoncompetitors": [
      {
        "seasonId": "integer (int64)",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitor": {
          "deleted": "boolean",
          "gender": "string",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "id": "integer (int64)",
          "updates": "integer (int64)",
          "sportId": "integer (int64)",
          "type": "string",
          "teamproperty": {
            "awayShirtSecondary": "string",
            "conference": "string",
            "toBeDecided": "boolean",
            "awayShirtPrimary": "string",
            "ageCategory": "string",
            "homePage": "string",
            "startingPitcherId": "integer (int64)",
            "shortName": "string",
            "fullDescription": "string",
            "youth": "string",
            "special": "string",
            "division": "string",
            "homeShirtSecondary": "string",
            "isProtected": "string",
            "homeShirtPrimary": "string",
            "reserve": "string",
            "comment": "string",
            "isNationalTeam": "boolean"
          },
          "playerproperty": {
            "owner": "string",
            "lastName": "string",
            "nickName": "string",
            "weight": "number",
            "fullDescription": "string",
            "dam": "string",
            "firstName": "string",
            "horseSex": "string",
            "dob": "string",
            "trainer": "string",
            "position": "string",
            "sire": "string",
            "shortName": "string",
            "height": "number",
            "status": "string",
            "hand": "string",
            "isProtected": "string"
          }
        },
        "seasonName": "string",
        "id": "integer (int64)",
        "childrenChecked": "boolean"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

venues

Venue details

venues

Retrieve all venues

GET /venues

Returns all venues

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

200 OK

Venues

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Venue not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "venues": [
      {
        "deleted": "boolean",
        "venueType": "string",
        "regionId": "integer (int64)",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "neutral": "string",
        "venueproperty": {
          "par": "string",
          "surface": "string",
          "built": "string",
          "city": "string",
          "fieldDimensions": "string",
          "latitude": "string",
          "architect": "string",
          "length": "string",
          "opened": "string",
          "capacity": "string",
          "location": "string",
          "longitude": "string",
          "constructionCost": "string"
        },
        "id": "integer (int64)",
        "updates": "integer (int64)"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

venues

Retrieve venues by ID/s

GET /venues/{venueIds}

Returns venues by IDs

x-api-key: string

in header

(no description)

deleted: string

in query

true|false|all - Give me only deleted objects, no deleted objects or everything. Default is false.

venueIds: string

in path

Comma separated list of IDs of venues/s to return

200 OK

Venues

successful operation

400 Bad Request

ErrorModel

Invalid ID supplied

401 Unauthorized

ErrorModel

Unauthorized

403 Forbidden

ErrorModel

Forbidden

404 Not Found

ErrorModel

Venue not found

413 Request Entity Too Large

ErrorModel

Payload Too Large

415 Unsupported Media Type

ErrorModel

Unsupported Media Type

429 Too Many Requests

ErrorModel

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

ErrorModel

Internal Server Error

504 Gateway Timeout

ErrorModel

Gateway Timeout

520

ErrorModel

Unknown error

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "venues": [
      {
        "deleted": "boolean",
        "venueType": "string",
        "regionId": "integer (int64)",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "neutral": "string",
        "venueproperty": {
          "par": "string",
          "surface": "string",
          "built": "string",
          "city": "string",
          "fieldDimensions": "string",
          "latitude": "string",
          "architect": "string",
          "length": "string",
          "opened": "string",
          "capacity": "string",
          "location": "string",
          "longitude": "string",
          "constructionCost": "string"
        },
        "id": "integer (int64)",
        "updates": "integer (int64)"
      }
    ]
  }
}

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string

Response Example (400 Bad Request)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (401 Unauthorized)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (403 Forbidden)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (404 Not Found)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (413 Request Entity Too Large)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (415 Unsupported Media Type)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (429 Too Many Requests)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (500 Internal Server Error)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (504 Gateway Timeout)

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Response Example (520 )

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}


CognitoPool
api_key

default

OPTIONS /competitions/{competitionIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /competitions/{competitionIds}/fixtures

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /competitions/{competitionIds}/seasons

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /competitors/{competitorIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /competitors/{competitorIds}/fixtures

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /contracts/{competitorIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /fixtures/{fixtureIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /h2h/{competitorIds}/fixtures

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /regions

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /regions/{regionIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /roundcompetitors/{roundIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /rounds/{roundIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /rounds/{roundIds}/fixtures

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /seasoncompetitors/{seasonIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /seasons/{seasonIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /seasons/{seasonIds}/fixtures

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /seasons/{seasonIds}/rounds

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /sports

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /sports/{sportIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /sports/{sportIds}/competitions

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /sports/{sportIds}/fixtures

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /venues

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

OPTIONS /venues/{venueIds}

200 OK

Empty

200 response

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Headers (200 OK)


Access-Control-Allow-Origin	undefined	string
Access-Control-Allow-Methods	undefined	string
Access-Control-Allow-Headers	undefined	string

Schema Definitions

Competition: object

sportId: integer (int64)
deleted: boolean: deleted entity
gender: string male, female, mixed, undefined: gender
competitionproperty: CompetitionProperty
_links: object
curies: Curie Curie self: Link
lastUpdate: string
name: string
sportName: string
id: integer (int64)
updates: integer (int64)

Example

{
  "sportId": "integer (int64)",
  "deleted": "boolean",
  "gender": "string",
  "competitionproperty": {
    "sets": "integer (int32)",
    "surface": "string",
    "finalSet": "string",
    "sponsorName": "string",
    "competitionType": "string",
    "association": "string",
    "isTour": "boolean",
    "awayGoalsAfterNormalTime": "string",
    "handicapRace": "boolean",
    "defaultTimeZone": "string",
    "fixtureFormat": "string",
    "isProtected": "boolean",
    "regionId": "integer (int64)",
    "matchDuration": "string",
    "goesStraightToPenalties": "string",
    "prizeMoney": "integer (int32)",
    "currency": "string",
    "location": "string",
    "extraTime": "string",
    "scoringSystem": "string",
    "shortName": "string",
    "awayGoalsAfterExtraTime": "string",
    "longName": "string",
    "varRule": "boolean",
    "usesTBDTeams": "boolean",
    "regularHalfDuration": "integer (int32)",
    "extraTimeHalfDuration": "integer (int32)",
    "overtimePeriodDuration": "string",
    "overtimeType": "string",
    "skatersOnIce": "string",
    "finalSetTieBreakStarts": "string",
    "finalSetTieBreakWinnerFirst": "string",
    "federation": "string",
    "penaltyShootouts": "string",
    "numberOfInnings": "string",
    "numberOfExtraInnings": "string",
    "extraInningsRunnerOnSecondBase": "boolean"
  },
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "lastUpdate": "string",
  "name": "string",
  "sportName": "string",
  "id": "integer (int64)",
  "updates": "integer (int64)"
}

Competitor: object

teamproperty is NULL if type is NOT team

deleted: boolean: deleted entity
gender: string male, female, mixed, undefined: gender
_links: object
curies: Curie Curie self: Link
lastUpdate: string
name: string
id: integer (int64)
updates: integer (int64)
sportId: integer (int64)
type: string team, official, coach, athlete, horse, dog, breeder, doubles partnership, abstract, jockey, horse owner, other: type of competitor
teamproperty: TeamProperty
playerproperty: PlayerProperty

Example

{
  "deleted": "boolean",
  "gender": "string",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "lastUpdate": "string",
  "name": "string",
  "id": "integer (int64)",
  "updates": "integer (int64)",
  "sportId": "integer (int64)",
  "type": "string",
  "teamproperty": {
    "awayShirtSecondary": "string",
    "conference": "string",
    "toBeDecided": "boolean",
    "awayShirtPrimary": "string",
    "ageCategory": "string",
    "homePage": "string",
    "startingPitcherId": "integer (int64)",
    "shortName": "string",
    "fullDescription": "string",
    "youth": "string",
    "special": "string",
    "division": "string",
    "homeShirtSecondary": "string",
    "isProtected": "string",
    "homeShirtPrimary": "string",
    "reserve": "string",
    "comment": "string",
    "isNationalTeam": "boolean"
  },
  "playerproperty": {
    "owner": "string",
    "lastName": "string",
    "nickName": "string",
    "weight": "number",
    "fullDescription": "string",
    "dam": "string",
    "firstName": "string",
    "horseSex": "string",
    "dob": "string",
    "trainer": "string",
    "position": "string",
    "sire": "string",
    "shortName": "string",
    "height": "number",
    "status": "string",
    "hand": "string",
    "isProtected": "string"
  }
}

Rounds: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
rounds: Round Round

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "rounds": [
      {
        "id": "integer (int64)",
        "name": "string",
        "sportId": "integer (int64)",
        "sportName": "string",
        "competitionId": "integer (int64)",
        "competitionName": "string",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "parentRound": "integer (int64)",
        "startDate": "string",
        "endDate": "string",
        "type": "string",
        "roundproperty": {
          "sets": "integer (int32)",
          "surface": "string",
          "timezone": "string",
          "finalSet": "string",
          "association": "string",
          "awayGoalsAfterNormalTime": "string",
          "handicapRace": "boolean",
          "fixtureFormat": "string",
          "extraTimeHalfDuration": "integer (int32)",
          "roundNumber": "integer (int32)",
          "isProtected": "boolean",
          "regularHalfDuration": "integer (int32)",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "location": "string",
          "extraTime": "string",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "updates": "integer (int64)",
        "deleted": "boolean",
        "lastUpdate": "string",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        }
      }
    ]
  }
}

Venues: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
venues: Venue Venue

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "venues": [
      {
        "deleted": "boolean",
        "venueType": "string",
        "regionId": "integer (int64)",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "neutral": "string",
        "venueproperty": {
          "par": "string",
          "surface": "string",
          "built": "string",
          "city": "string",
          "fieldDimensions": "string",
          "latitude": "string",
          "architect": "string",
          "length": "string",
          "opened": "string",
          "capacity": "string",
          "location": "string",
          "longitude": "string",
          "constructionCost": "string"
        },
        "id": "integer (int64)",
        "updates": "integer (int64)"
      }
    ]
  }
}

SeasonCompetitors: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
seasoncompetitors: SeasonCompetitor SeasonCompetitor

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "seasoncompetitors": [
      {
        "seasonId": "integer (int64)",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitor": {
          "deleted": "boolean",
          "gender": "string",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "id": "integer (int64)",
          "updates": "integer (int64)",
          "sportId": "integer (int64)",
          "type": "string",
          "teamproperty": {
            "awayShirtSecondary": "string",
            "conference": "string",
            "toBeDecided": "boolean",
            "awayShirtPrimary": "string",
            "ageCategory": "string",
            "homePage": "string",
            "startingPitcherId": "integer (int64)",
            "shortName": "string",
            "fullDescription": "string",
            "youth": "string",
            "special": "string",
            "division": "string",
            "homeShirtSecondary": "string",
            "isProtected": "string",
            "homeShirtPrimary": "string",
            "reserve": "string",
            "comment": "string",
            "isNationalTeam": "boolean"
          },
          "playerproperty": {
            "owner": "string",
            "lastName": "string",
            "nickName": "string",
            "weight": "number",
            "fullDescription": "string",
            "dam": "string",
            "firstName": "string",
            "horseSex": "string",
            "dob": "string",
            "trainer": "string",
            "position": "string",
            "sire": "string",
            "shortName": "string",
            "height": "number",
            "status": "string",
            "hand": "string",
            "isProtected": "string"
          }
        },
        "seasonName": "string",
        "id": "integer (int64)",
        "childrenChecked": "boolean"
      }
    ]
  }
}

RoundCompetitors: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
roundcompetitors: RoundCompetitor RoundCompetitor

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "roundcompetitors": [
      {
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitor": {
          "deleted": "boolean",
          "gender": "string",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "id": "integer (int64)",
          "updates": "integer (int64)",
          "sportId": "integer (int64)",
          "type": "string",
          "teamproperty": {
            "awayShirtSecondary": "string",
            "conference": "string",
            "toBeDecided": "boolean",
            "awayShirtPrimary": "string",
            "ageCategory": "string",
            "homePage": "string",
            "startingPitcherId": "integer (int64)",
            "shortName": "string",
            "fullDescription": "string",
            "youth": "string",
            "special": "string",
            "division": "string",
            "homeShirtSecondary": "string",
            "isProtected": "string",
            "homeShirtPrimary": "string",
            "reserve": "string",
            "comment": "string",
            "isNationalTeam": "boolean"
          },
          "playerproperty": {
            "owner": "string",
            "lastName": "string",
            "nickName": "string",
            "weight": "number",
            "fullDescription": "string",
            "dam": "string",
            "firstName": "string",
            "horseSex": "string",
            "dob": "string",
            "trainer": "string",
            "position": "string",
            "sire": "string",
            "shortName": "string",
            "height": "number",
            "status": "string",
            "hand": "string",
            "isProtected": "string"
          }
        },
        "roundName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)"
      }
    ]
  }
}

FixtureCompetitor: object

number: integer (int64): In home/away matches 1=home and 2=away
deleted: boolean: deleted entity
_links: object
curies: Curie Curie self: Link
competitor: Competitor
lastUpdate: string
id: integer (int64)
updates: integer (int64)
fixturecompetitorproperty: FixtureCompetitorProperty

Example

{
  "number": "integer (int64)",
  "deleted": "boolean",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "competitor": {
    "deleted": "boolean",
    "gender": "string",
    "_links": {
      "curies": [
        {
          "templated": "boolean",
          "name": "string",
          "href": "string"
        }
      ],
      "self": {
        "templated": "boolean",
        "href": "string"
      }
    },
    "lastUpdate": "string",
    "name": "string",
    "id": "integer (int64)",
    "updates": "integer (int64)",
    "sportId": "integer (int64)",
    "type": "string",
    "teamproperty": {
      "awayShirtSecondary": "string",
      "conference": "string",
      "toBeDecided": "boolean",
      "awayShirtPrimary": "string",
      "ageCategory": "string",
      "homePage": "string",
      "startingPitcherId": "integer (int64)",
      "shortName": "string",
      "fullDescription": "string",
      "youth": "string",
      "special": "string",
      "division": "string",
      "homeShirtSecondary": "string",
      "isProtected": "string",
      "homeShirtPrimary": "string",
      "reserve": "string",
      "comment": "string",
      "isNationalTeam": "boolean"
    },
    "playerproperty": {
      "owner": "string",
      "lastName": "string",
      "nickName": "string",
      "weight": "number",
      "fullDescription": "string",
      "dam": "string",
      "firstName": "string",
      "horseSex": "string",
      "dob": "string",
      "trainer": "string",
      "position": "string",
      "sire": "string",
      "shortName": "string",
      "height": "number",
      "status": "string",
      "hand": "string",
      "isProtected": "string"
    }
  },
  "lastUpdate": "string",
  "id": "integer (int64)",
  "updates": "integer (int64)",
  "fixturecompetitorproperty": {
    "form": "string",
    "saddleNo": "integer (int32)",
    "winnerOfEventId": "integer (int64)",
    "tackle": "string",
    "silkDescription": "string",
    "gateNo": "integer (int32)",
    "jockey": "integer (int64)",
    "weight": "integer (int64)",
    "startingPitcher": "string"
  }
}

Empty: object

Example

"object"

Sport: object

deleted: boolean: deleted entity
_links: object
curies: Curie Curie self: Link
lastUpdate: string
name: string
id: integer (int64)
sportproperty: SportProperty
updates: integer (int64)

Example

{
  "deleted": "boolean",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "lastUpdate": "string",
  "name": "string",
  "id": "integer (int64)",
  "sportproperty": {
    "needsUnitsOfPlay": "boolean",
    "recreateEventsThreshold": "integer (int32)"
  },
  "updates": "integer (int64)"
}

VenueProperty: object

par: string
surface: string
built: string
city: string
fieldDimensions: string
latitude: string
architect: string
length: string
opened: string
capacity: string
location: string
longitude: string
constructionCost: string

Example

{
  "par": "string",
  "surface": "string",
  "built": "string",
  "city": "string",
  "fieldDimensions": "string",
  "latitude": "string",
  "architect": "string",
  "length": "string",
  "opened": "string",
  "capacity": "string",
  "location": "string",
  "longitude": "string",
  "constructionCost": "string"
}

RoundProperty: object

sets: integer (int32)
surface: string , Hard, Carpet, Clay, Wood, Grass
timezone: string
finalSet: string Tie Break, Match Tie Break, Advantage
association: string FIBA, NBA, NCAA, NotSupported, PBA, unset,
awayGoalsAfterNormalTime: string unset, , no, yes
handicapRace: boolean
fixtureFormat: string , NHL/AHL Non-Playoff, NHL/AHL Playoff, IIHF World Championship Non-Playoff, IIHF World Championship Playoff, IIHF World Championship Gold Medal Match, All Other Non-Playoff, All Other Playoff, unset
extraTimeHalfDuration: integer (int32)
roundNumber: integer (int32): Auto incremented number for round object. Used in Golf
isProtected: boolean
regularHalfDuration: integer (int32)
matchDuration: string , 90 (+ 30 ET if applicable), 80 (+ 20 ET if applicable), 80 (+ 30 ET if applicable)
goesStraightToPenalties: string unset, , no, yes
prizeMoney: integer (int32)
location: string
extraTime: string unset, , no, yes
scoringSystem: string , Standard (advantage), No-ad, Standard, NBL
awayGoalsAfterExtraTime: string unset, , no, yes
varRule: boolean
overtimePeriodDuration: string , 5, 10, 20, unset
overtimeType: string , RO, SO, SS
skatersOnIce: string , 3x3, 4x4, 5x5, unset
finalSetTieBreakStarts: string , 6-6, 12-12, unset
finalSetTieBreakWinnerFirst: string , 7, 10, unset
federation: string , NHL, IIHF
penaltyShootouts: string , ABAB, ABBA, unset
numberOfInnings: string , 6, 7, 9, unset
numberOfExtraInnings: string , 0, 3, unlimited, unset
extraInningsRunnerOnSecondBase: boolean

Example

{
  "sets": "integer (int32)",
  "surface": "string",
  "timezone": "string",
  "finalSet": "string",
  "association": "string",
  "awayGoalsAfterNormalTime": "string",
  "handicapRace": "boolean",
  "fixtureFormat": "string",
  "extraTimeHalfDuration": "integer (int32)",
  "roundNumber": "integer (int32)",
  "isProtected": "boolean",
  "regularHalfDuration": "integer (int32)",
  "matchDuration": "string",
  "goesStraightToPenalties": "string",
  "prizeMoney": "integer (int32)",
  "location": "string",
  "extraTime": "string",
  "scoringSystem": "string",
  "awayGoalsAfterExtraTime": "string",
  "varRule": "boolean",
  "overtimePeriodDuration": "string",
  "overtimeType": "string",
  "skatersOnIce": "string",
  "finalSetTieBreakStarts": "string",
  "finalSetTieBreakWinnerFirst": "string",
  "federation": "string",
  "penaltyShootouts": "string",
  "numberOfInnings": "string",
  "numberOfExtraInnings": "string",
  "extraInningsRunnerOnSecondBase": "boolean"
}

SeasonCompetitor: object

seasonId: integer (int64)
_links: object
curies: Curie Curie self: Link
competitor: Competitor
seasonName: string
id: integer (int64)
childrenChecked: boolean

Example

{
  "seasonId": "integer (int64)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "competitor": {
    "deleted": "boolean",
    "gender": "string",
    "_links": {
      "curies": [
        {
          "templated": "boolean",
          "name": "string",
          "href": "string"
        }
      ],
      "self": {
        "templated": "boolean",
        "href": "string"
      }
    },
    "lastUpdate": "string",
    "name": "string",
    "id": "integer (int64)",
    "updates": "integer (int64)",
    "sportId": "integer (int64)",
    "type": "string",
    "teamproperty": {
      "awayShirtSecondary": "string",
      "conference": "string",
      "toBeDecided": "boolean",
      "awayShirtPrimary": "string",
      "ageCategory": "string",
      "homePage": "string",
      "startingPitcherId": "integer (int64)",
      "shortName": "string",
      "fullDescription": "string",
      "youth": "string",
      "special": "string",
      "division": "string",
      "homeShirtSecondary": "string",
      "isProtected": "string",
      "homeShirtPrimary": "string",
      "reserve": "string",
      "comment": "string",
      "isNationalTeam": "boolean"
    },
    "playerproperty": {
      "owner": "string",
      "lastName": "string",
      "nickName": "string",
      "weight": "number",
      "fullDescription": "string",
      "dam": "string",
      "firstName": "string",
      "horseSex": "string",
      "dob": "string",
      "trainer": "string",
      "position": "string",
      "sire": "string",
      "shortName": "string",
      "height": "number",
      "status": "string",
      "hand": "string",
      "isProtected": "string"
    }
  },
  "seasonName": "string",
  "id": "integer (int64)",
  "childrenChecked": "boolean"
}

TeamProperty: object

awayShirtSecondary: string
conference: string
toBeDecided: boolean
awayShirtPrimary: string
ageCategory: string
homePage: string
startingPitcherId: integer (int64)
shortName: string
fullDescription: string
youth: string
special: string
division: string
homeShirtSecondary: string
isProtected: string
homeShirtPrimary: string
reserve: string
comment: string
isNationalTeam: boolean

Example

{
  "awayShirtSecondary": "string",
  "conference": "string",
  "toBeDecided": "boolean",
  "awayShirtPrimary": "string",
  "ageCategory": "string",
  "homePage": "string",
  "startingPitcherId": "integer (int64)",
  "shortName": "string",
  "fullDescription": "string",
  "youth": "string",
  "special": "string",
  "division": "string",
  "homeShirtSecondary": "string",
  "isProtected": "string",
  "homeShirtPrimary": "string",
  "reserve": "string",
  "comment": "string",
  "isNationalTeam": "boolean"
}

Competitors: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
competitors: Competitor Competitor

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "competitors": [
      {
        "deleted": "boolean",
        "gender": "string",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "id": "integer (int64)",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "type": "string",
        "teamproperty": {
          "awayShirtSecondary": "string",
          "conference": "string",
          "toBeDecided": "boolean",
          "awayShirtPrimary": "string",
          "ageCategory": "string",
          "homePage": "string",
          "startingPitcherId": "integer (int64)",
          "shortName": "string",
          "fullDescription": "string",
          "youth": "string",
          "special": "string",
          "division": "string",
          "homeShirtSecondary": "string",
          "isProtected": "string",
          "homeShirtPrimary": "string",
          "reserve": "string",
          "comment": "string",
          "isNationalTeam": "boolean"
        },
        "playerproperty": {
          "owner": "string",
          "lastName": "string",
          "nickName": "string",
          "weight": "number",
          "fullDescription": "string",
          "dam": "string",
          "firstName": "string",
          "horseSex": "string",
          "dob": "string",
          "trainer": "string",
          "position": "string",
          "sire": "string",
          "shortName": "string",
          "height": "number",
          "status": "string",
          "hand": "string",
          "isProtected": "string"
        }
      }
    ]
  }
}

Round: object

id: integer (int64)
name: string
sportId: integer (int64)
sportName: string
competitionId: integer (int64)
competitionName: string
seasonId: integer (int64)
seasonName: string
parentRound: integer (int64)
startDate: string
endDate: string
type: string Phase, Round, AggregateEvent: Type of round
roundproperty: RoundProperty
updates: integer (int64)
deleted: boolean: deleted entity
lastUpdate: string
_links: object
curies: Curie Curie self: Link

Example

{
  "id": "integer (int64)",
  "name": "string",
  "sportId": "integer (int64)",
  "sportName": "string",
  "competitionId": "integer (int64)",
  "competitionName": "string",
  "seasonId": "integer (int64)",
  "seasonName": "string",
  "parentRound": "integer (int64)",
  "startDate": "string",
  "endDate": "string",
  "type": "string",
  "roundproperty": {
    "sets": "integer (int32)",
    "surface": "string",
    "timezone": "string",
    "finalSet": "string",
    "association": "string",
    "awayGoalsAfterNormalTime": "string",
    "handicapRace": "boolean",
    "fixtureFormat": "string",
    "extraTimeHalfDuration": "integer (int32)",
    "roundNumber": "integer (int32)",
    "isProtected": "boolean",
    "regularHalfDuration": "integer (int32)",
    "matchDuration": "string",
    "goesStraightToPenalties": "string",
    "prizeMoney": "integer (int32)",
    "location": "string",
    "extraTime": "string",
    "scoringSystem": "string",
    "awayGoalsAfterExtraTime": "string",
    "varRule": "boolean",
    "overtimePeriodDuration": "string",
    "overtimeType": "string",
    "skatersOnIce": "string",
    "finalSetTieBreakStarts": "string",
    "finalSetTieBreakWinnerFirst": "string",
    "federation": "string",
    "penaltyShootouts": "string",
    "numberOfInnings": "string",
    "numberOfExtraInnings": "string",
    "extraInningsRunnerOnSecondBase": "boolean"
  },
  "updates": "integer (int64)",
  "deleted": "boolean",
  "lastUpdate": "string",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  }
}

Curie: object

templated: boolean
name: string
href: string

Example

{
  "templated": "boolean",
  "name": "string",
  "href": "string"
}

Fixture: object

venue: Venue
competitionId: string
statusType: string cancelled, postponed, scheduled
fixturecompetitors: FixtureCompetitor
FixtureCompetitor
_links: object
curies: Curie Curie self: Link
competitionName: string
roundName: string
fixtureproperty: FixtureProperty
type: string Match, VirtualMatch, SeasonOutright, PartialOutright, AggregateEvent: Type of fixture
updates: integer (int64)
sportId: integer (int64)
deleted: boolean: deleted entity
seasonId: integer (int64)
seasonName: string
lastUpdate: string
name: string
sportName: string
id: integer (int64)
roundId: integer (int64)
startDate: string

Example

{
  "venue": {
    "deleted": "boolean",
    "venueType": "string",
    "regionId": "integer (int64)",
    "_links": {
      "curies": [
        {
          "templated": "boolean",
          "name": "string",
          "href": "string"
        }
      ],
      "self": {
        "templated": "boolean",
        "href": "string"
      }
    },
    "lastUpdate": "string",
    "name": "string",
    "neutral": "string",
    "venueproperty": {
      "par": "string",
      "surface": "string",
      "built": "string",
      "city": "string",
      "fieldDimensions": "string",
      "latitude": "string",
      "architect": "string",
      "length": "string",
      "opened": "string",
      "capacity": "string",
      "location": "string",
      "longitude": "string",
      "constructionCost": "string"
    },
    "id": "integer (int64)",
    "updates": "integer (int64)"
  },
  "competitionId": "string",
  "statusType": "string",
  "fixturecompetitors": [
    {
      "number": "integer (int64)",
      "deleted": "boolean",
      "_links": {
        "curies": [
          {
            "templated": "boolean",
            "name": "string",
            "href": "string"
          }
        ],
        "self": {
          "templated": "boolean",
          "href": "string"
        }
      },
      "competitor": {
        "deleted": "boolean",
        "gender": "string",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "id": "integer (int64)",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "type": "string",
        "teamproperty": {
          "awayShirtSecondary": "string",
          "conference": "string",
          "toBeDecided": "boolean",
          "awayShirtPrimary": "string",
          "ageCategory": "string",
          "homePage": "string",
          "startingPitcherId": "integer (int64)",
          "shortName": "string",
          "fullDescription": "string",
          "youth": "string",
          "special": "string",
          "division": "string",
          "homeShirtSecondary": "string",
          "isProtected": "string",
          "homeShirtPrimary": "string",
          "reserve": "string",
          "comment": "string",
          "isNationalTeam": "boolean"
        },
        "playerproperty": {
          "owner": "string",
          "lastName": "string",
          "nickName": "string",
          "weight": "number",
          "fullDescription": "string",
          "dam": "string",
          "firstName": "string",
          "horseSex": "string",
          "dob": "string",
          "trainer": "string",
          "position": "string",
          "sire": "string",
          "shortName": "string",
          "height": "number",
          "status": "string",
          "hand": "string",
          "isProtected": "string"
        }
      },
      "lastUpdate": "string",
      "id": "integer (int64)",
      "updates": "integer (int64)",
      "fixturecompetitorproperty": {
        "form": "string",
        "saddleNo": "integer (int32)",
        "winnerOfEventId": "integer (int64)",
        "tackle": "string",
        "silkDescription": "string",
        "gateNo": "integer (int32)",
        "jockey": "integer (int64)",
        "weight": "integer (int64)",
        "startingPitcher": "string"
      }
    }
  ],
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "competitionName": "string",
  "roundName": "string",
  "fixtureproperty": {
    "raceType": "string",
    "regularHalfDuration": "integer (int32)",
    "distance": "string",
    "timezone": "string",
    "groundQuality": "string",
    "neutralField": "boolean",
    "awayGoalsAfterNormalTime": "string",
    "fixtureFormat": "string",
    "isProtected": "boolean",
    "unitsOfPlay": "integer (int32)",
    "bestOf": "integer (int32)",
    "bestOfNum": "integer (int32)",
    "extraTime": "string",
    "sets": "integer (int32)",
    "surface": "string",
    "hasLineups": "boolean",
    "finalSet": "string",
    "handicapRace": "boolean",
    "extraTimeHalfDuration": "integer (int32)",
    "round": "string",
    "matchDuration": "string",
    "goesStraightToPenalties": "string",
    "prizeMoney": "integer (int32)",
    "scoringSystem": "string",
    "awayGoalsAfterExtraTime": "string",
    "association": "string",
    "varRule": "boolean",
    "overtimePeriodDuration": "string",
    "overtimeType": "string",
    "skatersOnIce": "string",
    "rotationCodeHome": "string",
    "rotationCodeAway": "string",
    "finalSetTieBreakStarts": "string",
    "finalSetTieBreakWinnerFirst": "string",
    "federation": "string",
    "FirstLegId": "integer (int32)",
    "SecondLegId": "integer (int32)",
    "penaltyShootouts": "string",
    "numberOfInnings": "string",
    "numberOfExtraInnings": "string",
    "extraInningsRunnerOnSecondBase": "boolean"
  },
  "type": "string",
  "updates": "integer (int64)",
  "sportId": "integer (int64)",
  "deleted": "boolean",
  "seasonId": "integer (int64)",
  "seasonName": "string",
  "lastUpdate": "string",
  "name": "string",
  "sportName": "string",
  "id": "integer (int64)",
  "roundId": "integer (int64)",
  "startDate": "string"
}

Seasons: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
seasons: Season Season

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "seasons": [
      {
        "competitionId": "integer (int64)",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "parentSeason": "integer (int64)",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonproperty": {
          "endDate": "string",
          "timezone": "string",
          "sponsorName": "string",
          "outrightDate": "string",
          "outrightIsStart": "boolean",
          "fullDescription": "string",
          "shortName": "string",
          "startDate": "string",
          "longName": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "locked": "string"
      }
    ]
  }
}

FixtureProperty: object

raceType: string
regularHalfDuration: integer (int32)
distance: string
timezone: string
groundQuality: string
neutralField: boolean
awayGoalsAfterNormalTime: string unset, , no, yes
fixtureFormat: string , unset, NHL/AHL Non-Playoff, NHL/AHL Playoff, IIHF World Championship Non-Playoff, IIHF World Championship Playoff, IIHF World Championship Gold Medal Match, All Other Non-Playoff, All Other Playoff, Unset, One Day, Test, T20, 40/40, 49/49, Male Double, Female Double, Male Single, Female Single, Mixed Double, Team to Team, 4-Ball, Ante-post Race, Combined, Declared Race, Doubles Match, Five Day Match, Foursome, Group Outrights, Practice 1, Practice 2, Practice 3, Race 1, Race 2, Team Stage, Downhill, Giant Slalom, Parallel Slalom, Qualification, Slalom, Super Giant
isProtected: boolean
unitsOfPlay: integer (int32)
bestOf: integer (int32): How many matches are played in i.e. Playoff series
bestOfNum: integer (int32): Which match they are at in givens series, i.e. at match BestofNum 3 in a BestOf 7
extraTime: string unset, , no, yes
sets: integer (int32)
surface: string , Hard, Carpet, Clay, Wood, Grass
hasLineups: boolean
finalSet: string Tie Break, Match Tie Break, Advantage
handicapRace: boolean
extraTimeHalfDuration: integer (int32)
round: string: i.e. Week X in NFL, or Round X in EPL. Can be "Final", "Semi-Final" , 1 ,2 3 etc
matchDuration: string , 90 (+ 30 ET if applicable), 80 (+ 20 ET if applicable), 80 (+ 30 ET if applicable)
goesStraightToPenalties: string unset, , no, yes
prizeMoney: integer (int32)
scoringSystem: string , Standard (advantage), No-ad, Standard, NBL
awayGoalsAfterExtraTime: string unset, , no, yes
association: string FIBA, NBA, NCAA, NotSupported, PBA, unset,
varRule: boolean
overtimePeriodDuration: string , 5, 10, 20, unset
overtimeType: string , RO, SO, SS
skatersOnIce: string , 3x3, 4x4, 5x5, unset
rotationCodeHome: string
rotationCodeAway: string
finalSetTieBreakStarts: string , 6-6, 12-12, unset
finalSetTieBreakWinnerFirst: string , 7, 10, unset
federation: string , NHL, IIHF
FirstLegId: integer (int32)
SecondLegId: integer (int32)
penaltyShootouts: string , ABAB, ABBA, unset
numberOfInnings: string , 6, 7, 9, unset
numberOfExtraInnings: string , 0, 3, unlimited, unset
extraInningsRunnerOnSecondBase: boolean

Example

{
  "raceType": "string",
  "regularHalfDuration": "integer (int32)",
  "distance": "string",
  "timezone": "string",
  "groundQuality": "string",
  "neutralField": "boolean",
  "awayGoalsAfterNormalTime": "string",
  "fixtureFormat": "string",
  "isProtected": "boolean",
  "unitsOfPlay": "integer (int32)",
  "bestOf": "integer (int32)",
  "bestOfNum": "integer (int32)",
  "extraTime": "string",
  "sets": "integer (int32)",
  "surface": "string",
  "hasLineups": "boolean",
  "finalSet": "string",
  "handicapRace": "boolean",
  "extraTimeHalfDuration": "integer (int32)",
  "round": "string",
  "matchDuration": "string",
  "goesStraightToPenalties": "string",
  "prizeMoney": "integer (int32)",
  "scoringSystem": "string",
  "awayGoalsAfterExtraTime": "string",
  "association": "string",
  "varRule": "boolean",
  "overtimePeriodDuration": "string",
  "overtimeType": "string",
  "skatersOnIce": "string",
  "rotationCodeHome": "string",
  "rotationCodeAway": "string",
  "finalSetTieBreakStarts": "string",
  "finalSetTieBreakWinnerFirst": "string",
  "federation": "string",
  "FirstLegId": "integer (int32)",
  "SecondLegId": "integer (int32)",
  "penaltyShootouts": "string",
  "numberOfInnings": "string",
  "numberOfExtraInnings": "string",
  "extraInningsRunnerOnSecondBase": "boolean"
}

Season: object

competitionId: integer (int64)
_links: object
curies: Curie Curie self: Link
competitionName: string
parentSeason: integer (int64)
updates: integer (int64)
sportId: integer (int64)
deleted: boolean: deleted entity
seasonproperty: SeasonProperty
lastUpdate: string
name: string
sportName: string
id: integer (int64)
locked: string none, yes, no: locked against changes - do we need this?

Example

{
  "competitionId": "integer (int64)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "competitionName": "string",
  "parentSeason": "integer (int64)",
  "updates": "integer (int64)",
  "sportId": "integer (int64)",
  "deleted": "boolean",
  "seasonproperty": {
    "endDate": "string",
    "timezone": "string",
    "sponsorName": "string",
    "outrightDate": "string",
    "outrightIsStart": "boolean",
    "fullDescription": "string",
    "shortName": "string",
    "startDate": "string",
    "longName": "string",
    "extraInningsRunnerOnSecondBase": "boolean"
  },
  "lastUpdate": "string",
  "name": "string",
  "sportName": "string",
  "id": "integer (int64)",
  "locked": "string"
}

Contracts: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
contracts: Contract Contract

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "contracts": [
      {
        "role": "string",
        "shirtNumber": "string",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitor": {
          "deleted": "boolean",
          "gender": "string",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "id": "integer (int64)",
          "updates": "integer (int64)",
          "sportId": "integer (int64)",
          "type": "string",
          "teamproperty": {
            "awayShirtSecondary": "string",
            "conference": "string",
            "toBeDecided": "boolean",
            "awayShirtPrimary": "string",
            "ageCategory": "string",
            "homePage": "string",
            "startingPitcherId": "integer (int64)",
            "shortName": "string",
            "fullDescription": "string",
            "youth": "string",
            "special": "string",
            "division": "string",
            "homeShirtSecondary": "string",
            "isProtected": "string",
            "homeShirtPrimary": "string",
            "reserve": "string",
            "comment": "string",
            "isNationalTeam": "boolean"
          },
          "playerproperty": {
            "owner": "string",
            "lastName": "string",
            "nickName": "string",
            "weight": "number",
            "fullDescription": "string",
            "dam": "string",
            "firstName": "string",
            "horseSex": "string",
            "dob": "string",
            "trainer": "string",
            "position": "string",
            "sire": "string",
            "shortName": "string",
            "height": "number",
            "status": "string",
            "hand": "string",
            "isProtected": "string"
          }
        },
        "dateTo": "string",
        "id": "integer (int64)",
        "type": "string",
        "dateFrom": "string",
        "active": "boolean"
      }
    ]
  }
}

Sports: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
sports: Sport Sport

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "sports": [
      {
        "deleted": "boolean",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "id": "integer (int64)",
        "sportproperty": {
          "needsUnitsOfPlay": "boolean",
          "recreateEventsThreshold": "integer (int32)"
        },
        "updates": "integer (int64)"
      }
    ]
  }
}

FixtureCompetitorProperty: object

form: string
saddleNo: integer (int32)
winnerOfEventId: integer (int64)
tackle: string
silkDescription: string
gateNo: integer (int32)
jockey: integer (int64)
weight: integer (int64)
startingPitcher: string , yes, no

Example

{
  "form": "string",
  "saddleNo": "integer (int32)",
  "winnerOfEventId": "integer (int64)",
  "tackle": "string",
  "silkDescription": "string",
  "gateNo": "integer (int32)",
  "jockey": "integer (int64)",
  "weight": "integer (int64)",
  "startingPitcher": "string"
}

Venue: object

deleted: boolean: deleted entity
venueType: string Stadium, Sport Hall, Golf course, Circuit: type of venue
regionId: integer (int64)
_links: object
curies: Curie Curie self: Link
lastUpdate: string
name: string
neutral: string no, yes: is the venue neutral ground
venueproperty: VenueProperty
id: integer (int64)
updates: integer (int64)

Example

{
  "deleted": "boolean",
  "venueType": "string",
  "regionId": "integer (int64)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "lastUpdate": "string",
  "name": "string",
  "neutral": "string",
  "venueproperty": {
    "par": "string",
    "surface": "string",
    "built": "string",
    "city": "string",
    "fieldDimensions": "string",
    "latitude": "string",
    "architect": "string",
    "length": "string",
    "opened": "string",
    "capacity": "string",
    "location": "string",
    "longitude": "string",
    "constructionCost": "string"
  },
  "id": "integer (int64)",
  "updates": "integer (int64)"
}

Error: object

reason: string
domain: string
locationType: string
location: string
message: string

Example

{
  "reason": "string",
  "domain": "string",
  "locationType": "string",
  "location": "string",
  "message": "string"
}

Regions: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
regions: Region Region

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "regions": [
      {
        "deleted": "boolean",
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "typeName": "string",
        "id": "integer (int64)",
        "updates": "integer (int64)"
      }
    ]
  }
}

CompetitionProperty: object

sets: integer (int32)
surface: string , Hard, Carpet, Clay, Wood, Grass
finalSet: string Tie Break, Match Tie Break, Advantage
sponsorName: string
competitionType: string , Doubles Cup, Player Cup, Team Cup, League, Long Term, Special Betting Markets, Long Term Special Betting Markets, Race, Specials, Tournament, Team Race, Team Stage Race, Team Lap Race, One Day, Twenty20, 4 Day Test, Cricket Test, Single Day Horse Meeting, Multi-day Horse Meeting, Golf Match Play, Golf Regular Play
association: string FIBA, NBA, NCAA, NotSupported, PBA, unset
isTour: boolean
awayGoalsAfterNormalTime: string , unset, no, yes
handicapRace: boolean
defaultTimeZone: string
fixtureFormat: string , NHL/AHL Non-Playoff, NHL/AHL Playoff, IIHF World Championship Non-Playoff, IIHF World Championship Playoff, IIHF World Championship Gold Medal Match, All Other Non-Playoff, All Other Playoff, unset
isProtected: boolean
regionId: integer (int64)
matchDuration: string , 90 (+ 30 ET if applicable), 80 (+ 20 ET if applicable), 80 (+ 30 ET if applicable)
goesStraightToPenalties: string , unset, no, yes
prizeMoney: integer (int32)
currency: string: ISO 4217 currency code
location: string
extraTime: string , unset, no, yes
scoringSystem: string , Standard (advantage), No-ad, Standard, NBL
shortName: string
awayGoalsAfterExtraTime: string , unset, no, yes
longName: string
varRule: boolean
usesTBDTeams: boolean
regularHalfDuration: integer (int32)
extraTimeHalfDuration: integer (int32)
overtimePeriodDuration: string , 5, 10, 20, unset
overtimeType: string , RO, SO, SS
skatersOnIce: string , 3x3, 4x4, 5x5, unset
finalSetTieBreakStarts: string , 6-6, 12-12, unset
finalSetTieBreakWinnerFirst: string , 7, 10, unset
federation: string , NHL, IIHF
penaltyShootouts: string , ABAB, ABBA, unset
numberOfInnings: string , 6, 7, 9, unset
numberOfExtraInnings: string , 0, 3, unlimited, unset
extraInningsRunnerOnSecondBase: boolean

Example

{
  "sets": "integer (int32)",
  "surface": "string",
  "finalSet": "string",
  "sponsorName": "string",
  "competitionType": "string",
  "association": "string",
  "isTour": "boolean",
  "awayGoalsAfterNormalTime": "string",
  "handicapRace": "boolean",
  "defaultTimeZone": "string",
  "fixtureFormat": "string",
  "isProtected": "boolean",
  "regionId": "integer (int64)",
  "matchDuration": "string",
  "goesStraightToPenalties": "string",
  "prizeMoney": "integer (int32)",
  "currency": "string",
  "location": "string",
  "extraTime": "string",
  "scoringSystem": "string",
  "shortName": "string",
  "awayGoalsAfterExtraTime": "string",
  "longName": "string",
  "varRule": "boolean",
  "usesTBDTeams": "boolean",
  "regularHalfDuration": "integer (int32)",
  "extraTimeHalfDuration": "integer (int32)",
  "overtimePeriodDuration": "string",
  "overtimeType": "string",
  "skatersOnIce": "string",
  "finalSetTieBreakStarts": "string",
  "finalSetTieBreakWinnerFirst": "string",
  "federation": "string",
  "penaltyShootouts": "string",
  "numberOfInnings": "string",
  "numberOfExtraInnings": "string",
  "extraInningsRunnerOnSecondBase": "boolean"
}

PlayerProperty: object

owner: string
lastName: string
nickName: string
weight: number
fullDescription: string
dam: string
firstName: string
horseSex: string
dob: string
trainer: string
position: string
sire: string
shortName: string
height: number
status: string active, retired, unattached
hand: string NA, right, left
isProtected: string

Example

{
  "owner": "string",
  "lastName": "string",
  "nickName": "string",
  "weight": "number",
  "fullDescription": "string",
  "dam": "string",
  "firstName": "string",
  "horseSex": "string",
  "dob": "string",
  "trainer": "string",
  "position": "string",
  "sire": "string",
  "shortName": "string",
  "height": "number",
  "status": "string",
  "hand": "string",
  "isProtected": "string"
}

Errors: object

errors: Error
Error

Example

{
  "errors": [
    {
      "reason": "string",
      "domain": "string",
      "locationType": "string",
      "location": "string",
      "message": "string"
    }
  ]
}

RoundCompetitor: object

_links: object
curies: Curie Curie self: Link
competitor: Competitor
roundName: string
id: integer (int64)
roundId: integer (int64)

Example

{
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "competitor": {
    "deleted": "boolean",
    "gender": "string",
    "_links": {
      "curies": [
        {
          "templated": "boolean",
          "name": "string",
          "href": "string"
        }
      ],
      "self": {
        "templated": "boolean",
        "href": "string"
      }
    },
    "lastUpdate": "string",
    "name": "string",
    "id": "integer (int64)",
    "updates": "integer (int64)",
    "sportId": "integer (int64)",
    "type": "string",
    "teamproperty": {
      "awayShirtSecondary": "string",
      "conference": "string",
      "toBeDecided": "boolean",
      "awayShirtPrimary": "string",
      "ageCategory": "string",
      "homePage": "string",
      "startingPitcherId": "integer (int64)",
      "shortName": "string",
      "fullDescription": "string",
      "youth": "string",
      "special": "string",
      "division": "string",
      "homeShirtSecondary": "string",
      "isProtected": "string",
      "homeShirtPrimary": "string",
      "reserve": "string",
      "comment": "string",
      "isNationalTeam": "boolean"
    },
    "playerproperty": {
      "owner": "string",
      "lastName": "string",
      "nickName": "string",
      "weight": "number",
      "fullDescription": "string",
      "dam": "string",
      "firstName": "string",
      "horseSex": "string",
      "dob": "string",
      "trainer": "string",
      "position": "string",
      "sire": "string",
      "shortName": "string",
      "height": "number",
      "status": "string",
      "hand": "string",
      "isProtected": "string"
    }
  },
  "roundName": "string",
  "id": "integer (int64)",
  "roundId": "integer (int64)"
}

SportProperty: object

needsUnitsOfPlay: boolean
recreateEventsThreshold: integer (int32)

Example

{
  "needsUnitsOfPlay": "boolean",
  "recreateEventsThreshold": "integer (int32)"
}

Competitions: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
competitions: Competition Competition

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "competitions": [
      {
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "gender": "string",
        "competitionproperty": {
          "sets": "integer (int32)",
          "surface": "string",
          "finalSet": "string",
          "sponsorName": "string",
          "competitionType": "string",
          "association": "string",
          "isTour": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "handicapRace": "boolean",
          "defaultTimeZone": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "regionId": "integer (int64)",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "currency": "string",
          "location": "string",
          "extraTime": "string",
          "scoringSystem": "string",
          "shortName": "string",
          "awayGoalsAfterExtraTime": "string",
          "longName": "string",
          "varRule": "boolean",
          "usesTBDTeams": "boolean",
          "regularHalfDuration": "integer (int32)",
          "extraTimeHalfDuration": "integer (int32)",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "updates": "integer (int64)"
      }
    ]
  }
}

Fixtures: object

total: integer (int32)
_links: object
curies: Curie Curie self: Link
_embedded: object
fixtures: Fixture Fixture

Example

{
  "total": "integer (int32)",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "_embedded": {
    "fixtures": [
      {
        "venue": {
          "deleted": "boolean",
          "venueType": "string",
          "regionId": "integer (int64)",
          "_links": {
            "curies": [
              {
                "templated": "boolean",
                "name": "string",
                "href": "string"
              }
            ],
            "self": {
              "templated": "boolean",
              "href": "string"
            }
          },
          "lastUpdate": "string",
          "name": "string",
          "neutral": "string",
          "venueproperty": {
            "par": "string",
            "surface": "string",
            "built": "string",
            "city": "string",
            "fieldDimensions": "string",
            "latitude": "string",
            "architect": "string",
            "length": "string",
            "opened": "string",
            "capacity": "string",
            "location": "string",
            "longitude": "string",
            "constructionCost": "string"
          },
          "id": "integer (int64)",
          "updates": "integer (int64)"
        },
        "competitionId": "string",
        "statusType": "string",
        "fixturecompetitors": [
          {
            "number": "integer (int64)",
            "deleted": "boolean",
            "_links": {
              "curies": [
                {
                  "templated": "boolean",
                  "name": "string",
                  "href": "string"
                }
              ],
              "self": {
                "templated": "boolean",
                "href": "string"
              }
            },
            "competitor": {
              "deleted": "boolean",
              "gender": "string",
              "_links": {
                "curies": [
                  {
                    "templated": "boolean",
                    "name": "string",
                    "href": "string"
                  }
                ],
                "self": {
                  "templated": "boolean",
                  "href": "string"
                }
              },
              "lastUpdate": "string",
              "name": "string",
              "id": "integer (int64)",
              "updates": "integer (int64)",
              "sportId": "integer (int64)",
              "type": "string",
              "teamproperty": {
                "awayShirtSecondary": "string",
                "conference": "string",
                "toBeDecided": "boolean",
                "awayShirtPrimary": "string",
                "ageCategory": "string",
                "homePage": "string",
                "startingPitcherId": "integer (int64)",
                "shortName": "string",
                "fullDescription": "string",
                "youth": "string",
                "special": "string",
                "division": "string",
                "homeShirtSecondary": "string",
                "isProtected": "string",
                "homeShirtPrimary": "string",
                "reserve": "string",
                "comment": "string",
                "isNationalTeam": "boolean"
              },
              "playerproperty": {
                "owner": "string",
                "lastName": "string",
                "nickName": "string",
                "weight": "number",
                "fullDescription": "string",
                "dam": "string",
                "firstName": "string",
                "horseSex": "string",
                "dob": "string",
                "trainer": "string",
                "position": "string",
                "sire": "string",
                "shortName": "string",
                "height": "number",
                "status": "string",
                "hand": "string",
                "isProtected": "string"
              }
            },
            "lastUpdate": "string",
            "id": "integer (int64)",
            "updates": "integer (int64)",
            "fixturecompetitorproperty": {
              "form": "string",
              "saddleNo": "integer (int32)",
              "winnerOfEventId": "integer (int64)",
              "tackle": "string",
              "silkDescription": "string",
              "gateNo": "integer (int32)",
              "jockey": "integer (int64)",
              "weight": "integer (int64)",
              "startingPitcher": "string"
            }
          }
        ],
        "_links": {
          "curies": [
            {
              "templated": "boolean",
              "name": "string",
              "href": "string"
            }
          ],
          "self": {
            "templated": "boolean",
            "href": "string"
          }
        },
        "competitionName": "string",
        "roundName": "string",
        "fixtureproperty": {
          "raceType": "string",
          "regularHalfDuration": "integer (int32)",
          "distance": "string",
          "timezone": "string",
          "groundQuality": "string",
          "neutralField": "boolean",
          "awayGoalsAfterNormalTime": "string",
          "fixtureFormat": "string",
          "isProtected": "boolean",
          "unitsOfPlay": "integer (int32)",
          "bestOf": "integer (int32)",
          "bestOfNum": "integer (int32)",
          "extraTime": "string",
          "sets": "integer (int32)",
          "surface": "string",
          "hasLineups": "boolean",
          "finalSet": "string",
          "handicapRace": "boolean",
          "extraTimeHalfDuration": "integer (int32)",
          "round": "string",
          "matchDuration": "string",
          "goesStraightToPenalties": "string",
          "prizeMoney": "integer (int32)",
          "scoringSystem": "string",
          "awayGoalsAfterExtraTime": "string",
          "association": "string",
          "varRule": "boolean",
          "overtimePeriodDuration": "string",
          "overtimeType": "string",
          "skatersOnIce": "string",
          "rotationCodeHome": "string",
          "rotationCodeAway": "string",
          "finalSetTieBreakStarts": "string",
          "finalSetTieBreakWinnerFirst": "string",
          "federation": "string",
          "FirstLegId": "integer (int32)",
          "SecondLegId": "integer (int32)",
          "penaltyShootouts": "string",
          "numberOfInnings": "string",
          "numberOfExtraInnings": "string",
          "extraInningsRunnerOnSecondBase": "boolean"
        },
        "type": "string",
        "updates": "integer (int64)",
        "sportId": "integer (int64)",
        "deleted": "boolean",
        "seasonId": "integer (int64)",
        "seasonName": "string",
        "lastUpdate": "string",
        "name": "string",
        "sportName": "string",
        "id": "integer (int64)",
        "roundId": "integer (int64)",
        "startDate": "string"
      }
    ]
  }
}

SeasonProperty: object

endDate: string
timezone: string
sponsorName: string
outrightDate: string
outrightIsStart: boolean
fullDescription: string
shortName: string
startDate: string
longName: string
extraInningsRunnerOnSecondBase: boolean

Example

{
  "endDate": "string",
  "timezone": "string",
  "sponsorName": "string",
  "outrightDate": "string",
  "outrightIsStart": "boolean",
  "fullDescription": "string",
  "shortName": "string",
  "startDate": "string",
  "longName": "string",
  "extraInningsRunnerOnSecondBase": "boolean"
}

ErrorModel: object

code: integer (int32)
message: string
error: Errors

Example

{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "errors": [
      {
        "reason": "string",
        "domain": "string",
        "locationType": "string",
        "location": "string",
        "message": "string"
      }
    ]
  }
}

Region: object

deleted: boolean: deleted entity
_links: object
curies: Curie Curie self: Link
lastUpdate: string
name: string
typeName: string Country, Continent, Constituent Country, First-Order Administrative Region, Non-Geographic, World
id: integer (int64)
updates: integer (int64)

Example

{
  "deleted": "boolean",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "lastUpdate": "string",
  "name": "string",
  "typeName": "string",
  "id": "integer (int64)",
  "updates": "integer (int64)"
}

Contract: object

role: string pitcher
shirtNumber: string
_links: object
curies: Curie Curie self: Link
competitor: Competitor
dateTo: string
id: integer (int64)
type: string Plays For, Plays For (Doubles), Owned By, Partnership, Trained By
dateFrom: string
active: boolean

Example

{
  "role": "string",
  "shirtNumber": "string",
  "_links": {
    "curies": [
      {
        "templated": "boolean",
        "name": "string",
        "href": "string"
      }
    ],
    "self": {
      "templated": "boolean",
      "href": "string"
    }
  },
  "competitor": {
    "deleted": "boolean",
    "gender": "string",
    "_links": {
      "curies": [
        {
          "templated": "boolean",
          "name": "string",
          "href": "string"
        }
      ],
      "self": {
        "templated": "boolean",
        "href": "string"
      }
    },
    "lastUpdate": "string",
    "name": "string",
    "id": "integer (int64)",
    "updates": "integer (int64)",
    "sportId": "integer (int64)",
    "type": "string",
    "teamproperty": {
      "awayShirtSecondary": "string",
      "conference": "string",
      "toBeDecided": "boolean",
      "awayShirtPrimary": "string",
      "ageCategory": "string",
      "homePage": "string",
      "startingPitcherId": "integer (int64)",
      "shortName": "string",
      "fullDescription": "string",
      "youth": "string",
      "special": "string",
      "division": "string",
      "homeShirtSecondary": "string",
      "isProtected": "string",
      "homeShirtPrimary": "string",
      "reserve": "string",
      "comment": "string",
      "isNationalTeam": "boolean"
    },
    "playerproperty": {
      "owner": "string",
      "lastName": "string",
      "nickName": "string",
      "weight": "number",
      "fullDescription": "string",
      "dam": "string",
      "firstName": "string",
      "horseSex": "string",
      "dob": "string",
      "trainer": "string",
      "position": "string",
      "sire": "string",
      "shortName": "string",
      "height": "number",
      "status": "string",
      "hand": "string",
      "isProtected": "string"
    }
  },
  "dateTo": "string",
  "id": "integer (int64)",
  "type": "string",
  "dateFrom": "string",
  "active": "boolean"
}

Link: object

templated: boolean
href: string

Example

{
  "templated": "boolean",
  "href": "string"
}

Documentation by Spectacle