Package Exports
- rimble
Readme
Rimble JS SDK
JavaScript/TypeScript client for the Rimble Raw Data API — real-time esports data across 10 titles.
Zero runtime dependencies. Works in Node.js 18+ and browsers.
Installation
npm install rimbleQuick Start (TypeScript)
import { RimbleClient } from 'rimble';
const client = new RimbleClient({ apiKey: 'YOUR_API_KEY' });
const matches = await client.getUpcomingMatches('lol');
for (const match of matches) {
console.log(`${match.team_1_name} vs ${match.team_2_name} — ${match.date}`);
}Quick Start (JavaScript)
const { RimbleClient } = require('rimble');
const client = new RimbleClient({ apiKey: 'YOUR_API_KEY' });
const matches = await client.getUpcomingMatches('lol');
console.log(matches);Filtering with Query Parameters
// Filter by date
const matches = await client.getUpcomingMatches('csgo', { date: '2024-03-15' });
// Filter by team
const matches = await client.getUpcomingMatches('valorant', { team: 'Sentinels' });
// Filter by league
const matches = await client.getCompletedMatches('lol', { league: 'LCS' });
// Multiple filters
const matches = await client.getCompletedMatches('dota2', { date: '2024-03-10', team: 'OG' });Available Methods
| Method | Description |
|---|---|
getUpcomingMatches(sport, params?) |
Upcoming matches |
getLiveMatches(sport, params?) |
Currently live matches |
getCompletedMatches(sport, params?) |
Completed matches (last 5 days) |
getMatchStatus(sport, matchid, params?) |
Status of a specific match |
getLeagueMappings(sport, params?) |
League/tournament directory |
getTeams(sport, params?) |
Team directory |
getPlayers(sport, params?) |
Player directory |
Supported Sports
lol, csgo, dota2, valorant, rocketleague, cod, nba2k, fifa, siege, cricket
Error Handling
import { RimbleClient, RimbleAPIError } from 'rimble';
const client = new RimbleClient({ apiKey: 'YOUR_API_KEY' });
try {
const matches = await client.getUpcomingMatches('lol');
} catch (err) {
if (err instanceof RimbleAPIError) {
console.error(`API error: ${err.status}`);
}
}