APIDocumentation
The Vynn.AI REST API provides programmatic access to Canadian grocery pricing intelligence. Available on the Integrate plan.
Authentication
All API requests require an API key passed via the X-API-Key header. API keys are provisioned as part of your Integrate plan onboarding.
curl -H "X-API-Key: your_api_key" \
https://api.vynn.ai/b2b/signals?province=ONEndpoint Reference
Core endpoint categories available through the REST API. All endpoints return JSON by default. The export endpoint also supports CSV and XLSX via the format query parameter.
Price Search
| Method | Path | Description |
|---|---|---|
GET | /prices | Search prices across products at a retailer and store |
GET | /price | Get a single product price by retailer, store, and SKU |
GET | /search | Multi-store product search by province or postal code |
B2B Intelligence
| Method | Path | Description |
|---|---|---|
GET | /b2b/signals | Market signals: threats, opportunities, changes, watchlist |
GET | /b2b/category_report | Category analytics with avg/min/max prices |
GET | /b2b/promo_calendar | Promotional events by retailer and period |
GET | /b2b/geographic_prices | Province-by-province price comparison |
GET | /b2b/brand_insights | Brand pricing across retailers and provinces |
GET | /b2b/competitive_benchmark | Retailer performance vs market average |
GET | /b2b/executive_brief | On-demand weekly executive summary |
Basket & Comparison
| Method | Path | Description |
|---|---|---|
POST | /b2b/basket | Market basket comparison across retailers by product name or UPC |
GET | /b2b/new_on_shelf | Recently detected new products |
GET | /b2b/regional_comparison | Regional price deltas vs national average |
Alerts & Export
| Method | Path | Description |
|---|---|---|
GET | /b2b/alerts | List alert rules for current user |
POST | /b2b/alerts | Create a new price alert rule |
GET | /b2b/alerts/events | Recent triggered alert events |
GET | /b2b/export | Export pricing data as JSON, CSV, or XLSX |
Getting Started
1. Subscribe to Integrate
API access is included with the Integrate plan at $4,999 CAD/month. Contact us to discuss your requirements.
2. Receive Your API Key
After onboarding, you will receive an API key and base URL for your environment. All requests authenticate via the X-API-Key header.
3. Start Querying
Use any HTTP client to query endpoints. Responses are JSON by default. Export endpoints support CSV and XLSX formats via the format query parameter.
Ready to integrate?
Contact us to discuss API access, onboarding, and integration requirements for your team.