@teambattles/sdk

Official TypeScript SDK for the TeamBattles public developer API.

Auto-generated from the TeamBattles OpenAPI 3.1 specification with Microsoft Kiota. This README is generated by pnpm sdk:docs and regenerates on every API change - do not edit it by hand.

• Language: TypeScript
• Registry: npm
• Maturity: Preview (may be quarantined in CI; see sdks/QUARANTINE.md)

Install

npm install @teambattles/sdk

Dependencies

The generated client is a thin veneer over the shared Kiota runtime. This package depends on:

• @microsoft/kiota-abstractions
• @microsoft/kiota-http-fetchlibrary
• @microsoft/kiota-serialization-json
• @microsoft/kiota-serialization-text
• @microsoft/kiota-serialization-form
• @microsoft/kiota-serialization-multipart
• @microsoft/kiota-bundle

Create a client

Construct a client once with your API key. The factory wires a bearer-token authentication provider and points the client at the production base URL.

import { createTeamBattlesClient } from "@teambattles/sdk";

const client = createTeamBattlesClient(process.env.TEAMBATTLES_API_KEY!);

First call: list the authenticated user's matches

// List the authenticated user's matches (requires matches.user_matches: read)
const result = await client.user.matches.post({ numItems: 25 });
for (const match of result?.page ?? []) {
  console.log(match.id, match.status);
}

Authentication

Every request is authenticated with an API key sent as a bearer token:

Authorization: Bearer tb_YOUR_KEY

Create and manage keys at Settings > Developer. Keys carry granular permission scopes - listing the authenticated user's matches requires matches.user_matches: read.

Errors return a JSON body of the form { "error": "machine_code", "details": "optional message" }. Treat the error machine code - not the details message - as the stable programmatic contract: branch on error, and use details only for human-readable context (it may be absent on auth and permission errors).

Documentation

• API reference and guides: https://teambattles.gg/docs/developers
• SDKs overview: https://teambattles.gg/docs/sdks
• This SDK: https://teambattles.gg/docs/sdks/typescript
• Authentication: https://teambattles.gg/docs/developers/authentication

License

MIT