📢 The Ask AI can now translate any part of the docs to your preferred language!
Read the guide
sportradar.comSportradar Support Portal

Competitions

Competition is a grouping of seasons that generally involve the same competitors. Competitions can have a history of many years, or be a once off.

The competition is owned by the organization, but, many competitions can be grouped together to form a league.

Get a list of competitions

get
/basketball/o/{organizationId}/competitions

Return a list of available 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
Query parameters
addedstring · date-timeOptional

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

Example: 2018-08-16T02:10:48
ageGroupstring · enumOptional

The age group of the season

  • JUNIOR Junior
  • MASTERS Masters
  • SENIOR Senior
  • UNDER_15 Under 15
  • UNDER_16 Under 16
  • UNDER_17 Under 17
  • UNDER_18 Under 18
  • UNDER_19 Under 19
  • UNDER_20 Under 20
  • UNDER_21 Under 21
  • UNDER_22 Under 22
  • UNDER_23 Under 23
  • YOUTH Youth
Example: SENIORPossible values:
competitionIdstringOptional

The unique identifier of the competition. Can specify multiple, delimited by comma.

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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)]
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
nameLatinContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLatin=David Johnson nameLatinContains=Dav will match nameLatinContains=John will match nameLatinContains=son will not match

Example: Dav and nameLatin='David Johnson'
nameLocalContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLocal=David Johnson nameLocalContains=Dav will match nameLocalContains=John will match nameLocalContains=son will not match

Example: Dav and nameLocal='David Johnson'
offsetinteger · int32Optional

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

Example: 10
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: -nameLocal,nameLatinPattern: ^(\-?nameLocal|\-?nameLatin|,)*$
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
/basketball/o/{organizationId}/competitions
GET /v1/basketball/o/{organizationId}/competitions 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": [
    {
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "league": {
        "resourceType": "leagues",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "internationalReference": "CA3243-3",
      "abbreviationLocal": "NFA",
      "nameLocal": "Test name local",
      "eventType": "FIXTURE",
      "abbreviationLatin": "NFA",
      "nameLatin": "Test name latin ",
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "externalId": "A123",
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameLocal": "text",
          "nameLatin": "text",
          "abbreviationLocal": "text",
          "abbreviationLatin": "text"
        }
      ],
      "updated": "2025-11-19T06:12:00.950Z",
      "added": "2025-11-19T06:12:00.950Z",
      "ageGroup": "SENIOR",
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T06:12:00.950Z",
          "added": "2025-11-19T06:12:00.950Z"
        }
      ]
    }
  ]
}

Create a competition

post
/basketball/o/{organizationId}/competitions

Insert a new competition

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
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
Query parameters
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)]
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
Body
competitionIdstring · uuidOptional

The unique identifier of the competition

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

The unique identifier of the league

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
internationalReferencestring | nullableOptional

The international reference for this competition given by the sport governing body

Example: CA3243-3
abbreviationLocalstring | nullableOptional

An abbreviation/short name in the local language

Example: NFA
nameLocalstring · max: 150Required

The name of the competition in the local language

Example: Test name local
eventTypestring · enum · max: 30Optional

Primary Type of Matches

  • FIXTURE Fixture
  • PRACTICE Practice
Default: FIXTUREExample: FIXTUREPossible values:
abbreviationLatinstring | nullableOptional

An abbreviation/short name in latin characters

Example: NFA
nameLatinstring | nullableOptional

The name of the competition in latin characters

Example: Test name latin
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
ageGroupstring · enum | nullableOptional

The age group of the competition

  • None None
  • JUNIOR Junior
  • MASTERS Masters
  • SENIOR Senior
  • UNDER_15 Under 15
  • UNDER_16 Under 16
  • UNDER_17 Under 17
  • UNDER_18 Under 18
  • UNDER_19 Under 19
  • UNDER_20 Under 20
  • UNDER_21 Under 21
  • UNDER_22 Under 22
  • UNDER_23 Under 23
  • YOUTH Youth
Example: SENIORPossible values:
Responses
200

Successful operation

application/json
post
/basketball/o/{organizationId}/competitions
POST /v1/basketball/o/{organizationId}/competitions HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 715

{
  "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "internationalReference": "CA3243-3",
  "abbreviationLocal": "NFA",
  "nameLocal": "Test name local",
  "eventType": "FIXTURE",
  "abbreviationLatin": "NFA",
  "nameLatin": "Test name latin ",
  "social": {
    "website": "http://www.example.com",
    "facebook": "https://www.facebook.com/example",
    "twitter": "https://www.twitter.com/example",
    "wikipedia": "https://en.wikipedia.org/wiki/example",
    "instagram": "https://www.instagram.com/example"
  },
  "externalId": "A123",
  "historicalNames": [
    {
      "dateStart": "2025-11-19",
      "dateEnd": "2025-11-19",
      "nameLocal": "text",
      "nameLatin": "text",
      "abbreviationLocal": "text",
      "abbreviationLatin": "text"
    }
  ],
  "ageGroup": "SENIOR"
}
{
  "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": [
    {
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "league": {
        "resourceType": "leagues",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "internationalReference": "CA3243-3",
      "abbreviationLocal": "NFA",
      "nameLocal": "Test name local",
      "eventType": "FIXTURE",
      "abbreviationLatin": "NFA",
      "nameLatin": "Test name latin ",
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "externalId": "A123",
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameLocal": "text",
          "nameLatin": "text",
          "abbreviationLocal": "text",
          "abbreviationLatin": "text"
        }
      ],
      "updated": "2025-11-19T06:12:00.950Z",
      "added": "2025-11-19T06:12:00.950Z",
      "ageGroup": "SENIOR",
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T06:12:00.950Z",
          "added": "2025-11-19T06:12:00.950Z"
        }
      ]
    }
  ]
}

Get a list of competitions that have active seasons

get
/basketball/o/{organizationId}/competitions/seasonStatus

Return a list of available competitions that have active seasons

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
Query parameters
addedstring · date-timeOptional

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

Example: 2018-08-16T02:10:48
ageGroupstring · enumOptional

The age group of the season

  • JUNIOR Junior
  • MASTERS Masters
  • SENIOR Senior
  • UNDER_15 Under 15
  • UNDER_16 Under 16
  • UNDER_17 Under 17
  • UNDER_18 Under 18
  • UNDER_19 Under 19
  • UNDER_20 Under 20
  • UNDER_21 Under 21
  • UNDER_22 Under 22
  • UNDER_23 Under 23
  • YOUTH Youth
Example: SENIORPossible values:
compSeasonUpdatedstring · date-timeOptional

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

Example: 2018-08-16T02:11:48
competitionIdstringOptional

The unique identifier of the competition. Can specify multiple, delimited by comma.

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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)]
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
seasonStatusstring · enumOptional

Status

  • ACTIVE Active
  • COMPLETE Complete
  • DRAFT Draft
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
seasonUpdatedstring · date-timeOptional

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

Example: 2018-08-16T02:11:48
seasonVideoProductionstring · enum · max: 50Optional

Seasons data synchronization strategy with video production systems. Multiple allowed (comma-delimited).

  • AUTOMATED Automated
  • MANUAL Manual
  • NONE None
Example: NONE,AUTOMATEDPossible values:
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
/basketball/o/{organizationId}/competitions/seasonStatus
GET /v1/basketball/o/{organizationId}/competitions/seasonStatus 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": [
    {
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "league": {
        "resourceType": "leagues",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "internationalReference": "CA3243-3",
      "abbreviationLocal": "NFA",
      "nameLocal": "Test name local",
      "eventType": "FIXTURE",
      "abbreviationLatin": "NFA",
      "nameLatin": "Test name latin ",
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "externalId": "A123",
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameLocal": "text",
          "nameLatin": "text",
          "abbreviationLocal": "text",
          "abbreviationLatin": "text"
        }
      ],
      "updated": "2025-11-19T06:12:00.950Z",
      "added": "2025-11-19T06:12:00.950Z",
      "ageGroup": "SENIOR",
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T06:12:00.950Z",
          "added": "2025-11-19T06:12:00.950Z"
        }
      ]
    }
  ]
}

Get a list of competitions by for a league

get
/basketball/o/{organizationId}/leagues/{leagueId}/competitions

Return a list of available competitions for a specific league

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
leagueIdstring · uuidRequired

The unique identifier of the league

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
ageGroupstring · enumOptional

The age group of the season

  • JUNIOR Junior
  • MASTERS Masters
  • SENIOR Senior
  • UNDER_15 Under 15
  • UNDER_16 Under 16
  • UNDER_17 Under 17
  • UNDER_18 Under 18
  • UNDER_19 Under 19
  • UNDER_20 Under 20
  • UNDER_21 Under 21
  • UNDER_22 Under 22
  • UNDER_23 Under 23
  • YOUTH Youth
Example: SENIORPossible values:
competitionIdstringOptional

The unique identifier of the competition. Can specify multiple, delimited by comma.

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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)]
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
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
/basketball/o/{organizationId}/leagues/{leagueId}/competitions
GET /v1/basketball/o/{organizationId}/leagues/{leagueId}/competitions 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": [
    {
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "league": {
        "resourceType": "leagues",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "internationalReference": "CA3243-3",
      "abbreviationLocal": "NFA",
      "nameLocal": "Test name local",
      "eventType": "FIXTURE",
      "abbreviationLatin": "NFA",
      "nameLatin": "Test name latin ",
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "externalId": "A123",
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameLocal": "text",
          "nameLatin": "text",
          "abbreviationLocal": "text",
          "abbreviationLatin": "text"
        }
      ],
      "updated": "2025-11-19T06:12:00.950Z",
      "added": "2025-11-19T06:12:00.950Z",
      "ageGroup": "SENIOR",
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T06:12:00.950Z",
          "added": "2025-11-19T06:12:00.950Z"
        }
      ]
    }
  ]
}

Get a competition

get
/basketball/o/{organizationId}/competitions/{competitionId}

Return detailed information about 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
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
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)]
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
Responses
200

Successful operation

application/json
get
/basketball/o/{organizationId}/competitions/{competitionId}
GET /v1/basketball/o/{organizationId}/competitions/{competitionId} 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": [
    {
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "league": {
        "resourceType": "leagues",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "internationalReference": "CA3243-3",
      "abbreviationLocal": "NFA",
      "nameLocal": "Test name local",
      "eventType": "FIXTURE",
      "abbreviationLatin": "NFA",
      "nameLatin": "Test name latin ",
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "externalId": "A123",
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameLocal": "text",
          "nameLatin": "text",
          "abbreviationLocal": "text",
          "abbreviationLatin": "text"
        }
      ],
      "updated": "2025-11-19T06:12:00.950Z",
      "added": "2025-11-19T06:12:00.950Z",
      "ageGroup": "SENIOR",
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T06:12:00.950Z",
          "added": "2025-11-19T06:12:00.950Z"
        }
      ]
    }
  ]
}

Update a competition

put
/basketball/o/{organizationId}/competitions/{competitionId}

Change the information of a specific competition

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
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
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
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)]
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
Body
leagueIdstring · uuidOptional

The unique identifier of the league

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
internationalReferencestring | nullableOptional

The international reference for this competition given by the sport governing body

Example: CA3243-3
abbreviationLocalstring | nullableOptional

An abbreviation/short name in the local language

Example: NFA
nameLocalstring · max: 150Optional

The name of the competition in the local language

Example: Test name local
eventTypestring · enum · max: 30Optional

Primary Type of Matches

  • FIXTURE Fixture
  • PRACTICE Practice
Default: FIXTUREExample: FIXTUREPossible values:
abbreviationLatinstring | nullableOptional

An abbreviation/short name in latin characters

Example: NFA
nameLatinstring | nullableOptional

The name of the competition in latin characters

Example: Test name latin
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
ageGroupstring · enum | nullableOptional

The age group of the competition

  • None None
  • JUNIOR Junior
  • MASTERS Masters
  • SENIOR Senior
  • UNDER_15 Under 15
  • UNDER_16 Under 16
  • UNDER_17 Under 17
  • UNDER_18 Under 18
  • UNDER_19 Under 19
  • UNDER_20 Under 20
  • UNDER_21 Under 21
  • UNDER_22 Under 22
  • UNDER_23 Under 23
  • YOUTH Youth
Example: SENIORPossible values:
Responses
200

Successful operation

application/json
put
/basketball/o/{organizationId}/competitions/{competitionId}
PUT /v1/basketball/o/{organizationId}/competitions/{competitionId} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 660

{
  "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "internationalReference": "CA3243-3",
  "abbreviationLocal": "NFA",
  "nameLocal": "Test name local",
  "eventType": "FIXTURE",
  "abbreviationLatin": "NFA",
  "nameLatin": "Test name latin ",
  "social": {
    "website": "http://www.example.com",
    "facebook": "https://www.facebook.com/example",
    "twitter": "https://www.twitter.com/example",
    "wikipedia": "https://en.wikipedia.org/wiki/example",
    "instagram": "https://www.instagram.com/example"
  },
  "externalId": "A123",
  "historicalNames": [
    {
      "dateStart": "2025-11-19",
      "dateEnd": "2025-11-19",
      "nameLocal": "text",
      "nameLatin": "text",
      "abbreviationLocal": "text",
      "abbreviationLatin": "text"
    }
  ],
  "ageGroup": "SENIOR"
}
{
  "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": [
    {
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "league": {
        "resourceType": "leagues",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "internationalReference": "CA3243-3",
      "abbreviationLocal": "NFA",
      "nameLocal": "Test name local",
      "eventType": "FIXTURE",
      "abbreviationLatin": "NFA",
      "nameLatin": "Test name latin ",
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "externalId": "A123",
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameLocal": "text",
          "nameLatin": "text",
          "abbreviationLocal": "text",
          "abbreviationLatin": "text"
        }
      ],
      "updated": "2025-11-19T06:12:00.950Z",
      "added": "2025-11-19T06:12:00.950Z",
      "ageGroup": "SENIOR",
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T06:12:00.950Z",
          "added": "2025-11-19T06:12:00.950Z"
        }
      ]
    }
  ]
}

Delete a competition

delete
/basketball/o/{organizationId}/competitions/{competitionId}

Delete a specific competition

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
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
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
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)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
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
Responses
200

Successful operation

application/json
delete
/basketball/o/{organizationId}/competitions/{competitionId}
DELETE /v1/basketball/o/{organizationId}/competitions/{competitionId} 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": [
    {
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "league": {
        "resourceType": "leagues",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "internationalReference": "CA3243-3",
      "abbreviationLocal": "NFA",
      "nameLocal": "Test name local",
      "eventType": "FIXTURE",
      "abbreviationLatin": "NFA",
      "nameLatin": "Test name latin ",
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "externalId": "A123",
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameLocal": "text",
          "nameLatin": "text",
          "abbreviationLocal": "text",
          "abbreviationLatin": "text"
        }
      ],
      "updated": "2025-11-19T06:12:00.950Z",
      "added": "2025-11-19T06:12:00.950Z",
      "ageGroup": "SENIOR",
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T06:12:00.950Z",
          "added": "2025-11-19T06:12:00.950Z"
        }
      ]
    }
  ]
}

Get a list of competitions for the organization group

get
/basketball/orgGroup/{organizationGroupCode}/competitions

Return a list of competitions for the organization group

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
organizationGroupCodestring · min: 3 · max: 150Required

The unique identifier of the organization group

Example: aubb
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)]
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
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
/basketball/orgGroup/{organizationGroupCode}/competitions
GET /v1/basketball/orgGroup/{organizationGroupCode}/competitions 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": [
    {
      "competitionId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "leagueId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "league": {
        "resourceType": "leagues",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "internationalReference": "CA3243-3",
      "abbreviationLocal": "NFA",
      "nameLocal": "Test name local",
      "eventType": "FIXTURE",
      "abbreviationLatin": "NFA",
      "nameLatin": "Test name latin ",
      "social": {
        "website": "http://www.example.com",
        "facebook": "https://www.facebook.com/example",
        "twitter": "https://www.twitter.com/example",
        "wikipedia": "https://en.wikipedia.org/wiki/example",
        "instagram": "https://www.instagram.com/example"
      },
      "externalId": "A123",
      "historicalNames": [
        {
          "dateStart": "2025-11-19",
          "dateEnd": "2025-11-19",
          "nameLocal": "text",
          "nameLatin": "text",
          "abbreviationLocal": "text",
          "abbreviationLatin": "text"
        }
      ],
      "updated": "2025-11-19T06:12:00.950Z",
      "added": "2025-11-19T06:12:00.950Z",
      "ageGroup": "SENIOR",
      "images": [
        {
          "imageId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "organizationId": "9",
          "organization": {
            "resourceType": "organizations",
            "id": "9"
          },
          "baseType": "entity",
          "baseId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "fileType": "png",
          "imageType": "LOGO",
          "secondaryType": "entity",
          "secondaryId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
          "rating": "LOW",
          "url": "text",
          "maximumHeight": 200,
          "maximumWidth": 200,
          "updated": "2025-11-19T06:12:00.950Z",
          "added": "2025-11-19T06:12:00.950Z"
        }
      ]
    }
  ]
}
PreviousPersonsNextTeams

Last updated

Was this helpful?