@1team/sdk

Official JavaScript/TypeScript SDK for the 1team API - manage sports leagues, teams, players, and more.

Installation

npm install @1team/sdk
# or
yarn add @1team/sdk
# or
pnpm add @1team/sdk

Quick Start

Using API Key

import { OneTeamClient } from '@1team/sdk';

const client = new OneTeamClient({
  apiKey: 'gfl_your_api_key_here'
});

// Get all players (paginated)
const players = await client.getPlayers();
console.log(players.items);

// Get a specific player
const player = await client.getPlayer('player-id');

Using OAuth Access Token

import { OneTeamClient } from '@1team/sdk';

const client = new OneTeamClient({
  accessToken: 'your_backend_jwt'
});

// If you only have an OAuth access token, exchange it for a backend token
const { token } = await client.exchangeOAuthToken('your_oauth_access_token');
client.setAccessToken(token);

// Or login with credentials
const { token, user } = await client.login({
  email: '[email protected]',
  password: 'password'
});

// Token is automatically set after login
const currentUser = await client.getCurrentUser();

Configuration

const client = new OneTeamClient({
  // Optional: Use custom API URL
  baseUrl: 'https://api.1team.tv',
  
  // Optional: API key for authentication
  apiKey: 'gfl_...',
  
  // Optional: OAuth access token
  accessToken: 'your_token'
});

// You can also set these after initialization
client.setApiKey('gfl_new_key');
client.setAccessToken('new_token');

Features

Authentication

// Login with email and password
const { token, user } = await client.login({
  email: '[email protected]',
  password: 'password'
});

// Get current user
const user = await client.getCurrentUser();

Players

// Get all players
const players = await client.getPlayers();
console.log(players.items);

// Get players with filters
const players = await client.getPlayers({
  teamId: 'team-id',
  position: 'Forward',
  search: 'John',
  page: 1,
  pageSize: 20
});
console.log(players.items);

// Get a specific player
const player = await client.getPlayer('player-id');

// Create a player
const player = await client.createPlayer({
  teamId: 'team-id',
  firstName: 'John',
  lastName: 'Doe',
  position: 'Forward',
  jerseyNumber: 10
});

// Update a player
const player = await client.updatePlayer('player-id', {
  jerseyNumber: 11
});

// Delete a player
await client.deletePlayer('player-id');

Teams

// Get all teams
const teams = await client.getTeams();
console.log(teams.items);

// Get teams by league
const teams = await client.getTeams({ leagueId: 'league-id' });
console.log(teams.items);

// Get a specific team
const team = await client.getTeam('team-id');

// Create a team
const team = await client.createTeam({
  leagueId: 'league-id',
  name: 'Team Name',
  shortName: 'TN',
  city: 'City'
});

// Update a team
const team = await client.updateTeam('team-id', {
  name: 'New Team Name'
});

// Delete a team
await client.deleteTeam('team-id');

Transfers

// Get all transfers
const transfers = await client.getTransfers();

// Get transfers by status
const transfers = await client.getTransfers({
  status: 'PENDING'
});

// Create a transfer request
const transfer = await client.createTransfer({
  playerId: 'player-id',
  toTeamId: 'team-id',
  expiresInDays: 7
});

// Redeem a transfer
const transfer = await client.redeemTransfer('transfer-code');

// Cancel a transfer
await client.cancelTransfer('transfer-id');

Rosters

// Get all rosters
const rosters = await client.getRosters();
console.log(rosters.items);

// Get rosters for a team
const rosters = await client.getRosters({ teamId: 'team-id' });
console.log(rosters.items);

// Get a specific roster
const roster = await client.getRoster('roster-id');

// Create a roster
const roster = await client.createRoster({
  teamId: 'team-id',
  name: 'Game Day Roster',
  gameDate: '2026-01-04',
  playerIds: ['player-id-1', 'player-id-2']
});

// Update a roster
const roster = await client.updateRoster('roster-id', {
  name: 'Updated Roster'
});

// Delete a roster
await client.deleteRoster('roster-id');

TypeScript Support

This SDK is written in TypeScript and includes full type definitions:

import { 
  1teamClient, 
  Player, 
  Team, 
  Transfer,
  Roster,
  UserRole 
} from '@1team/sdk';

const client = new 1teamClient({ apiKey: 'gfl_...' });

// Fully typed responses
const players: Player[] = await client.getPlayers();
const player: Player = players[0];

// Type-safe inputs
await client.createPlayer({
  teamId: 'team-id',
  firstName: 'John',
  lastName: 'Doe',
  position: 'Forward',
  jerseyNumber: 10
});

Error Handling

try {
  const player = await client.getPlayer('invalid-id');
} catch (error) {
  console.error('API Error:', error.message);
}

Links

• Documentation
• Developer Portal

License

AGPL-3.0-only