ShopSavvy for Matrix Bot

TypeScript

A Matrix bot that responds to commands for product search, price comparison, and deal discovery. Auto-joins rooms when invited, sends rich HTML formatted messages.

View on GitHub Get Your API Key ⭐ Star on GitHub

Set up ShopSavvy for Matrix Bot

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
Get the integration from its repository and follow the README's install section: https://github.com/shopsavvy/matrix-shopsavvy-bot
```
git clone https://github.com/shopsavvy/matrix-shopsavvy-bot.git
```
3
Add your API key
Set the SHOPSAVVY_API_KEY environment variable to your key (shell, .env file or Matrix Bot's secrets settings), or pass it to the client as the README shows.

Make your first call

From the shopsavvy/matrix-shopsavvy-bot README (Setup):

export MATRIX_HOMESERVER=https://matrix.org
export MATRIX_ACCESS_TOKEN=your_matrix_access_token
export SHOPSAVVY_API_KEY=ss_live_your_key_here

bun run src/bot.ts

Copied from the repository README.

Keys come with a Data API plan. See plans.

Features

!ss search, !ss price, !ss deals commands

Rich HTML formatted messages

Auto-join rooms on invite

Best price badge on lowest offer

Use Cases

1.Price checks in privacy-focused chat

2.Deal sharing in Matrix communities

3.Product research in Element/Matrix rooms

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 Matrix Bot. 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 Matrix Bot 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/matrix-shopsavvy-bot 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 →