Skip to main content
The Sports resource provides access to sports configuration and team information from data providers.

​
Methods

MethodEndpointDescription
list()GET /v1/sportsList all sports
teams(params?)GET /v1/sports/teams/providerGet teams by provider

​
list

Get all available sports and their configuration. 
const sports = await client.sports.list();

for (const sport of sports.sports) {
  console.log(`${sport.sport} - Operational: ${sport.isOperational}`);
}

​
Response Fields

FieldTypeDescription
sportstringSport name
imagestringSport image URL
isOperationalbooleanWhether sport is operational
automaticResolutionbooleanWhether automatic resolution is enabled
orderingstringDisplay ordering

​
teams

Get team information from a specific data provider. 
const teams = await client.sports.teams({
  provider: 'PROVIDER_SPORTRADAR',
  league: 'NFL',
});

for (const team of teams.teams) {
  console.log(`${team.name} (${team.abbreviation})`);
  console.log(`  Conference: ${team.conference}`);
  console.log(`  Record: ${team.record}`);
}

​
Parameters

ParameterTypeDescription
providerstringData provider (see below)
leaguestringLeague name (NFL, NBA, MLB, etc.)
teamIdsnumber[]Filter by specific team IDs

​
Data Providers

ProviderDescription
PROVIDER_SPORTRADARSportradar
PROVIDER_SPORTSDATAIOSportsData.io

​
Team Fields

FieldTypeDescription
idnumberTeam identifier
namestringTeam name
abbreviationstringTeam abbreviation
leaguestringLeague name
conferencestringConference name
recordstringTeam record
rankingnumberTeam ranking
logostringLogo URL
colorPrimarystringPrimary team color