Amazon product API

Get a product's price, details and rating

curl --request POST \
  --url https://api.stophy.dev/v1/amazon/product \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productUrl": "<string>",
  "productId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({productUrl: '<string>', productId: '<string>'})
};

fetch('https://api.stophy.dev/v1/amazon/product', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/amazon/product"

payload = {
    "productUrl": "<string>",
    "productId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "productUrl": "<string>",
    "bullets": [
      "<string>"
    ],
    "imageUrls": [
      "<string>"
    ],
    "variants": [
      {
        "productId": "<string>",
        "options": "<string>"
      }
    ],
    "categories": [
      "<string>"
    ],
    "bestSellersRank": [
      {
        "rank": 0,
        "category": "<string>"
      }
    ],
    "specs": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "topReviews": [
      {
        "isVerified": true,
        "reviewId": "<string>",
        "authorName": "<string>",
        "rating": 123,
        "title": "<string>",
        "text": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z",
        "variant": "<string>",
        "helpfulVotes": 0,
        "imageUrls": [
          "<string>"
        ]
      }
    ],
    "productId": "<string>",
    "title": "<string>",
    "brand": "<string>",
    "price": 1,
    "originalPrice": 1,
    "priceCurrency": "<string>",
    "availability": "<string>",
    "rating": 123,
    "reviews": 0,
    "description": "<string>",
    "sellerName": "<string>",
    "sellerId": "<string>",
    "sellerShipsFrom": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

amazon

product

Get a product's price, details and rating

curl --request POST \
  --url https://api.stophy.dev/v1/amazon/product \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productUrl": "<string>",
  "productId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({productUrl: '<string>', productId: '<string>'})
};

fetch('https://api.stophy.dev/v1/amazon/product', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/amazon/product"

payload = {
    "productUrl": "<string>",
    "productId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "productUrl": "<string>",
    "bullets": [
      "<string>"
    ],
    "imageUrls": [
      "<string>"
    ],
    "variants": [
      {
        "productId": "<string>",
        "options": "<string>"
      }
    ],
    "categories": [
      "<string>"
    ],
    "bestSellersRank": [
      {
        "rank": 0,
        "category": "<string>"
      }
    ],
    "specs": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "topReviews": [
      {
        "isVerified": true,
        "reviewId": "<string>",
        "authorName": "<string>",
        "rating": 123,
        "title": "<string>",
        "text": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z",
        "variant": "<string>",
        "helpfulVotes": 0,
        "imageUrls": [
          "<string>"
        ]
      }
    ],
    "productId": "<string>",
    "title": "<string>",
    "brand": "<string>",
    "price": 1,
    "originalPrice": 1,
    "priceCurrency": "<string>",
    "availability": "<string>",
    "rating": 123,
    "reviews": 0,
    "description": "<string>",
    "sellerName": "<string>",
    "sellerId": "<string>",
    "sellerShipsFrom": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Returns a product’s price, details and rating. The product is identified by its URL or ID.

Request

Exactly one of productUrl or productId is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.amazon.product({ productUrl: "https://www.amazon.com/dp/B0CX23V2ZK" });
console.log(result.data);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.amazon.product(product_url="https://www.amazon.com/dp/B0CX23V2ZK")
print(result["data"])

curl -X POST https://api.stophy.dev/v1/amazon/product \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"productUrl":"https://www.amazon.com/dp/B0CX23V2ZK"}'

stophy amazon product --productUrl https://www.amazon.com/dp/B0CX23V2ZK

Response

If successful, the response body contains the standard envelope. data contains the product’s price, rating, description points, images, variants and seller. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "productId": "B0HDB41H28",
    "productUrl": "https://www.amazon.com/dp/B0HDB41H28",
    "title": "Wireless Earbuds, Bluetooth 5.3 Headphones HiFi Stereo 50H Playback LED Digital Display Ear Buds with ENC Noise…",
    "brand": "Fhumsh",
    "price": 18.98,
    "originalPrice": 249.99,
    "priceCurrency": "USD",
    "availability": "In Stock",
    "rating": 4.6,
    "reviews": 270,
    "bullets": ["Ergonomic Wireless Earbuds for All-Day Wear:3-size medical-grade gel tips (S/M/L) conform to 99% ear contours,…"],
    "imageUrls": ["https://m.media-amazon.com/images/I/618n7fFdFXL._AC_SL1500_.jpg"],
    "variants": [
      {
        "productId": "B0HDHBQ98Q",
        "options": "Color: Rosegold"
      }
    ],
    "sellerName": "Fhumsh-JW US",
    "sellerId": "A2ZKWS9M1UYYSZ",
    "sellerShipsFrom": "Amazon",
    "categories": ["Electronics"],
    "bestSellersRank": [
      {
        "rank": 48,
        "category": "Electronics"
      }
    ],
    "specs": [
      {
        "name": "Brand",
        "value": "Fhumsh"
      }
    ]
  },
  "creditsUsed": 2,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`rank`	integer	The product’s rank among the best sellers in that category.
`rating`	number	The average star rating, on a scale of 1 to 5.
`reviews`	integer	The number of reviews the rating is based on.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`country`	string	The country to query, as a two-letter ISO 3166-1 code such as `us`. Accepts one of 21 values, such as `us`, `gb` and `de`.

Billing

Each successful request consumes 2 credits, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

This method is not paginated. A single request returns the complete result.

Amazon search: Accepts the product’s title as query. Searches Amazon products.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

productUrl

string

Link to the Amazon product, like https://www.amazon.com/dp/B0CX23V2ZK. Send this or productId.

productId

string

Amazon product ASIN, like B0CX23V2ZK. Send this or productUrl.

country

enum<string>

ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted.

Available options:

us,

gb,

de,

fr,

it,

es,

ca,

jp,

in,

au,

mx,

br,

nl,

se,

pl,

sg,

ae,

sa,

tr,

be,

eg

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Amazon product API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods