Platforms

Which retailers and marketplaces are live, their id fields, endpoints, tiers and prices. Public: no key needed.

Embed
Preview of the card
<a href="https://scrapelyserp.com/reference/platforms"><img src="https://scrapelyserp.com/reference/_api/public/orgs/affc5b0f-d3c2-423a-8143-9d10db5736ae/spaces/e4cbe065-c1c2-4572-b134-0292dedd9c39/pages/db1c11f5-640b-46d7-91e5-d90fdff3fd23/social-card.svg?v=3e7ae33eec8b" alt="Platforms" width="600" height="315"></a>

Which retailers and marketplaces are live, their id fields, endpoints, tiers and prices. Public: no key needed.

Endpoints

Method

Path

Does

GET

/v1/platforms

List platforms and marketplaces

How it works, when to use what, and what it costs: Platforms & marketplaces. Base URL, authentication and errors: Overview.

GET /v1/platforms

List platforms and marketplaces. No API key needed.

Every platform this API reads, its marketplaces (each with its currency), and the endpoints each marketplace offers, live or coming_soon, with tiers and prices. Public: no key needed. Use it to discover coverage instead of hard-coding it.

Request

curl "https://api.scrapelyserp.com/v1/platforms"

Response

{
  "object": "list",
  "data": [
    {
      "id": "bestbuy",
      "object": "platform",
      "name": "Best Buy",
      "status": "live",
      "id_field": "ids",
      "id_name": "SKU",
      "default_marketplace": "us",
      "endpoints": [
        {
          "id": "products",
          "name": "Product data",
          "route": "POST /v1/products",
          "status": "live",
          "tiers": [
            {
              "id": "standard",
              "name": "Standard",
              "credits_per_item": 1,
              "max_items_per_call": 1000
            }
          ]
        }
      ],
      "marketplaces": [
        {
          "code": "us",
          "name": "Best Buy US",
          "country": "US",
          "currency": "USD",
          "status": "live",
          "endpoints": {
            "products": "live"
          }
        },
        {
          "code": "ca",
          "name": "Best Buy Canada",
          "country": "CA",
          "currency": "CAD",
          "status": "coming_soon",
          "endpoints": {
            "products": "coming_soon"
          }
        }
      ]
    }
  ]
}

Responses

Status

Meaning

200

The platforms.

Response fields

Field

Type

Description

object

"list"

—

data

object[]

—

data[].id

string

The platform value.

data[].object

"platform"

—

data[].name

string

—

data[].status

string

One of: live, coming_soon.

data[].id_field

string

The request field for item ids (ids is always accepted too).

data[].id_name

string

—

data[].default_marketplace

string

—

data[].endpoints

object[]

—

data[].marketplaces

object[]

—

Updated