Documentation & API Specification
Welcome to the comprehensive interface for the Rotowire API Client!
This package provides a seamless integration with the Rotowire 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 Rotowire API using Open API v3 Open API Generator.
π¨ Disclaimer
While this package provides comprehensive access to the Rotowire 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!
npm install rotowire-api-client --save
Here's a minimal example to get you started:
import { RotowireApiClientModule } from "rotowire-api-client";
@Module({
imports: [
RotowireApiClientModule.forRoot({
apiKey: process.env.ROTOWIRE_API_KEY,
basePath: process.env.ROTOWIRE_BASE_PATH,
}),
],
})
export class AppModule {}
Create a .env
file in your project root:
ROTOWIRE_API_KEY=your_rotowire_api_key
ROTOWIRE_BASE_PATH=https://api.rotowire.com/v1
To begin, you'll need your Rotowire API key.
forRoot
You can configure the RotowireApiClientModule synchronously using the forRoot method:
import { RotowireApiClientModule } from "rotowire-api-client";
@Module({
imports: [
RotowireApiClientModule.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 {}
forRootAsync
If you're using NestJS's ConfigModule and ConfigService to manage your application's configuration, you can configure the RotowireApiClientModule asynchronously:
import { RotowireApiClientModule } from "rotowire-api-client";
import { ConfigModule, ConfigService } from "@nestjs/config";
@Module({
imports: [
ConfigModule.forRoot(),
RotowireApiClientModule.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: [RotowireApiClientModule],
})
export class AppModule {}
After configuration, you can import RotowireApiClientModule
into your module, then import the appropriate API and inject the service into your services or controllers. Here is an example accessing some of the Rotowire API endpoints in a controller:
import { Controller, Get, HttpException, HttpStatus } from "@nestjs/common";
import { Observable } from "rxjs";
import { catchError, map } from "rxjs/operators";
import { RotowireApi } from "rotowire-api-client";
@Controller("rotowire")
export class RotowireController {
constructor(
private readonly rotowireService: RotowireApi.DefaultRotowireApiService
) {}
@Get("news")
getNews(): Observable<any> {
return this.rotowireService.getNews().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);
})
);
}
}
For a non-NestJS implementation, you can directly use the services provided by the package.
import { DefaultRotowireApiService } from "rotowire-api-client";
const config = {
apiKey: "YOUR_ROTOWIRE_API_KEY",
basePath: "https://api.rotowire.com/v1",
};
const rotowireService = new DefaultRotowireApiService(config);
// Use rotowireService to access all the Rotowire endpoint APIs
The package provides comprehensive TypeScript types and interfaces for all API responses. Here's an example of how to use them:
import { RotowireApi, RotowireApiTypes } from "rotowire-api-client";
@Controller("rotowire")
export class RotowireController {
constructor(
private readonly rotowireService: RotowireApi.DefaultRotowireApiService
) {}
@Get("news")
getNews(): Observable<RotowireApiTypes.NewsResponse> {
return this.rotowireService
.getNews()
.pipe(map((apiResponse) => apiResponse.data));
}
}
The package includes built-in error handling and rate limiting support:
import { HttpException, HttpStatus } from "@nestjs/common";
import { catchError, retry } from "rxjs/operators";
@Controller("rotowire")
export class RotowireController {
@Get("data")
getData() {
return this.rotowireService.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);
})
);
}
}
Common issues and their solutions:
API Key Issues
Rate Limiting
Type Errors
Your insights and contributions can make this package even better! Check out our CONTRIBUTING.md guide and be a part of this exciting project.
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! π
This project is licensed under the MIT License - see the LICENSE file for details.
Generated using TypeDoc