ShopSavvy TypeScript SDK

A fully-typed TypeScript client for the ShopSavvy Data API. Works with Node.js, Bun, Deno, and browser environments.

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

   npm install @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-typescript README (Installation):

   npm install @shopsavvy/sdk
   # or
   yarn add @shopsavvy/sdk
   # or
   pnpm add @shopsavvy/sdk
   # or
   bun add @shopsavvy/sdk

   Copied from the repository README.

5. 5

   30-Second Example

   From the shopsavvy/sdk-typescript README (30-Second Example):

   import { createShopSavvyClient } from '@shopsavvy/sdk'
   
   // Initialize the client
   const api = createShopSavvyClient({
     apiKey: 'ss_live_your_api_key_here'
   })
   
   // Look up any product by barcode, ASIN, or URL
   const product = await api.getProductDetails('012345678901')
   console.log(`📦 ${product.data.name} by ${product.data.brand}`)
   
   // Get current prices from all retailers
   const offers = await api.getCurrentOffers('012345678901')
   const cheapest = offers.data.reduce((min, offer) => offer.price < min.price ? offer : min)
   console.log(`💰 Best price: $${cheapest.price} at ${cheapest.retailer}`)
   
   // Set up price monitoring
   await api.scheduleProductMonitoring('012345678901', 'daily')
   console.log('🔔 Price alerts activated!')

   Copied from the repository README.

6. 6

   Environment Setup

   From the shopsavvy/sdk-typescript README (Environment Setup):

   # Optional: Store your API key securely
   export SHOPSAVVY_API_KEY="ss_live_your_api_key_here"

   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

Related Integrations