Head to head Matches

List of Matches that are played against two teams in a competition

Match History for head-to-head of two teams

get
/badminton/o/{organizationId}/competitions/{competitionId}/headToHead/fixtures/entities/{entityId1}/{entityId2}

Return the Matches for a two specific teams in a competition.

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
competitionIdstring · uuidRequired

The unique identifier of the competition

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
entityId1string · uuidRequired

The unique identifier of the entitiy

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
entityId2string · uuidRequired

The unique identifier of the entitiy

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
fromTimeLocalstring · date-timeOptional

Where match start time (in local time) >= this value

Example: 2018-08-16T18:00:00
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
seasonIdstring · uuidOptional

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
statusstring · enum · max: 200Optional

Fixture status. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
statusNotstring · enum · max: 200Optional

Fixture status to not include. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
toTimeLocalstring · date-timeOptional

Where match start time (in local time) <= this value

Example: 2018-08-16T18:00:00
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
Responses
200

Successful operation

application/json
get
/badminton/o/{organizationId}/competitions/{competitionId}/headToHead/fixtures/entities/{entityId1}/{entityId2}
GET /v1/badminton/o/{organizationId}/competitions/{competitionId}/headToHead/fixtures/entities/{entityId1}/{entityId2} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "competition": {
        "resourceType": "competitions",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      }
    }
  ]
}

Match History for head-to-head of two teams across multiple seasons or competitions

get
/badminton/o/{organizationId}/headToHead/fixtures/persons/{personId1}/{personId2}

Return the Matches for a two specific teams in multiple seasons or competitions.

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
personId1string · uuidRequired

The unique identifier of the person

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
personId2string · uuidRequired

The unique identifier of the person

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
competitionIdsstring · uuidOptional

The unique identifiers of the competitions (comma-delimited).

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc,de83c6a8-3b29-11eb-bdb7-0242ac130005
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
fromTimeLocalstring · date-timeOptional

Where match start time (in local time) >= this value

Example: 2018-08-16T18:00:00
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
seasonIdstring · uuidOptional

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seasonIdsstring · uuidOptional

The unique identifiers of the seasons (comma-delimited).

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc,de83c6a8-3b29-11eb-bdb7-0242ac130005
statusstring · enum · max: 200Optional

Fixture status. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
statusNotstring · enum · max: 200Optional

Fixture status to not include. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
toTimeLocalstring · date-timeOptional

Where match start time (in local time) <= this value

Example: 2018-08-16T18:00:00
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
Responses
200

Successful operation

application/json
get
/badminton/o/{organizationId}/headToHead/fixtures/persons/{personId1}/{personId2}
GET /v1/badminton/o/{organizationId}/headToHead/fixtures/persons/{personId1}/{personId2} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "competition": {
        "resourceType": "competitions",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      }
    }
  ]
}

Last updated

Was this helpful?