POST
/
analyze
curl --request POST \
  --url https://api.stoaty.com/analyze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "http://…",
  "nocache": false,
  "currency": "USD",
  "country": "US"
}'
{
  "product": {
    "name": "Macbook Air M2",
    "description": "An Apple laptop",
    "canonical": "https://…",
    "images": [
      "https://…",
      "https://…"
    ],
    "price": 1199.99,
    "originalPrice": 1299.9,
    "currency": "USD",
    "originalCurrency": "EUR",
    "available": true,
    "sku": "9278451",
    "brand": "Apple",
    "color": "Black",
    "size": "13 inches"
  },
  "metadata": {
    "success": true,
    "cached": false,
    "executionTime": 1120,
    "tokens": {
      "consumed": 1,
      "remaining": 13489
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
Configuration for the analysis
​
url
string
required

The url of the product to analyze

Example:

"http://…"

​
nocache
boolean
default:false

Disable the abilit to pull the informations from the cache, consume token

​
currency
string

The currency symbol (ISO 4217) you want the price converted to

Example:

"USD"

​
country
string

The country code (ISO 3166-1 alpha-2) you want to request the website from (does not work for all domains)

Example:

"US"

Response

200
application/json
Analysis response
​
product
object

The product analyzed

​
metadata
object

The metadata concerning the request

Was this page helpful?