Quickstart

Make your first Price Hero API request in under 5 minutes.

1. Get your API key

  1. Sign in (or create an account) at pricehero.ai
  2. Go to Developer Dashboard → API Keys
  3. Click Create key, give it a name, and copy the key

You'll get a key that looks like:

  • Sandbox: ph_test_a1b2c3d4e5f6...
  • Live: ph_live_a1b2c3d4e5f6...

Start with a sandbox key — it's free and works against a subset of the catalog.

Want to explore before writing code? Open the API Explorer, paste your key, and try any endpoint interactively. You'll see real responses from the API without writing a single line of code.

2. Search the catalog

You'll get back a list of matching catalog items:

{
  "success": true,
  "results": 1,
  "total_results": 14,
  "page": 0,
  "total_pages": 1,
  "credits_used": 1,
  "includes": ["taxonomy"],
  "resolved_taxonomy": { "node": "product", "level": 3 },
  "data": [
    {
      "id": "product_K9xLpQ2vZrT7mN4cHs8YbEwUdA1FgR6jX0qP",
      "name": "Louis Vuitton Speedy 30",
      "attributes": [
        { "field": "category", "id": "cat_handbags", "name": "Handbags" },
        { "field": "brand", "id": "brand_R7xVn3LpQ2sK8mTz", "name": "Louis Vuitton" },
        { "field": "model", "id": "model_S2mZyGgh6nWi", "name": "Speedy" },
        { "field": "style", "id": "style_abc123", "name": "Speedy 30" }
      ],
      "popularity": 85,
      "variants": [
        {
          "id": "variant_Z4mQx8TnLpR2sV7c",
          "fields": [
            { "field": "size", "name": "30" },
            { "field": "material", "name": "Monogram Canvas" }
          ],
          "images": ["https://cdn.pricehero.ai/img/variant_Z4mQx8TnLpR2sV7c.jpg"],
          "thumbnails": ["https://cdn.pricehero.ai/thumb/variant_Z4mQx8TnLpR2sV7c.jpg"],
          "popularity": 92
        }
      ]
    }
  ]
}

3. Identify from a photo

curl -X POST https://api.pricehero.ai/v3/vision/identify \
  -H "Authorization: Bearer ph_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/my-bag.jpg"
  }'

Next steps

  • Authentication — understand API key types and scopes
  • Credits — how billing works per request
  • Sandbox mode — test safely without affecting live data
  • API Reference — full endpoint documentation (v3; switch version in the sidebar for legacy v1/v2)
Quickstart — Price Hero Docs