Skip to main content
The WellPlayed TypeScript SDK provides a complete GraphQL client for interacting with the WellPlayed API.

​
Installation

Install the SDK using your preferred package manager: 
npm install @well-played.gg/typescript-sdk

​
Dependencies

The SDK has the following peer dependencies that you may need to install separately:

​
Required Dependencies

npm install @apollo/client graphql

​
Full Dependency List

The SDK includes these dependencies automatically:
  • @nerdwallet/apollo-cache-policies - Advanced cache invalidation policies
  • apollo3-cache-persist - Cache persistence for offline support
  • graphql-ws - GraphQL subscriptions over WebSocket
  • axios - HTTP client for authentication
  • lodash - Utility functions
If you’re using the typed client instead of Apollo, you only need the graphql package as a peer dependency.

​
Package Information

The SDK is distributed with multiple module formats:
  • CommonJS: dist/wp-ts-sdk.cjs.js
  • ES Modules: dist/wp-ts-sdk.es.js
  • TypeScript Types: dist/index.d.ts
Make sure you’re using TypeScript 5.6+ for the best type inference experience.

​
Next Steps

Client Setup

Configure the Apollo client with authentication and caching

Typed Client

Use the lightweight typed client for server-side usage

Build docs developers (and LLMs) love

Get started for freeTalk to us