ShopSavvy for CLI
TypeScriptA command-line interface for searching products, comparing prices, viewing price history, browsing deals, and monitoring prices — all from your terminal.
Set up ShopSavvy for CLI
- 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
Add the ShopSavvy CLI integration to your project:
brew install shopsavvy/shopsavvy/shopsavvy - 3
Add your API key
Set the SHOPSAVVY_API_KEY environment variable to your key (shell, .env file or CLI's secrets settings), or pass it to the client as the README shows.
- 4
Make your first call
From the shopsavvy/shopsavvy-cli README (Setup):
# Save your API key shopsavvy config set-key ss_live_your_key_here # Or use an environment variable export SHOPSAVVY_API_KEY=ss_live_your_key_hereCopied from the repository README.
- 5
Check API usage
From the shopsavvy/shopsavvy-cli README (Check API usage):
shopsavvy usageCopied from the repository README.
- 6
Configuration
From the shopsavvy/shopsavvy-cli README (Configuration):
shopsavvy config set-key KEY # Save API key shopsavvy config show # Show current config shopsavvy config clear # Remove saved keyCopied 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 CLI. 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 CLI 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.
Is it open source?
Yes. The source is on GitHub at https://github.com/shopsavvy/shopsavvy-cli 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.