ShopSavvy for NestJS

TypeScriptBeta

A NestJS module that provides an injectable ShopSavvy service. Register with forRoot(), then inject into any controller or service.

View on GitHub Get Your API Key

Set up ShopSavvy for NestJS

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
Install from GitHub
The package in the install command (npm install nestjs-shopsavvy) is not on its public registry yet, so install from the source repository and follow its README:
```
git clone https://github.com/shopsavvy/nestjs-shopsavvy.git
```
3
Add your API key
Set the SHOPSAVVY_API_KEY environment variable to your key (shell, .env file or NestJS's secrets settings), or pass it to the client as the README shows.

Make your first call

From the shopsavvy/nestjs-shopsavvy README (Configuration):

ShopSavvyModule.forRoot({
  apiKey: process.env.SHOPSAVVY_API_KEY!,
  // optional
  timeout: 10000,       // request timeout in ms (default 30000)
  baseUrl: undefined,   // override the ShopSavvy API base URL
})

Copied from the repository README.

Keys come with a Data API plan. See plans.

Features

ShopSavvyModule.forRoot() registration

Injectable ShopSavvyService

All SDK methods wrapped

Access to raw client for advanced usage

Use Cases

1.Build NestJS price comparison APIs

2.Add product data to existing NestJS services

3.Create enterprise pricing dashboards

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 NestJS. Requests carry only what you ask about (identifiers, search terms or schedules) and your API key.

FAQ

Do I need an API key?

Yes. The NestJS integration calls the ShopSavvy Data API, which needs a Data API key. Create one at shopsavvy.com/data, then add it as the setup steps above show.

What data does it return?

ShopSavvy product records (title, brand, model, barcode, ASIN), current offers from tens of thousands of retailers with price, availability and condition, and price history back to 2011, dense from 2019. Products can be looked up by barcode, ASIN, URL or model number. Prices are in US dollars.

How fresh are the prices?

Every offer carries the time ShopSavvy last checked it, so you can see how current each price is. Through 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.

Is my API key stored securely?

The README has you supply it through the SHOPSAVVY_API_KEY environment variable or your own configuration, so it stays out of source code. The key is sent to the ShopSavvy API (api.shopsavvy.com) over HTTPS in the Authorization header. You can revoke a key and create a new one at shopsavvy.com/data/api-keys.

Can I install it from a package registry?

Not yet. The package named in its install command has not been published to its public registry, so install it from the GitHub repository (https://github.com/shopsavvy/nestjs-shopsavvy) for now.

Is it open source?

Yes. The source is on GitHub at https://github.com/shopsavvy/nestjs-shopsavvy under the MIT license.

Powered by the ShopSavvy Data API

This integration connects to the ShopSavvy Data API: product data and current prices from tens of thousands of retailers, across 30M+ products, with price history back to 2011, dense from 2019. Look up products by barcode, ASIN, URL or keyword, compare prices, read history and schedule refreshes.

Get Started Read the Docs →