Getting Started

From zero to product data in under 5 minutes. No complex setup required.

1

Scan a Store

Paste any e-commerce URL. ShelfRun auto-detects the platform, finds all products, and shows you a preview.

curl -X POST https://api.shelfrun.com/api/scan \
  -H "Content-Type: application/json" \
  -d '{"url": "allbirds.com"}'
Response:
{
  "platform": "shopify",
  "product_count_estimate": 704,
  "extraction_confidence": "high",
  "sample_products": [...]
}
2

Create an Account

Sign up for free. You get 5 free syncs — no credit card required. Add your first store from the welcome page.

Sign Up Free
3

Get Your API Key

Generate an API key from your dashboard. Use it to access the REST API, SDKs, or MCP server.

# Your API key works across all endpoints
curl -H "X-API-Key: sr_live_abc123..." \
  "https://api.shelfrun.com/v1/stores"
4

Fetch Product Data

Get structured product data — names, prices, images, stock status. Export as JSON, CSV, or Excel.

# Get all products from a tracked store
curl -H "X-API-Key: sr_live_abc123..." \
  "https://api.shelfrun.com/v1/stores/STORE_ID/products?limit=100"
Response:
{
  "products": [
    {
      "name": "Tree Runner Go",
      "price": 98.00,
      "in_stock": true,
      "image_url": "https://...",
      "url": "https://allbirds.com/products/..."
    }
  ],
  "total": 704
}
5

Set Up Alerts

Configure webhooks to get notified on price changes, stockouts, and new products. Works with Slack, n8n, Zapier, and any webhook receiver.

# Configure a webhook
curl -X PUT -H "X-API-Key: sr_live_abc123..." \
  -d '{"webhook_url": "https://hooks.slack.com/..."}' \
  "https://api.shelfrun.com/api/stores/STORE_ID/webhook"
6

Build & Scale

Use SDKs, MCP server, or the REST API to build integrations. Monitor hundreds of stores with scheduled syncs.

SDKs & Integrations

Python

pip install shelfrun

TypeScript

npm install shelfrun

MCP Server

npx @shelfrun/mcp

Ready to Go?

Scan your first store now. It takes 30 seconds.