{"uid":"cap_ccKByjVCcaAel4sTjvbZy","slug":"retailer-index-0e16ff00","name":"Retailer Index","description":"Compute a normalized price index (retailer avg / category avg) for a specific retailer day-by-day versus its category baseline.","url":"https://api.syntalic.com/v1/analyst/retailer-index","method":"GET","headers":{},"bodySchema":{"type":"object","required":["retailer"],"properties":{"to":{"type":"string","format":"date","example":"2026-05-01","description":"End date (ISO 8601, defaults to now)"},"from":{"type":"string","format":"date","example":"2026-04-01","description":"Start date (ISO 8601, defaults to 30 days ago)"},"country":{"enum":["us","ca"],"type":"string","default":"us","example":"us","description":"Country (us or ca)"},"category":{"type":"string","example":"electronics","minLength":1,"description":"Product category (e.g., electronics, grocery, beauty). Fuzzy human-readable input — the resolver maps it through tier 1-4 (id → exact name → trigram → embedding kNN) to a canonical category_id. Pair with `category_id` if you have a deterministic id from a prior call."},"retailer":{"type":"string","example":"amazon","description":"Retailer name (e.g., amazon, walmart)"},"department":{"type":"string","example":"Electronics","minLength":1,"description":"Coarse depth-1 BrowseNodes department label (e.g., 'Electronics', 'Grocery', 'Toys & Games'). Exact-match, case-sensitive Title Case. Optional alongside `category`; either parameter alone or both together are accepted. Use this for stable cross-agent queries where the leaf-level category is too noisy."},"category_id":{"type":"integer","example":1,"minimum":1,"description":"Deterministic category id. When set, bypasses the fuzzy resolver cascade and uses tier 1 (id lookup) directly. Agents that learned a canonical id from a prior call's `resolved.category_id` should pin it here for round-trip stability."}},"additionalProperties":false},"responseSchema":{"type":"object"},"example":null,"exampleRequest":null,"tags":["x402","shopping"],"displayCostAmount":"0.02","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"settled","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.02/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.02","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.02","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_B_sUoyUDAa7Z0EUcz-cwX","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.02","costPer":"request","priority":0,"asset":null,"unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Computes a normalized price index (retailer average / category average) for a specific retailer day-by-day versus its category baseline over a date range.","exampleAgentPrompt":"Can you pull the daily price index for Walmart in the grocery category for the US market over the last 30 days so I can see how their pricing compares to the category average?","exampleUseCases":null,"resultDescription":"Returns a day-by-day time series of a normalized price index (retailer avg / category avg) for the specified retailer, showing whether the retailer is priced above (>1) or below (<1) the category baseline on each day, along with resolved category metadata.","failureModes":["Unknown retailer name returns a 404 or empty result","Ambiguous category name fails fuzzy resolution and returns an error or null category_id","Date range with no data returns an empty series","Invalid country code returns a validation error","category_id not found returns a lookup error","Requesting future dates beyond now may return partial or empty data"],"whenToPreferThis":"Use this endpoint when you need to understand a single retailer's relative price positioning versus the category average over time, expressed as a normalized index. Prefer this over Price Positioning (which is brand-focused) or Inflation (which tracks category-level trends regardless of retailer). Ideal for daily monitoring of whether a specific retailer is trending premium or discount relative to peers.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-09-15T06:41:47.978Z","isFirstParty":false}