curl --request GET \
--url https://api.syntalic.com/v1/measures/neighborsimport requests
url = "https://api.syntalic.com/v1/measures/neighbors"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/measures/neighbors', 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/measures/neighbors",
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/measures/neighbors"
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/measures/neighbors")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/measures/neighbors")
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{
"id": "gpc:10008059",
"kind": "product_type",
"label": "Protein Bars",
"country": "us",
"relations": {
"level": "brick",
"ancestry": {
"segment": "Food/Beverage",
"family": "Cereal/Grain/Pulse Products",
"class": "Processed Cereal Products"
},
"homes": [
{
"id": "spt:fb-2-17-2-4",
"label": "Food, Beverages & Tobacco > Food Items > Snack Foods > Cereal & Granola Bars > Protein Bars",
"key": "food-beverages-tobacco/food-items/snack-foods/cereal-granola-bars/protein-bars",
"role": "primary",
"cardinality": "1:1",
"listings": 232
},
{
"id": "spt:hb-1-9-1-2",
"label": "Health & Beauty > Health Care > Fitness & Nutrition > Nutrition Bars > Meal Replacement Bars",
"key": "health-beauty/health-care/fitness-nutrition/nutrition-bars/meal-replacement-bars",
"role": "primary",
"cardinality": "1:1",
"listings": 11
}
],
"siblings": {
"items": [
{
"id": "gpc:10000287",
"label": "Cereal/Muesli Bars"
},
{
"id": "gpc:10006250",
"label": "Cereal Products - Not Ready to Eat (Frozen)"
}
],
"total": 6,
"truncated": false
},
"aliases": {
"items": [
"high protein",
"high proteins"
],
"total": 7,
"truncated": false
}
},
"coverage": {
"listings": 1209,
"entities": 766,
"brands": null,
"retailers": 41,
"priced": 1209,
"fresh_24h": 0,
"fresh_7d": 456,
"fresh_7d_pct": 37.7,
"last_observed_at": "2026-11-17T07:23:19.919Z",
"channels_present": [
"ecommerce"
],
"channels_not_observed": [
"physical_store"
],
"priced_by_channel": {
"ecommerce": 1209
},
"retailers_scanned": [
"afarfoods",
"alaninu"
],
"n_retailers_scanned": 41,
"social": {
"mentions": 12,
"shelves": [
{
"id": "spt:fb-2-17-2-4",
"key": "food-beverages-tobacco/food-items/snack-foods/cereal-granola-bars/protein-bars",
"mentions": 2,
"creators": 2
},
{
"id": "spt:hb-1-9-1-3",
"key": "health-beauty/health-care/fitness-nutrition/nutrition-bars/protein-bars",
"mentions": 10,
"creators": 8
}
]
}
},
"suggested_next_calls": [
{
"tool": "price_dispersion",
"route": "/v1/analyst/price-dispersion",
"method": "GET",
"args": {
"gpc": "gpc:10008059"
},
"price_usd": 0.02,
"why": "how prices are spread across every shelf the type is filed under"
},
{
"tool": "promo_intelligence",
"route": "/v1/marketing/promo-intelligence",
"method": "GET",
"args": {
"gpc": "gpc:10008059",
"aggregate_by": "brand"
},
"price_usd": 0.01,
"why": "which brands are discounting on every shelf the type is filed under, and how deep"
}
],
"vocab": {
"spt_release": "2026-08",
"gpc_publication": "v20260520",
"map_version": "spt-gpc-05ae4409bf35",
"lexicon_version": "lex2-976d6b315235",
"alias_version": "spt-aliases-404b65462b40",
"brand_version": "brands-057783b03cd8",
"published_at": "2026-11-18T07:46:06.583Z"
},
"schema_version": "ontology/1"
}{
"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": "NOT_FOUND",
"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": "NOT_PUBLISHED",
"message": "<string>",
"details": {}
}
}What sits next to an id.
What sits next to an id. A measure is one metric family asked one way: by picks the split, subject is what it is about, and every other parameter is the answering route’s own. The answer is that route’s answer, unchanged, and X-Syntalic-Preset names it. An unknown by, or a subject the split cannot take, is refused before anything is billed, with the valid list. by=relations: ancestors, children, types, brands and chains around an id; for a shelf also its marketing practices (facets) and what its posts are (relations=labels), answered by /v1/ontology/neighbors.
curl --request GET \
--url https://api.syntalic.com/v1/measures/neighborsimport requests
url = "https://api.syntalic.com/v1/measures/neighbors"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.syntalic.com/v1/measures/neighbors', 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/measures/neighbors",
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/measures/neighbors"
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/measures/neighbors")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.syntalic.com/v1/measures/neighbors")
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{
"id": "gpc:10008059",
"kind": "product_type",
"label": "Protein Bars",
"country": "us",
"relations": {
"level": "brick",
"ancestry": {
"segment": "Food/Beverage",
"family": "Cereal/Grain/Pulse Products",
"class": "Processed Cereal Products"
},
"homes": [
{
"id": "spt:fb-2-17-2-4",
"label": "Food, Beverages & Tobacco > Food Items > Snack Foods > Cereal & Granola Bars > Protein Bars",
"key": "food-beverages-tobacco/food-items/snack-foods/cereal-granola-bars/protein-bars",
"role": "primary",
"cardinality": "1:1",
"listings": 232
},
{
"id": "spt:hb-1-9-1-2",
"label": "Health & Beauty > Health Care > Fitness & Nutrition > Nutrition Bars > Meal Replacement Bars",
"key": "health-beauty/health-care/fitness-nutrition/nutrition-bars/meal-replacement-bars",
"role": "primary",
"cardinality": "1:1",
"listings": 11
}
],
"siblings": {
"items": [
{
"id": "gpc:10000287",
"label": "Cereal/Muesli Bars"
},
{
"id": "gpc:10006250",
"label": "Cereal Products - Not Ready to Eat (Frozen)"
}
],
"total": 6,
"truncated": false
},
"aliases": {
"items": [
"high protein",
"high proteins"
],
"total": 7,
"truncated": false
}
},
"coverage": {
"listings": 1209,
"entities": 766,
"brands": null,
"retailers": 41,
"priced": 1209,
"fresh_24h": 0,
"fresh_7d": 456,
"fresh_7d_pct": 37.7,
"last_observed_at": "2026-11-17T07:23:19.919Z",
"channels_present": [
"ecommerce"
],
"channels_not_observed": [
"physical_store"
],
"priced_by_channel": {
"ecommerce": 1209
},
"retailers_scanned": [
"afarfoods",
"alaninu"
],
"n_retailers_scanned": 41,
"social": {
"mentions": 12,
"shelves": [
{
"id": "spt:fb-2-17-2-4",
"key": "food-beverages-tobacco/food-items/snack-foods/cereal-granola-bars/protein-bars",
"mentions": 2,
"creators": 2
},
{
"id": "spt:hb-1-9-1-3",
"key": "health-beauty/health-care/fitness-nutrition/nutrition-bars/protein-bars",
"mentions": 10,
"creators": 8
}
]
}
},
"suggested_next_calls": [
{
"tool": "price_dispersion",
"route": "/v1/analyst/price-dispersion",
"method": "GET",
"args": {
"gpc": "gpc:10008059"
},
"price_usd": 0.02,
"why": "how prices are spread across every shelf the type is filed under"
},
{
"tool": "promo_intelligence",
"route": "/v1/marketing/promo-intelligence",
"method": "GET",
"args": {
"gpc": "gpc:10008059",
"aggregate_by": "brand"
},
"price_usd": 0.01,
"why": "which brands are discounting on every shelf the type is filed under, and how deep"
}
],
"vocab": {
"spt_release": "2026-08",
"gpc_publication": "v20260520",
"map_version": "spt-gpc-05ae4409bf35",
"lexicon_version": "lex2-976d6b315235",
"alias_version": "spt-aliases-404b65462b40",
"brand_version": "brands-057783b03cd8",
"published_at": "2026-11-18T07:46:06.583Z"
},
"schema_version": "ontology/1"
}{
"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": "NOT_FOUND",
"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": "NOT_PUBLISHED",
"message": "<string>",
"details": {}
}
}Query Parameters
What the question is about: an id (spt:, gpc:, brand:, retailer:, entity:) or a name. It is sent to the answering route as the parameter of its kind (an spt: id as spt, a brand: id as brand_id, a name as the route's name parameter), so send it OR that parameter, not both. Which kinds a split takes is in x-syntalic-presets; a kind it does not take is refused before anything is billed.
Comma-joined or repeated: which blocks to return. category: ancestors, children, siblings, types, parallel_homes, aliases, top_brands, top_retailers, facets, labels (only when named). product_type: ancestry, homes, siblings, aliases. brand: profile, aliases, footprint, carried_at, not_observed_at, similar. retailer: profile, assortment, brands. A brand's similar is { status, basis, items, total, truncated, n_entities, best_score, weak, reason }: up to 10 brands that share its shelves (four levels deep) at a similar price tier, best first, each with rank, score, overlap, price_gap and the shared shelves behind it; status: unavailable means the table is not published yet, which is not the same as no list. n_entities is the brand's distinct products on shelves (the number the floor of 5 tests), best_score the best match's score, and weak the one rule for a list that cannot be leaned on: the best score is under 0.3 or fewer than 3 brands cleared (an empty list is weak). When items is empty, reason says why: homonym (one id for two companies: no peers by design), not_a_brand (a storefront phrase in the brand field), no_footprint (no product on a shelf), below_floor (under 5 distinct products on shelves) or no_overlap (enough products, no brand shares 0.2 of its shelves). The four fields are null until the status table is published. It never uses a brand's own description, and shelves alone cannot tell two brands apart that sell the same things at the same price. An unknown one is a 400 that lists the valid ones for the kind.
Response
The answer of the route that by selected, unchanged. The X-Syntalic-Preset response header names that route; its own path in this document has the response schema.
The response is of type object.