sportradar-api-client

Version:

Node and NestJS wrappers for Sportradar feeds

gfay63.github.io/sportradar-api-client/

96 lines (93 loc) • 41.8 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>sportradar-api-client</title><meta name="description" content="Documentation for sportradar-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">sportradar-api-client</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>sportradar-api-client</h2></div><div class="tsd-panel tsd-typography"><a id="md:🎉-sportradar-api-client" class="tsd-anchor"></a><h1><a href="#md:🎉-sportradar-api-client">🎉 Sportradar API Client</a></h1> <a href="https://gfay63.github.io/sportradar-api-client/">Documentation & API Specification</a> • <a href="https://www.postman.com/sportradar-media-apis?tab=collections">Sportradar Postman Collections</a> <div align="center"> <a href="https://www.npmjs.com/package/sportradar-api-client"><img src="https://img.shields.io/npm/v/sportradar-api-client.svg" alt="npm version"></a> <a href="https://packagephobia.now.sh/result?p=sportradar-api-client"><img src="https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=sportradar-api-client&query=$.install.pretty&label=install%20size&style=flat-square" alt="install size"></a> <a href="https://npm-stat.com/charts.html?package=sportradar-api-client"><img src="https://img.shields.io/npm/dm/sportradar-api-client.svg?style=flat-square" alt="npm downloads"></a> <a href="https://snyk.io/test/npm/sportradar-api-client"><img src="https://snyk.io/test/npm/sportradar-api-client/badge.svg" alt="Known Vulnerabilities"></a> <img src="https://img.shields.io/github/languages/top/gfay63/sportradar-api-client" alt="GitHub top language"> <a href="https://github.com/sponsors/gfay63"><img src="https://img.shields.io/github/sponsors/gfay63" alt="GitHub Sponsors"></a> </div> Welcome to the comprehensive interface for the Sportradar API Client! This package provides a seamless integration with the Sportradar API, allowing developers to fetch sports data with ease. It's been refactored and optimized to provide a straightforward experience. It is derived in part from the <a href="https://www.postman.com/sportradar-media-apis?tab=collections">Sportradar Postman Collections</a> using Open API v3 <a href="https://openapi-generator.tech/">Open API Generator</a>. <blockquote> 🚨 Disclaimer While this package provides comprehensive access to the Sportradar API, due to the vastness and complexity of the APIs, not all use cases have been exhaustively tested or verified. Users are encouraged to test the package in their specific contexts and report any issues they encounter. Contributions and feedback are always welcome! </blockquote> <a id="md:🌟-why-use-this" class="tsd-anchor"></a><h2><a href="#md:🌟-why-use-this">🌟 Why Use This?</a></h2><ul> <li>Full Coverage: This package offers complete access to the Sportradar API. No more partial implementations or missing features.</li> <li>Optimized for Use: The refactoring ensures that accessing and using the API is as intuitive and straightforward as possible.</li> <li>Full documentation: See <a href="https://gfay63.github.io/sportradar-api-client/">full documentation of the API Specification</a>.</li> <li>TypeScript Support: Full TypeScript support with comprehensive type definitions.</li> </ul> <a id="md:🛠-installation" class="tsd-anchor"></a><h2><a href="#md:🛠-installation">🛠 Installation</a></h2><pre><code class="language-sh">npm install sportradar-api-client --save </code><button>Copy</button></pre> <a id="md:⚡-quick-start" class="tsd-anchor"></a><h2><a href="#md:⚡-quick-start">⚡ Quick Start</a></h2>Here's a minimal example to get you started: <pre><code class="language-typescript">import { SportradarApiClientModule } from "sportradar-api-client"; @Module({ imports: [ SportradarApiClientModule.forRoot({ mlb: { apiKey: process.env.MLB_API_KEY, basePath: process.env.MLB_BASE_PATH, }, }), ], }) export class AppModule {} </code><button>Copy</button></pre> <a id="md:🔧-environment-variables" class="tsd-anchor"></a><h2><a href="#md:🔧-environment-variables">🔧 Environment Variables</a></h2>Create a <code>.env</code> file in your project root: <pre><code class="language-env">MLB_API_KEY=your_mlb_api_key MLB_BASE_PATH=https://api.sportradar.us/mlb/production/v7 NBA_API_KEY=your_nba_api_key NBA_BASE_PATH=https://api.sportradar.us/nba/production/v7 NFL_API_KEY=your_nfl_api_key NFL_BASE_PATH=https://api.sportradar.us/nfl/production/v7 </code><button>Copy</button></pre> <a id="md:🚀-getting-started" class="tsd-anchor"></a><h2><a href="#md:🚀-getting-started">🚀 Getting Started</a></h2><a id="md:nestjs-implementation" class="tsd-anchor"></a><h3><a href="#md:nestjs-implementation">NestJS Implementation</a></h3>To begin, you'll need your API keys for MLB, NBA, and NFL. <a id="md:synchronous-configuration---using-forroot" class="tsd-anchor"></a><h4><a href="#md:synchronous-configuration---using-forroot">Synchronous Configuration - Using <code>forRoot</code></a></h4>You can configure the SportradarApiClientModule synchronously using the forRoot method: <pre><code class="language-typescript">import { SportradarApiClientModule } from "sportradar-api-client"; @Module({ imports: [ SportradarApiClientModule.forRoot({ mlb: { apiKey: "YOUR_MLB_API_KEY", basePath: "YOUR_MLB_BASE_PATH", }, nba: { apiKey: "YOUR_NBA_API_KEY", basePath: "YOUR_NBA_BASE_PATH", }, nfl: { apiKey: "YOUR_NFL_API_KEY", basePath: "YOUR_NFL_BASE_PATH", }, }), ], }) export class AppModule {} </code><button>Copy</button></pre> <a id="md:asynchronous-configuration-with-configservice---using-forrootasync" class="tsd-anchor"></a><h4><a href="#md:asynchronous-configuration-with-configservice---using-forrootasync">Asynchronous Configuration with ConfigService - Using <code>forRootAsync</code></a></h4>If you're using NestJS's ConfigModule and ConfigService to manage your application's configuration, you can configure the SportradarApiClientModule asynchronously: <pre><code class="language-typescript">import { SportradarApiClientModule } from "sportradar-api-client"; import { ConfigModule, ConfigService } from "@nestjs/config"; @Module({ imports: [ ConfigModule.forRoot(), SportradarApiClientModule.forRootAsync({ imports: [ConfigModule], useFactory: async (configService: ConfigService) => ({ mlb: { apiKey: configService.get<string>("MLB_API_KEY"), basePath: configService.get<string>("MLB_BASE_PATH"), }, nba: { apiKey: configService.get<string>("NBA_API_KEY"), basePath: configService.get<string>("NBA_BASE_PATH"), }, nfl: { apiKey: configService.get<string>("NFL_API_KEY"), basePath: configService.get<string>("NFL_BASE_PATH"), }, }), inject: [ConfigService], }), ], exports: [SportradarApiClientModule], }) export class AppModule {} </code><button>Copy</button></pre> <a id="md:using-the-client-in-your-service-or-controller" class="tsd-anchor"></a><h4><a href="#md:using-the-client-in-your-service-or-controller">Using the Client in Your Service or Controller</a></h4>After configuration, you can import <code>SportradarApiClientModule</code> into your module, then import the appropriate API (e.g. <code>SportradarMlbApi</code>) and inject the service <code>SportradarMlbApi.DefaultSportradarMlbApiService</code> (or the respective service for other sports) into your services or controllers. Here is an example accessing a few of the MLB API endpoints in a controller: <pre><code class="language-typescript">import { Controller, Get, HttpException, HttpStatus } from "@nestjs/common"; import { Observable } from "rxjs"; import { catchError, map } from "rxjs/operators"; import { SportradarMlbApi } from "sportradar-api-client"; @Controller("mlb") export class MlbController { constructor( private readonly srMlbService: SportradarMlbApi.DefaultSportradarMlbApiService ) {} @Get("leagueHierarchy") getLeagueHierarchy(): Observable<any> { return this.srMlbService.leagueHierarchy("en", "json").pipe( map((apiResponse) => { if (apiResponse.status !== 200) { throw new HttpException(apiResponse.data, apiResponse.status); } return apiResponse.data; }), catchError((err) => { throw new HttpException(err.message, HttpStatus.INTERNAL_SERVER_ERROR); }) ); } @Get("injuries") getInjuries(): Observable<any> { return this.srMlbService.injuries("en", "json").pipe( map((apiResponse) => { if (apiResponse.status !== 200) { throw new HttpException(apiResponse.data, apiResponse.status); } return apiResponse.data; }), catchError((err) => { throw new HttpException(err.message, HttpStatus.INTERNAL_SERVER_ERROR); }) ); } } </code><button>Copy</button></pre> <a id="md:regular-nodejs-implementation" class="tsd-anchor"></a><h3><a href="#md:regular-nodejs-implementation">Regular Node.js Implementation</a></h3>For a non-NestJS implementation, you can directly use the services provided by the package. <pre><code class="language-typescript">import { DefaultSportradarMlbApiService } from "sportradar-api-client"; const mlbConfig = { apiKey: "YOUR_MLB_API_KEY", basePath: "https://api.sportradar.us/mlb/production/v7", }; const mlbService = new DefaultSportradarMlbApiService(mlbConfig); // Use mlbService to access all the MLB endpoint APIs </code><button>Copy</button></pre> <a id="md:📌-features" class="tsd-anchor"></a><h2><a href="#md:📌-features">📌 Features</a></h2><ul> <li>Easy Initialization: Set up and start using the client in no time.</li> <li>Comprehensive API Access: From MLB to NFL, access every aspect of the Sportradar API.</li> <li>Efficient Error Handling: Built-in logging and error handling mechanisms for smoother development.</li> <li>Regular Updates: Stay in sync with the official Sportradar API.</li> <li>Expandable: While the package currently supports MLB, NBA, and NFL, it's designed to be easily expandable to other sports in the future.</li> <li>TypeScript Support: Full TypeScript support with comprehensive type definitions.</li> </ul> <a id="md:🔍-typescript-types-and-interfaces" class="tsd-anchor"></a><h2><a href="#md:🔍-typescript-types-and-interfaces">🔍 TypeScript Types and Interfaces</a></h2>The package provides comprehensive TypeScript types and interfaces for all API responses. Here's an example of how to use them: <pre><code class="language-typescript">import { SportradarMlbApi, SportradarMlbApiTypes } from "sportradar-api-client"; @Controller("mlb") export class MlbController { constructor( private readonly srMlbService: SportradarMlbApi.DefaultSportradarMlbApiService ) {} @Get("leagueHierarchy") getLeagueHierarchy(): Observable<SportradarMlbApiTypes.LeagueHierarchyResponse> { return this.srMlbService .leagueHierarchy("en", "json") .pipe(map((apiResponse) => apiResponse.data)); } } </code><button>Copy</button></pre> <a id="md:⚠️-error-handling-and-rate-limiting" class="tsd-anchor"></a><h2><a href="#md:⚠️-error-handling-and-rate-limiting">⚠️ Error Handling and Rate Limiting</a></h2>The package includes built-in error handling and rate limiting support: <pre><code class="language-typescript">import { HttpException, HttpStatus } from "@nestjs/common"; import { catchError, retry } from "rxjs/operators"; @Controller("mlb") export class MlbController { @Get("data") getData() { return this.srMlbService.someEndpoint().pipe( retry(3), // Retry failed requests up to 3 times catchError((err) => { if (err.response?.status === 429) { throw new HttpException( "Rate limit exceeded", HttpStatus.TOO_MANY_REQUESTS ); } throw new HttpException(err.message, HttpStatus.INTERNAL_SERVER_ERROR); }) ); } } </code><button>Copy</button></pre> <a id="md:🔧-troubleshooting" class="tsd-anchor"></a><h2><a href="#md:🔧-troubleshooting">🔧 Troubleshooting</a></h2>Common issues and their solutions: <ol> <li>API Key Issues <ul> <li>Ensure your API keys are correctly set in your environment variables</li> <li>Check if your API keys have the necessary permissions</li> <li>Verify the API keys are active and not expired</li> </ul> </li> <li>Rate Limiting <ul> <li>Implement retry logic with exponential backoff</li> <li>Cache frequently accessed data</li> <li>Monitor your API usage</li> </ul> </li> <li>Type Errors <ul> <li>Make sure you're using the correct type imports</li> <li>Check the API documentation for the expected response types</li> <li>Use TypeScript's type inference to help catch errors early</li> </ul> </li> </ol> <a id="md:🤝-contribute" class="tsd-anchor"></a><h2><a href="#md:🤝-contribute">🤝 Contribute</a></h2>Your insights and contributions can make this package even better! Check out our <a href="./CONTRIBUTING.md">CONTRIBUTING.md</a> guide and be a part of this exciting project. <a id="md:📖-documentation" class="tsd-anchor"></a><h2><a href="#md:📖-documentation">📖 Documentation</a></h2>Our <a href="https://gfay63.github.io/sportradar-api-client/">library's documentation</a> is generated using TypeDoc, ensuring that you get the most accurate and up-to-date information directly from the source code. Happy coding! 🎉 <a id="md:⚖️-license" class="tsd-anchor"></a><h3><a href="#md:⚖️-license">⚖️ License</a></h3>This project is licensed under the MIT License - see the <a href="./LICENSE">LICENSE</a> file for details. </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Private</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>External</label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:🎉-sportradar-api-client">🎉 Sportradar API Client</a><ul><li><a href="#md:🌟-why-use-this">🌟 Why Use This?</a></li><li><a href="#md:🛠-installation">🛠 Installation</a></li><li><a href="#md:⚡-quick-start">⚡ Quick Start</a></li><li><a href="#md:🔧-environment-variables">🔧 Environment Variables</a></li><li><a href="#md:🚀-getting-started">🚀 Getting Started</a></li><li><ul><li><a href="#md:nestjs-implementation">NestJS Implementation</a></li><li><ul><li><a href="#md:synchronous-configuration---using-forroot">Synchronous Configuration - Using forRoot</a></li><li><a href="#md:asynchronous-configuration-with-configservice---using-forrootasync">Asynchronous Configuration with ConfigService - Using forRootAsync</a></li><li><a href="#md:using-the-client-in-your-service-or-controller">Using the Client in Your Service or Controller</a></li></ul></li><li><a href="#md:regular-nodejs-implementation">Regular Node.js Implementation</a></li></ul></li><li><a href="#md:📌-features">📌 Features</a></li><li><a href="#md:🔍-typescript-types-and-interfaces">🔍 TypeScript Types and Interfaces</a></li><li><a href="#md:⚠️-error-handling-and-rate-limiting">⚠️ Error Handling and Rate Limiting</a></li><li><a href="#md:🔧-troubleshooting">🔧 Troubleshooting</a></li><li><a href="#md:🤝-contribute">🤝 Contribute</a></li><li><a href="#md:📖-documentation">📖 Documentation</a></li><li><ul><li><a href="#md:⚖️-license">⚖️ License</a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg>sportradar-api-client</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></footer><div class="overlay"></div></body></html>