sportradar-api-client
Version:
Node and NestJS wrappers for Sportradar feeds
296 lines (260 loc) • 17.2 kB
text/typescript
/**
* Sportradar NBA API
* Sportradar is the Official Data Provider of NBA statistics. We combine on-venue speed, detailed game and seasonal statistics, and advanced metrics for a full basketball experience. Every NBA game – including preseason – updates in real-time, with live event positional data. The NBA API is consistent in structure, format, and behavior with our other League Specific APIs. Our primary feeds return schedules, standings, team/player data, and real-time scores. Our other NBA feeds provide a host of complimentary statistics and information, including: * Rankings * League leaders * Game splits * Season splits * Injuries * Free agents * Draft information * Live advanced metrics * In-game substitution info * Live event positional data Real-time customers are also offered five delivery Push Feeds to enhance speed. The easiest way to get started with the API is to click the fork button to fork this collection to your own workspace and use Postman to send requests. # Overview 1. You need a valid API Key to send requests to the API endpoints. You can get your free trial key by registering an account and creating an application from our [Developer Portal](https://developer.sportradar.com/). 2. Once you have your sport specific key, replace the value `{Your API Key}` with your API key and click the save icon (or click the Meatballs Menu and select \"Save\") 3. By default, responses to every request are sent in JSON. If you prefer XML, you can change the variable by clicking the \"Variables\" tab and replacing the Current Value for format to xml. 4. Select an endpoint from the NBA v7 menu on the left, then click \"Send\" on the resulting screen. 5. The API calls will respond with appropriate [HTTP response codes](https://developer.sportradar.com/docs/read/Home#http-response-codes) for all requests. Within Postman Client, when a response is received, the status code is highlighted and is accompanied by a help text that indicates the possible meaning of the response code. A 200 OK indicates all went well, while 4XX or 5XX response codes indicate an error from the requesting client or our API servers respectively. 6. Data for the requested endpoint is displayed in the Body section below. # Other Resources The [API Map](https://developer.sportradar.com/docs/read/basketball/NBA_v7#nba-api-map) on our Developer Portal illustrates how to obtain the parameters you will need to access the API. The [Statistics Summary](https://developer.sportradar.com/files/Sportradar_NBA_v7_Statistics_Summary.pdf) provides a high-level overview of all the data points provided within the whole API, giving you an “at a glance” view of the data we offer. The [Documentation](https://developer.sportradar.com/files/Sportradar_NBA_v7_Statistics_Feeds.pdf) provides a list of endpoints for the API with basic descriptions. When applicable, we include information on the Coverage Levels provided for the API. This document also includes descriptions of each data point and information about where each data point can be found within the API. The [NBA Play-In Tournament](https://developer.sportradar.com/files/Sportradar_NBA_Play_In_Tournament.pdf) provides a detailed breakdown on the structure and workflow of the Play-In Tournament in the NBA API. [Frequently Asked Questions](https://developer.sportradar.com/docs/read/basketball/NBA_v7#frequently-asked-questions) about the API can be found on the Developer Portal and in the Documentation mentioned above. The [Change Log](https://developer.sportradar.com/files/NBA_API_v7_Change_Log.pdf) provides a list of changes and updates to this version of the API since the initial release of the API version. If you need further information, contact our support team: Email: [support@sportradar.com](mailto:support@sportradar.com)
*
* The version of the OpenAPI document: 8
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Observable } from 'rxjs';
import { Configuration } from '../configuration';
export interface DefaultSportradarNbaApiServiceInterface {
defaultHeaders: {};
configuration: Configuration;
/**
* Daily Change Log
* Provides IDs and timestamps for teams, players, game statistics, schedules, and standings that have been modified on a given date. To receive the data updates, use these unique IDs to pull relevant API feeds.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param month (Required) Month in 2 digit format
* @param day (Required) Day in 2 digit format
* @param format
*/
dailyChangeLog(locale: string, year: number, month: number, day: number, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Daily Schedule
* Date, time, location, and other event details for every game taking place in the league-defined day.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param month (Required) Month in 2 digit format
* @param day (Required) Day in 2 digit format
* @param format
*/
dailySchedule(locale: string, year: number, month: number, day: number, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Daily Transfers
* Information for all transfers added or edited during the league-defined day.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param month (Required) Month in 2 digit format
* @param day (Required) Day in 2 digit format
* @param format
*/
dailyTransfers(locale: string, year: number, month: number, day: number, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Draft Summary
* Provides pre-draft pick order with live pick selections during the draft. Displays information on draft rounds, picks, teams, and prospects for a given draft year.
* @param locale (Required) Locale used for translations
* @param year
* @param format
*/
draftSummary(locale: string, year: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Free Agents
* Detailed player information for all current free agents in the league.
* @param locale (Required) Locale used for translations
* @param format
*/
freeAgents(locale: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Game Boxscore
* Top-level team scores by quarter, along with full statistics for each teams’ leaders in points, rebounds, and assists.
* @param locale (Required) Locale used for translations
* @param game_id (Required) ID of a game
* @param format
*/
gameBoxscore(locale: string, game_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Game Summary
* Top-level boxscore information, along with detailed game stats at the team and player levels.
* @param locale (Required) Locale used for translations
* @param game_id (Required) ID of a game
* @param format
*/
gameSummary(locale: string, game_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Injuries
* Information concerning all active player injuries for each NBA team.
* @param locale (Required) Locale used for translations
* @param format
*/
injuries(locale: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* League Hierarchy
* League, conference, division, and team identification and association information.
* @param locale (Required) Locale used for translations
* @param format
*/
leagueHierarchy(locale: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* League Leaders
* NBA leader information for various offensive and defensive categories including full player seasonal statistics for each player in each category.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_type (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param format
*/
leagueLeaders(locale: string, year: number, season_type: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Play-By-Play
* Detailed, real-time information on every team possession and game event.
* @param locale (Required) Locale used for translations
* @param game_id (Required) ID of a game
* @param format
*/
playByPlay(locale: string, game_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Player Profile
* Provides player biographical information, draft information, and seasonal statistics for the regular season and postseason.
* @param locale (Required) Locale used for translations
* @param game_id (Required) ID of a game
* @param format
*/
playerProfile(locale: string, game_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Prospects
* Provides a list of upcoming or historical draft prospects for a given year.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param format
*/
prospects(locale: string, year: number, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Rankings
* Conference and division rank for each team, including playoff clinching status.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_year (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param format
*/
rankings(locale: string, year: number, season_year: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Schedule
* Date, time, location, and other event details for every match-up taking place in the full league season.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_type (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param format
*/
schedule(locale: string, year: number, season_type: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Seasonal Statistics
* Provides complete team and player seasonal statistics for a given season and season type.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_type (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param team_id (Required) ID of a team
* @param format
*/
seasonalStatistics(locale: string, year: number, season_type: string, team_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Seasons
* Provides a list of all available seasons, including preseasons and postseasons.
* @param locale (Required) Locale used for translations
* @param format
*/
seasons(locale: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Series Schedule
* Playoff participant information as well as the date, time, location, and other event details for every match-up taking place for the entire playoffs.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_type (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param format
*/
seriesSchedule(locale: string, year: number, season_type: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Series Statistics
* Detailed team and player statistics for a given playoff series.
* @param locale (Required) Locale used for translations
* @param series_id (Required) ID of a series
* @param team_id (Required) ID of a team
* @param format
*/
seriesStatistics(locale: string, series_id: string, team_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Splits (Game)
* Detailed Team, Player, and Opponent game splits across various views including: Home Team, Loss, Vs Opponent, Overtime, Over 500, Road, Under 500, At Venue, and Wins.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_type (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param team_id (Required) ID of a team
* @param format
*/
splitsGame(locale: string, year: number, season_type: string, team_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Splits (Hierarchy)
* Detailed Team, Player, and Opponent splits across each Conference and Division.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_type (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param team_id (Required) ID of a team
* @param format
*/
splitsHierarchy(locale: string, year: number, season_type: string, team_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Splits (Ingame)
* Detailed Team, Player, and Opponent in-game splits across various views including: Higher Field Goal Percentage, Less Personal Fouls, Less Rebounds, Less Turnovers, Lower Field Goal Percentage, More Personal Fouls, More Rebounds, More Turnovers, Over 100 Against, Over 100 For, Same Personal Fouls, Same Rebounds, Same Turnovers, Under 100 Against, and Under 100 For.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_type (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param team_id (Required) ID of a team
* @param format
*/
splitsIngame(locale: string, year: number, season_type: string, team_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Splits (Schedule)
* Detailed Team, Player, and Opponent splits across various schedule views including: Days of Rest (1, 2, or 3+), Day of the Week, Last 5, Last 10, By Month, and By Week.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_type (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param team_id (Required) ID of a team
* @param format
*/
splitsSchedule(locale: string, year: number, season_type: string, team_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Standings
* Detailed team records across various views including, overall, conference, and division information.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param season_type (Required) Season type as Preseason (PRE), Regular (REG), or Postseason (PST)
* @param format
*/
standings(locale: string, year: number, season_type: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Team Draft Summary
* Provides pre-draft pick order with live pick selections during the draft for a given team.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param team_id (Required) ID of a team
* @param format
*/
teamDraftSummary(locale: string, year: number, team_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Team Profile (Rosters)
* Provides top-level team information and a full roster of active players.
* @param locale (Required) Locale used for translations
* @param team_id (Required) ID of a team
* @param format
*/
teamProfileRosters(locale: string, team_id: string, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Top Prospects
* Provides a list of the top prospects for a given year.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param format
*/
topProspects(locale: string, year: number, format: string, extraHttpRequestParams?: any): Observable<{}>;
/**
* Trades
* Provides summary details of all in-draft trades.
* @param locale (Required) Locale used for translations
* @param year (Required) Year in 4 digit format
* @param format
*/
trades(locale: string, year: number, format: string, extraHttpRequestParams?: any): Observable<{}>;
}