LegoSharp 7.0.0

LegoSharp

LegoSharp is an unofficial C# library for interacting with Lego's web APIs.

Basic Usage

Searching the Lego graph is currently the only supported action.

To search the graph, make a graph client:

LegoGraphClient graphClient = new LegoGraphClient();

You can then query different graph APIs.

Pick a Brick

You can query Pick a Brick:

LegoGraphClient graphClient = new LegoGraphClient();

PickABrickQuery query = new PickABrickQuery();
query.addFilter(new BrickColorFilter()
    .addValue(BrickColor.Black)
);
query.query = "wheel";

PickABrickResult result = await graphClient.pickABrick(query);
foreach (Brick brick in result.elements)
{
    // do something with each brick
}

Product Search

You can query for Lego Products:

LegoGraphClient graphClient = new LegoGraphClient();

ProductSearchQuery query = new ProductSearchQuery();
query.addFilter(new ProductTypeFilter()
    .addValue(ProductType.Sets)
);
query.addFilter(new ProductPriceFilter()
    .fromTo(1000, 2500)
);
query.query = "train";

ProductSearchResult result = await graphClient.productSearch(query);
foreach (Product product in result.products)
{
    // do something with each product
}

Advanced Usage

There is also built in functionality to scrape the Lego graph.

Scraping Facets

Items in the graph (products and bricks), are made up of facets. You can scrape for facets by making a facet scraper:

FacetScraper facetScraper = new FacetScraper<ProductSearchQuery, ProductSearchResult>(new List<ProductSearchQuery> { new ProductSearchQuery() }, new ProductSearchFacetExtractor());

The facet scraper takes in a list of queries. It uses the results of these queries to scrape facets. Scraping a facet means to get all of its current possible values.

You can use scrapeFacet to scrape a specific facet:

facetScraper.scrapeFacet("variants.attributes.flags.key", "product.facet.flags");

Or you can use scrapeFacets to scrape all available facets:

facetScraper.scrapeFacets();

Contributing

Contributions are welcome. I'd reccomend first opening an issue for what you want to add so we can talk about implementation details. When you're ready to code, simply fork, make your changes, and then open a pull request. I will ask you to add tests for most code changes, and tests are required to pass before merging.

Why does this exist?

This library exists for a few reasons:

1. I wanted to see what it is like to reverse engineer an API.
2. I like Legos (though I don't buy them that often, they're pretty expensive...).
3. I work in TS for my day job, so I wanted to do a project in another language. Since C# is used a lot where I work, I chose it. Not only am I keeping myself familiar in C#, it's also fun to see how my TS brain handles having to work in C#.