Amazon search API

Search Amazon products

curl --request POST \
  --url https://api.stophy.dev/v1/amazon/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "wireless earbuds"
}
'

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

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

import requests

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

payload = { "query": "wireless earbuds" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "productUrl": "<string>",
        "isSponsored": true,
        "productId": "<string>",
        "title": "<string>",
        "imageUrl": "<string>",
        "price": 1,
        "originalPrice": 1,
        "priceCurrency": "<string>",
        "rating": 123,
        "reviews": 0,
        "boughtPastMonth": 0
      }
    ],
    "page": 0,
    "total": 0
  },
  "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

Search Amazon products

curl --request POST \
  --url https://api.stophy.dev/v1/amazon/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "wireless earbuds"
}
'

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

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

import requests

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

payload = { "query": "wireless earbuds" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "productUrl": "<string>",
        "isSponsored": true,
        "productId": "<string>",
        "title": "<string>",
        "imageUrl": "<string>",
        "price": 1,
        "originalPrice": 1,
        "priceCurrency": "<string>",
        "rating": 123,
        "reviews": 0,
        "boughtPastMonth": 0
      }
    ],
    "page": 0,
    "total": 0
  },
  "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"
  }
}

Searches Amazon products.

Request

This method has no required parameters.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.amazon.search({ query: "wireless earbuds" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.amazon.search(query="wireless earbuds")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/amazon/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"wireless earbuds"}'

stophy amazon search "wireless earbuds"

Response

If successful, the response body contains the standard envelope. data.results[] contains the products, each with its price, rating and review count. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "results": [
      {
        "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…",
        "imageUrl": "https://m.media-amazon.com/images/I/618n7fFdFXL._AC_UY218_.jpg",
        "price": 18.98,
        "originalPrice": 249.99,
        "priceCurrency": "USD",
        "rating": 4.6,
        "reviews": 270,
        "boughtPastMonth": 4000,
        "isSponsored": false
      }
    ],
    "total": 27654,
    "page": 1
  },
  "creditsUsed": 2,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`page`	integer	The page number of this response.
`total`	integer	The total number of matching results, across all pages.
`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
`query`	string	Words to search for.
`category`	string	The category to search in, by name or id.
`minPrice`	number	The minimum price.
`maxPrice`	number	The maximum price.
`minRating`	number	Restricts results to products rated at least this high.
`brand`	string	Restricts results to products from this brand.
`sort`	string	Specifies the order of the products. `avgCustomerReview` puts the highest rated first, not the most reviewed. Acceptable values are `relevance`, `priceLow`, `priceHigh`, `avgCustomerReview`, `newest` and `bestSelling`. If unset, defaults to `relevance`.
`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`. If unset, defaults to `us`.
`page`	integer	The page to return. Pages are numbered from 1. Must be between 1 and 20. If unset, defaults to `1`.

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

Results are paginated. To retrieve the next page, increment page. An empty data.results indicates the last page. The maximum value of page is 20.

Amazon product: Accepts productUrl. Returns a product’s price, details and rating.

Authorizations

Authorization

string

header

required

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

Body

application/json

query

string

Required string length: 1 - 300

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 search 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