ShopSavvy C# SDK

A .NET client for the ShopSavvy Data API. Built for .NET 6+ with NuGet distribution. Works with ASP.NET Core, Blazor, MAUI, and console apps.

Set up ShopSavvy C# SDK

1. 1

   Get a ShopSavvy Data API key

   Create a key at shopsavvy.com/data. Keys look like ss_live_ followed by 32 characters. Keep it out of source control.

2. 2

   Install

   Add the ShopSavvy SDK to your project:

   dotnet add package ShopSavvy.Sdk

3. 3

   Add your API key

   Set the SHOPSAVVY_API_KEY environment variable to your key (shell, .env file or your secrets manager), or pass it to the client as the README shows.

4. 4

   Make your first call

   From the shopsavvy/sdk-csharp README (30-Second Quick Start):

   // Install
   // dotnet add package ShopSavvy.Sdk
   
   // Use
   using ShopSavvy.DataApi;
   
   var client = new ShopSavvyDataApiClient("ss_live_your_api_key_here");
   var product = await client.GetProductDetailsAsync("012345678901");
   var offers = await client.GetOffersAsync("012345678901");   // one entry per product, each with Offers
   var bestPrice = offers.Data[0].Offers.Where(o => o.Price.HasValue).MinBy(o => o.Price);
   Console.WriteLine($"{product.Data.Title} - Best price: ${bestPrice.Price:F2} at {bestPrice.Retailer}");

   Copied from the repository README.

5. 5

   Client Configuration

   From the shopsavvy/sdk-csharp README (Client Configuration):

   // Basic configuration
   using var client = new ShopSavvyDataApiClient("ss_live_your_api_key_here");
   
   // Advanced configuration
   var config = new ShopSavvyConfig
   {
       ApiKey = "ss_live_your_api_key_here",
       BaseUrl = "https://api.shopsavvy.com/v1",  // Custom base URL
       Timeout = TimeSpan.FromSeconds(60),        // Request timeout
       RetryAttempts = 3,                         // Retry failed requests
       RetryDelay = TimeSpan.FromSeconds(1),      // Delay between retries
       UserAgent = "MyApp/1.0.0"                  // Custom user agent
   };
   
   using var client = new ShopSavvyDataApiClient(config);
   
   // Environment variable configuration
   var apiKey = Environment.GetEnvironmentVariable("SHOPSAVVY_API_KEY");
   using var client = new ShopSavvyDataApiClient(apiKey);

   Copied from the repository README.

Keys come with a Data API plan. See plans.

Features

Use Cases

What data, how often, which direction

Data

Product records, current offers from tens of thousands of retailers and price history back to 2011, dense from 2019, from the ShopSavvy Data API. Prices are in US dollars.

How often

Every offer carries the time it was last checked. With the Data API you can schedule refreshes hourly, daily or weekly for retailers we can re-check through an official retailer API; other retailers update as ShopSavvy sees them.

Direction

ShopSavvy data flows into your code. Requests carry only what you ask about (identifiers, search terms or schedules) and your API key.

FAQ