Back to Documentation

Quick Start Guide

Get up and running with RivalPrice API in less than 5 minutes

Prerequisites

  • A RivalPrice account (sign up for free at rivalprice.app)
  • An active subscription or trial (check your plan at pricing)
  • Basic knowledge of REST APIs and your programming language of choice
1

Get Your API Key

First, you'll need to create an API key from your dashboard:

  1. Log in to your RivalPrice account
  2. Click on your profile in the top right corner
  3. Select "API Keys" from the dropdown menu
  4. Click "Create API Key"
  5. Give your key a descriptive name (e.g., "Production" or "Development")
  6. Copy the generated key and store it securely

Important: Your API key is only shown once when created. Make sure to copy and save it securely. You won't be able to view it again.

2

Create Your First Product

Products represent the items you want to monitor. Let's create one using the API:

POSTCreate Product
Create a new product to monitor

Your API key is only used in your browser and never stored

Request URL
https://api.rivalprice.app/products
What just happened?

You created a product with:

  • name: A descriptive name for your product
  • sku: Your internal product identifier (optional)
  • customer_price: The price you sell it for (optional, used for comparisons)

Save the id from the response - you'll need it in the next step!

3

Add Competitor URLs

Now add competitor URLs to track. Use the product ID from the previous step:

POSTAdd Competitor URL
Add a competitor URL to monitor

Your API key is only used in your browser and never stored

Request URL
https://api.rivalprice.app/products/:product_id/competitors
Tips for adding URLs
  • Use the exact product page URL (not category pages)
  • Make sure the URL shows the product price when you visit it
  • You can add multiple competitor URLs per product
  • Popular sites like Amazon, Best Buy, Walmart, and Newegg work great
4

Retrieve Product & Prices

Fetch your product details including all competitor URLs and their price history:

GETGet Product Details
Retrieve product with competitor URLs and price history

Your API key is only used in your browser and never stored

Request URL
https://api.rivalprice.app/products/:product_id
Understanding the Response

The response includes:

  • competitor_urls: All URLs you're monitoring with their latest prices
  • recent_history: Historical price data from scrapes
  • scraped_at: When each price was last checked

Prices are automatically scraped based on your plan's schedule (weekly for most plans).

5

List All Your Products

Get a list of all products you're monitoring:

GETList Products
Get all your products

Your API key is only used in your browser and never stored

Request URL
https://api.rivalprice.app/products

Next Steps

Set Up Webhooks
Get real-time notifications when competitor prices change
Explore Full API
See all available endpoints and advanced features
Rate Limits
Learn about API rate limits and best practices
Dashboard
Manage your products and view prices in the web dashboard
Need Help?
We're here to help you get started

If you run into any issues or have questions:

API ReferenceFAQContact Support