BoardGamer.BoardGameGeek

KO | EN

gitlite — search

#javascript #react #typescript #llm #golang #rust #linux #docker #nodejs #java #windows #awesome #kubernetes #mcp

BoardGamer.BoardGameGeek

(★ 21)

.NET client library for BGG XML API2

BoardGamer.BoardGameGeek 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Powered by BGG](https://raw.githubusercontent.com/Cobster/BoardGamer.BoardGameGeek/master/.github/assets/powered-by-bgg-rgb.svg)

# BoardGamer.BoardGameGeek

A .NET library for interacting with the BGG XML API2 made available on boardgamegeek.com.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development. 
Since I don't know your specific use cases, I have tried to return full fidelity responses that contain all
the information provided by boardgamegeek.com. Hopefully this makes it easy for you to pick and choose the
data elements that you need for your own project.

### Installing

You should install [BoardGamer.BoardGameGeek with NuGet](https://www.nuget.org/packages/BoardGamer.BoardGameGeek/):

```
Install-Package BoardGamer.BoardGameGeek
```

Or use the .NET Core command line interface:

```
dotnet add package BoardGamer.BoardGameGeek
```

## Setup

> [!IMPORTANT]
> As of July 2nd, 2025, the BoardGameGeek XML APIs require registration and authorization.
>
> See [Using the XML API](https://boardgamegeek.com/using_the_xml_api).
>
> Once you receive authorization for your application from BoardGameGeek and create an API token.
>
> **v0.9.0** and later
>
> ```
> var bgg = new BoardGameGeekXmlApiClient(
>     new HttpClient(), 
>     new BoardGameGeekXmlApiClientOptions { 
>         AuthorizationToken = "__YOUR_AUTH_TOKEN_GOES_HERE__" 
>     });
> ```
>

This library was intended to be used in conjunction with HttpClientFactory as a Typed client within an ASP.NET Core web appllication.

To configure this for use within ASP.NET Core just add the following line to `ConfigureServices` within your `Startup.cs` file:

```
services.AddHttpClient<IBoardGameGeekXmlApi2Client, BoardGameGeekXmlApi2Client>();
```

Then just define this as a dependency in a service or controller class.

```
[Route("api/[controller]")]
public class GeekController : Controller
{
	private readonly IBoardGameGeekXmlApi2Client bgg;

public GeekController(IBoardGameGeekXmlApi2Client bggClient) 
	{
		this.bgg = bggClient;
	}
}
```

But you can use this outside of ASP.NET Core by providing your own instance of `System.Net.Http.HttpClient`:

```
IBoardGameGeekXmlApi2Client bgg = new BoardGameGeekXmlApi2Client(new HttpClient());
```

## Usage

Here are some common use cases that this library can help you fulfill.

### Get a user's profile

This example makes a user request to get the user's profile information.

```
UserRequest request = new UserRequest("jakefromstatefarm");
UserResponse response = await bgg.GetUserAsync(request);
UserResponse.User user = response.Result;
```

### Get a user's profile including all their geek buddies

This example makes a user request and includes the buddies argument to get the user
profile information and includes the username and id of all their buddies.

```
UserRequest request = new UserRequest("jakefromstatefarm", buddies: true);
UserResponse response = await bgg.GetUserAsync(request);
List<UserResponse.Buddy> buddies = response.Result.Buddies;
```

### Get a user's game collection

This example makes a collection request to get all of a board games in a user's collection.

```
CollectionRequest request = new CollectionRequest("jakefromstatefarm");
CollectionResponse response = await bgg.GetCollectionAsync(request);
CollectionResponse.ItemCollection collection = response.Result;

foreach (CollectionResponse.Item item in collection) {
	// do something which each item in the collection
}
```

If you are retrieving a large collection, this request could take a long time to complete. The library try to handle
this internally by performing retries after a delay. By default, this will retry every 500 milliseconds up to
a maximum of 20 times. If this still isn't working, try configuring your own retry values.

```
BoardGameGeekXmlApi2ClientOptions customOptions = new BoardGameGeekXmlApi2ClientOptions {
    MaxRetries = 50,
    Delay = TimeSpan.FromSeconds(1)
};

IBoardGameGeekXmlApi2Client bgg = new BoardGameGeekXmlApi2Client(new HttpClient(), customOptions);

```

### Get a user's game collection including stats for each game

This example makes a collection request that includes the stats for each game and uses it
to filter the collection to the games that play 2 to 4 people.

```
CollectionRequest request = new CollectionRequest("jakefromstatefarm", stats: true);
CollectionResponse response = await bgg.GetCollectionAsync(request);
CollectionResponse.ItemCollection collection = response.Result;

Func<CollectionResponse.Item,bool> TwoToFourPeopleCanPlay = i => i.Stats.MinPlayers >= 2 && i.Stats.MaxPlayers <= 4;

IEnumerable<CollectionResponse.Item> games = collection.Where(TwoToFourPeopleCanPlay);
```

### Get details about a board game

This example makes a thing request to get detailed information about board game 161936 (i.e. Pandemic Legacy: Season 1).

```
ThingRequest request = new ThingRequest(new [] { 161936 });
ThingResponse response = await bgg.GetThingAsync(request);
ThingResponse.Item pandemicLegacySeason1 = response.Result.GetFirstOrDefault();
```

### Get details about multiple board games

This example makes a thing request with multiple ids to get detail information about multiple board games.

```
ThingRequest request = new ThingRequest(new [] { 161936, 221107 });
ThingResponse response = await bgg.GetThingAsync(request);
ThingResponse.Item pandemicLegacySeason1 = response.Result[0];
ThingResponse.Item pandemicLegacySeason2 = response.Result[1];
```

### Get logged play information for a player

This examples gets the most recent 100 logged plays for a user.

```
PlaysRequest request = new PlaysRequest("jakefromstatefarm");
PlaysResponse response = await bgg.GetPlaysAsync(request);
PlaysResponse.PlaysCollection collection = response.Result;

foreach (PlaysResponse.Play loggedPlay in collection.Plays)
{
    // do something interesting here
}
```

### Get all logged plays for a player

This example makes multiple requests to get all the logged plays in batches of 100.

```
PlaysRequest request = new PlaysRequest("jakefromstatefarm");
PlaysResponse response = await bgg.GetPlaysAsync(request);
PlaysResponse.PlaysCollection collection = response.Result;

int pages = (int)(Math.Ceiling(collection.Total / (double)100);

List<PlaysResponse.Play> allPlays = new List<PlaysResponse.Play>();
allPlays.AddRange(collection.Plays);

// Okay we've got page 1 containing the first 100 logged plays
for (int i=2; i <= pages; i++) 
{
    request = new PlaysRequest("jakefromstatefarm", page: i);
    // should probably delay for a bit of time to prevent slamming the bgg server with requests    
    response = await bgg.GetPlaysAsync(request);
    allPlays.AddRange(response.Collection.Plays);
}

foreach (PlaysResponse.Play play in allPlays)
{
    // do something interesting here
}
```

### Get all logged plays of a game

This example gets the most recent 100 logged plays of Carcassonne (#822). This gets all logged plays 
regardless of user, and could possibly be used to compute game wide statistics.

```
PlaysRequest request = new PlaysRequest(id: 822);
PlaysResponse response = await bgg.GetPlaysAsync(request);
PlaysResponse.PlaysCollection collection = response.Result;
```

### Get all logged plays of a game for a player

This example gets the most recent 100 logged plays of Carcassonne (#822) for a user.

```
PlaysRequest request = new PlaysRequest("jakefromstatefarm", 822);
PlaysResponse response = await bgg.GetPlaysAsync(request);
PlaysResponse.PlaysCollection collection = response.Result;
```

### Search for an item by name

This example searches the boardgamegeek.com database for a board game by its name then loads the game information.

```
SearchRequest sRequest = new SearchRequest("Brass: Birmingham");
SearchResponse sResponse = await bgg.SearchAsync(sRequest);
SearchResponse.Item gameRef = sResponse.Result.Items.FirstOrDefault();

if (item != null)
{
    ThingRequest tRequest = new ThingRequest(new int[] { item.Id });
    ThingResponse tResponse = await bgg.GetThingAsync(tRequest);
    ThingResponse.Item game = tResponse.Result.Items.FirstOrDefault();
}

```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

BoardGamer.BoardGameGeek

BoardGamer.BoardGameGeek 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

BoardGamer.BoardGameGeek

BoardGamer.BoardGameGeek 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README