bgg-sdk

WORK IN PROGRESS: NOT YET READY FOR USE

A modern SDK for interacting with the BoardGameGeek (BGG) XMLAPI2, written in TypeScript and inspired by BGG.

Core Features

• Support for all BGG XMLAPI2 endpoints (see documentation)
• Automatic conversion of responses from XML to JSON
• Exponential retry for queued requests
• Type safety for requests and responses
• Support for both CommonJS and ES modules
• Usable in both server and browser environments

Quickstart

    npm install bgg-sdk
Copy

Code Example

import { bgg } from "bgg-sdk";
// import bgg from "bgg-sdk";

const results = await bgg.search({ query: "scythe" });
Copy

TODO

• Make typing more consistent across routes (ex: page param)
• Create unit tests for all endpoints