VRC-Data-Analysis API

This page documents the VRC-Data-Analysis API which provides advanced analytics and data processing capabilities for VRC competition data.

API Overview

The VRC-Data-Analysis API extends beyond raw competition data to provide processed analytics, predictive models, and statistical insights for teams and events.

Endpoints

Team Analysis

GET /api/teams/{team_id}/analysis

Retrieve comprehensive analysis of a team's performance, including:

• Trend analysis
• Strength metrics
• Consistency ratings
• Performance predictions

Event Predictions

GET /api/events/{event_id}/predictions

Access match predictions and alliance selection recommendations for specific events.

Performance Comparisons

GET /api/compare?team1={team_id1}&team2={team_id2}

Compare two or more teams across various performance metrics.

Using the API with Roboinsights

Roboinsights provides a simplified interface to the VRC-Data-Analysis API. Here's an example of how to use it in your applications:

// Example: Fetching team analysis data
import { getTeamAnalysis } from 'roboinsights-client';
 
const teamData = await getTeamAnalysis('123456');
console.log(teamData.performanceMetrics);
console.log(teamData.winProbability);

Data Model

The API returns JSON data with the following structure for team analysis:

{
  "team_id": "123456",
  "metrics": {
    "offense": 85.2,
    "defense": 72.1,
    "consistency": 91.5
  },
  "predictions": {
    "nextEvent": {
      "expectedRank": 5,
      "winProbability": 0.72
    }
  },
  "historical": {
    "events": [/* array of past event performances */],
    "trendline": [/* array of performance over time */]
  }
}