ShopSavvy Java SDK

A Java client for the ShopSavvy Data API. Built for Spring Boot and any JVM application with Maven Central distribution.

Set up ShopSavvy Java 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:

   <dependency>
     <groupId>com.shopsavvy</groupId>
     <artifactId>shopsavvy-sdk</artifactId>
     <version>1.1.0</version>
   </dependency>

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-java README (30-Second Quick Start):

   <!-- Add to pom.xml: -->
   <!-- <dependency>
       <groupId>com.shopsavvy</groupId>
       <artifactId>shopsavvy-sdk</artifactId>
       <version>1.4.0</version>
   </dependency> -->
   
   // Use in Java/Spring Boot:
   import com.shopsavvy.sdk.*;
   import com.shopsavvy.sdk.models.*;
   
   public class QuickExample {
       public static void main(String[] args) {
           ShopSavvyClient client = new ShopSavvyClient("ss_live_your_api_key_here");
           
           try {
               ApiResponse<ProductDetails> product = client.getProductDetails("012345678901");
               ApiResponse<List<Offer>> offers = client.getCurrentOffers("012345678901");
               
               Offer bestOffer = offers.getData().stream()
                   .min((o1, o2) -> Double.compare(o1.getPrice(), o2.getPrice()))
                   .orElse(null);
               
               System.out.printf("%s - Best price: $%.2f at %s%n",
                   product.getData().getName(),
                   bestOffer.getPrice(),
                   bestOffer.getRetailer());
                   
           } catch (ShopSavvyApiException e) {
               System.err.println("Error: " + e.getMessage());
           } finally {
               client.close();
           }
       }
   }

   Copied from the repository README.

5. 5

   Client Configuration

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

   import com.shopsavvy.sdk.*;
   import com.shopsavvy.sdk.exceptions.*;
   
   // Basic configuration
   ShopSavvyClient client = new ShopSavvyClient("ss_live_your_api_key_here");
   
   // Advanced configuration
   ShopSavvyClient client = new ShopSavvyClient.Builder()
       .apiKey("ss_live_your_api_key_here")
       .baseUrl("https://api.shopsavvy.com/v1")     // Custom base URL
       .timeoutSeconds(60)                          // Request timeout
       .retryAttempts(3)                           // Retry failed requests
       .userAgent("MyApp/1.0.0")                   // Custom user agent
       .connectionPoolSize(10)                     // Connection pool size
       .build();
   
   // Environment variable configuration
   String apiKey = System.getenv("SHOPSAVVY_API_KEY");
   if (apiKey == null) {
       throw new IllegalStateException("SHOPSAVVY_API_KEY environment variable not set");
   }
   ShopSavvyClient client = new ShopSavvyClient(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