Package Exports

sportradar-api-client
sportradar-api-client/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sportradar-api-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

🎉 Sportradar API Client

Documentation & API Specification • Sportradar Postman Collections

GitHub top language

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 Sportradar Postman Collections using Open API v3 Open API Generator.

🚨 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!

🌟 Why Use This?

Full Coverage: This package offers complete access to the Sportradar API. No more partial implementations or missing features.
Optimized for Use: The refactoring ensures that accessing and using the API is as intuitive and straightforward as possible.
Full documentation: See full documentation of the API Specification.
TypeScript Support: Full TypeScript support with comprehensive type definitions.

🛠 Installation

npm install sportradar-api-client --save

⚡ Quick Start

Here's a minimal example to get you started:

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 {}

🔧 Environment Variables

Create a .env file in your project root:

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

🚀 Getting Started

NestJS Implementation

To begin, you'll need your API keys for MLB, NBA, and NFL.

Synchronous Configuration - Using `forRoot`

You can configure the SportradarApiClientModule synchronously using the forRoot method:

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 {}

Asynchronous Configuration with ConfigService - Using `forRootAsync`

If you're using NestJS's ConfigModule and ConfigService to manage your application's configuration, you can configure the SportradarApiClientModule asynchronously:

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 {}

Using the Client in Your Service or Controller

After configuration, you can import SportradarApiClientModule into your module, then import the appropriate API (e.g. SportradarMlbApi) and inject the service SportradarMlbApi.DefaultSportradarMlbApiService (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:

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);
      })
    );
  }
}

Regular Node.js Implementation

For a non-NestJS implementation, you can directly use the services provided by the package.

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

📌 Features

Easy Initialization: Set up and start using the client in no time.
Comprehensive API Access: From MLB to NFL, access every aspect of the Sportradar API.
Efficient Error Handling: Built-in logging and error handling mechanisms for smoother development.
Regular Updates: Stay in sync with the official Sportradar API.
Expandable: While the package currently supports MLB, NBA, and NFL, it's designed to be easily expandable to other sports in the future.
TypeScript Support: Full TypeScript support with comprehensive type definitions.

🔍 TypeScript Types and Interfaces

The package provides comprehensive TypeScript types and interfaces for all API responses. Here's an example of how to use them:

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));
  }
}

⚠️ Error Handling and Rate Limiting

The package includes built-in error handling and rate limiting support:

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);
      })
    );
  }
}

🔧 Troubleshooting

Common issues and their solutions:

API Key Issues
- Ensure your API keys are correctly set in your environment variables
- Check if your API keys have the necessary permissions
- Verify the API keys are active and not expired
Rate Limiting
- Implement retry logic with exponential backoff
- Cache frequently accessed data
- Monitor your API usage
Type Errors
- Make sure you're using the correct type imports
- Check the API documentation for the expected response types
- Use TypeScript's type inference to help catch errors early

🤝 Contribute

Your insights and contributions can make this package even better! Check out our CONTRIBUTING.md guide and be a part of this exciting project.

📖 Documentation

Our library's documentation is generated using TypeDoc, ensuring that you get the most accurate and up-to-date information directly from the source code.

Happy coding! 🎉

⚖️ License

This project is licensed under the MIT License - see the LICENSE file for details.