scrapelyDocs
Docs / Introduction

Getting started

Introduction

Scrapely is one API for retail product data: price, stock, seller and more from Amazon, Walmart, Target and Best Buy, in one response shape, paid per item. Watchlists check your items on a schedule and push what changed to you.

What you can do

ProductsPrice, stock, seller and details for a batch of item ids, on any live platform, in one response shape.OffersEvery seller on a listing, and whether an exact offer can still be bought.WatchlistsItem ids and a schedule in, signed change events out. Build your own pipeline of steps.WebhooksSigned HTTPS callbacks for watchlist events, with one signing secret per endpoint.PlatformsWhich retailers and marketplaces are live, and what their item ids look like.Credits & tiersWhat each call costs. Failed lookups are always refunded.

How it works

  1. Send a platform, a marketplace and a list of item ids to POST /v1/products.
  2. Get one result per item, in the order you sent them, each with a status: ok, partial, not_found or unavailable.
  3. Pay credits only for definitive answers (ok and not_found). Anything we could not answer is refunded automatically.

The response shape is the same on every platform: neutral fields such as price, availability and seller, plus a namespaced object with what only that platform has. See Platforms & marketplaces for what is live.

Base URL

https://api.scrapelyserp.com/v1

Every endpoint lives under /v1. New fields and new endpoints are added without notice; breaking changes ship as a new version.

Conventions

  • JSON in, JSON out. GET endpoints take query parameters; POST endpoints take a JSON body.
  • Request parameters and resource fields are snake_case; product fields inside item results are camelCase.
  • Timestamps are ISO 8601 in UTC. Prices are numbers in the marketplace currency, named beside them.
  • Every response carries X-Request-Id. Quote it when you contact support.
  • Errors always look like { "error": { "code", "message", "param", "docs" } }. Branch on code (Errors).
  • The machine-readable spec is /v1/openapi.json (OpenAPI 3.1), rendered as the API reference.

Next steps

QuickstartYour first product call and your first watchlist in five minutes.AuthenticationCreate a key and send it with every request.Credits & tiersWhat each call costs, and what is refunded.