curl --request GET \
--url https://api.syntalic.com/v1/analyst/retailer-indeximport requests
url = "https://api.syntalic.com/v1/analyst/retailer-index"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/analyst/retailer-index', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.syntalic.com/v1/analyst/retailer-index",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.syntalic.com/v1/analyst/retailer-index"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syntalic.com/v1/analyst/retailer-index")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/analyst/retailer-index")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"retailer": "amazon",
"category": "health-beauty",
"department": null,
"country": "us",
"currency": "USD",
"window": {
"preset": "custom",
"from": "2026-10-26",
"to": "2026-11-18",
"granularity": "weekly",
"timezone": "UTC"
},
"sample_threshold": 5,
"insufficient_sample_points": 0,
"insufficient_sample": false,
"stable_basket_size": 102,
"coverage": {
"products": 102,
"sufficient": true
},
"freshness": {
"observedThrough": "2026-11-18T06:15:36.390Z",
"staleHours": 28.2
},
"quality": {
"platform": "shopify",
"country": "us",
"category_root": "health-beauty",
"quality_status": "serving",
"is_serving_eligible": true,
"priced_product_count": "71673",
"recent_priced_product_count": "70608"
},
"time_series": [
{
"date": "2026-10-26",
"retailer_avg_price": 30.01,
"category_avg_price": 41.1,
"price_index": 0.73,
"product_count": 117,
"stable_avg_price": 28.95,
"insufficient_sample": false,
"sample_threshold": 5
},
{
"date": "2026-10-27",
"retailer_avg_price": 29.97,
"category_avg_price": 41.4,
"price_index": 0.724,
"product_count": 118,
"stable_avg_price": 28.98,
"insufficient_sample": false,
"sample_threshold": 5
}
],
"resolved": {
"category_id": null,
"category_path": "health-beauty",
"match_source": "slug",
"match_confidence": 0.35,
"alternates": []
},
"meta": {
"served_from": "live",
"freshness_seconds": 101559,
"schema_version": "v3",
"computed_at": "2026-11-19T10:28:15.392Z",
"publish_id": "0f6dbfc5-4a04-49b5-9a4e-257d6af4b0c4",
"published_at": "2026-11-19T07:56:57.632Z"
}
}{
"type": "<string>",
"title": "Bad Request",
"status": 400,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Payment Required",
"status": 402,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Not Found",
"status": 404,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Conflict",
"status": 409,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Unprocessable Content",
"status": 422,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Too Many Requests",
"status": 429,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Service Unavailable",
"status": 503,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Price index for a specific retailer over time
Compute a normalized price index (retailer avg / category avg) for a specific retailer day-by-day versus its category baseline. Points report insufficient_sample below sample_threshold products plus stable_avg_price over the products priced every day — read trends from the stable series.
curl --request GET \
--url https://api.syntalic.com/v1/analyst/retailer-indeximport requests
url = "https://api.syntalic.com/v1/analyst/retailer-index"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/analyst/retailer-index', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.syntalic.com/v1/analyst/retailer-index",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.syntalic.com/v1/analyst/retailer-index"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.syntalic.com/v1/analyst/retailer-index")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/analyst/retailer-index")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"retailer": "amazon",
"category": "health-beauty",
"department": null,
"country": "us",
"currency": "USD",
"window": {
"preset": "custom",
"from": "2026-10-26",
"to": "2026-11-18",
"granularity": "weekly",
"timezone": "UTC"
},
"sample_threshold": 5,
"insufficient_sample_points": 0,
"insufficient_sample": false,
"stable_basket_size": 102,
"coverage": {
"products": 102,
"sufficient": true
},
"freshness": {
"observedThrough": "2026-11-18T06:15:36.390Z",
"staleHours": 28.2
},
"quality": {
"platform": "shopify",
"country": "us",
"category_root": "health-beauty",
"quality_status": "serving",
"is_serving_eligible": true,
"priced_product_count": "71673",
"recent_priced_product_count": "70608"
},
"time_series": [
{
"date": "2026-10-26",
"retailer_avg_price": 30.01,
"category_avg_price": 41.1,
"price_index": 0.73,
"product_count": 117,
"stable_avg_price": 28.95,
"insufficient_sample": false,
"sample_threshold": 5
},
{
"date": "2026-10-27",
"retailer_avg_price": 29.97,
"category_avg_price": 41.4,
"price_index": 0.724,
"product_count": 118,
"stable_avg_price": 28.98,
"insufficient_sample": false,
"sample_threshold": 5
}
],
"resolved": {
"category_id": null,
"category_path": "health-beauty",
"match_source": "slug",
"match_confidence": 0.35,
"alternates": []
},
"meta": {
"served_from": "live",
"freshness_seconds": 101559,
"schema_version": "v3",
"computed_at": "2026-11-19T10:28:15.392Z",
"publish_id": "0f6dbfc5-4a04-49b5-9a4e-257d6af4b0c4",
"published_at": "2026-11-19T07:56:57.632Z"
}
}{
"type": "<string>",
"title": "Bad Request",
"status": 400,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Payment Required",
"status": 402,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Not Found",
"status": 404,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Conflict",
"status": 409,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Unprocessable Content",
"status": 422,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Too Many Requests",
"status": 429,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"type": "<string>",
"title": "Service Unavailable",
"status": 503,
"detail": "<string>",
"instance": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Query Parameters
Retailer platform key (e.g., amazon, walmart). A retailer that is not serving-eligible in the country is a free 404 before payment that lists the ones that are. So is one with no serving-eligible products on the taxonomy roots the category or department resolves to: its side of the index would be empty, and error.details.retailer_roots lists the roots it is served on.
Product category in the Shopify product taxonomy. Accepts a display path (e.g. 'Electronics > Computers > Laptops'), its slug form (e.g. 'electronics/computers/laptops'), a single path segment (e.g. 'laptops', 'headphones'), or an everyday shelf name (e.g. 'apparel', 'beauty', 'grocery'); matched against the catalog's category tree (exact node, subtree, or whole path segment). Also accepts a GS1 GPC code (exactly 8 digits, e.g. '10001159') to filter by PRODUCT TYPE instead of by shelf placement — the same product type is shelved under different categories by different retailers, so a category filter answers from a fraction of the data while a GPC code spans them. Coarser codes (class/family/segment) match every brick beneath them. Resolve a phrase to a code with /v1/reference/classify?q=... ; when a code is used, resolved.match_source is 'gpc'. Some product types are filed under more than one department (e.g. Protein Bars under both Food and Health & Beauty); add include_homes=true to read every home of such a type as one shelf. For analyst endpoints, supply either category or department; both may be supplied to narrow the scope.
1A Shopify taxonomy root, e.g. 'Electronics' or 'Food, Beverages & Tobacco'. Case-insensitive; matched against that root and nothing under it. A name that is not a root, including a retired browse department such as 'Grocery' or 'Home & Kitchen', is refused before payment and the response names the roots to send. For analyst endpoints, supply either category or department; both may be supplied to narrow the scope.
1Historical window preset. Explicit from/to takes precedence and is reported as custom; time_window=custom requires both from and to. Date-only ranges use UTC calendar boundaries with inclusive from and exclusive to.
last_30_days, last_60_days, last_90_days, month_to_date, previous_month, month_over_month, quarter_to_date, custom Optional. Pin the answer to a serving publish: pass meta.publish_id from an earlier answer. When the served snapshot has moved on, or cannot be confirmed, the request is answered 409 PUBLISH_CHANGED naming the current publish, before any payment challenge and free. Use it to keep several answers on one snapshot.
1A product type by GS1 GPC id, from GET /v1/ontology/resolve (a product_type match's id). Covers EVERY shelf the type is filed under, so a type shelved in two departments is one scope (category=<8 digits> filters by browse-node placement). Send it instead of category= or spt=, not with them.
^gpc:[0-9]{8}$A chain by id, from GET /v1/ontology/resolve (a retailer match's id): the chain (seller_norm) whatever lane its listings were scraped through, never a lane. retailer= matches the scrape lane, so a Shopify store's chain can only be asked for by id (#1090). Send it instead of retailer=, not with it.
^retailer:[a-z0-9]{1,64}$Response
Retailer index data