Skip to navigation
Get started

Quickstart

From API key to your first tracked listing.
View as Markdown
1

Create an API key

Sign in to the dashboard and create a key as Authentication shows. API access is on the Growth and Business plans. The key is shown once: store it somewhere safe, such as your secrets manager.

2

Check the key works

curl https://getoutprice.com/v1/tracked-items \
  -H "X-API-Key: $OUTPRICE_API_KEY"

You get back the listings you already track (an empty list on a new account).

3

Track a competitor’s listing

curl https://getoutprice.com/v1/tracked-items \
  -H "X-API-Key: $OUTPRICE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "source_url": "https://www.daraz.pk/products/example-i123456789.html",
        "category_tags": ["headphones"],
        "acknowledge_tos": true
      }'

acknowledge_tos confirms that monitoring the listing is your decision; a listing is never tracked without it. The first price check runs within a few minutes.

4

Read its price history

curl https://getoutprice.com/v1/tracked-items/42/history \
  -H "X-API-Key: $OUTPRICE_API_KEY"

In code

import os
import requests
API = "https://getoutprice.com/v1"
session = requests.Session()
session.headers["X-API-Key"] = os.environ["OUTPRICE_API_KEY"]
items = session.get(f"{API}/tracked-items", timeout=30)
items.raise_for_status()
for item in items.json():
    print(item["id"], item["title"], item["status"])