API
Access supermarket brochures, products, and price data programmatically
API Keys
Create and manage your API keys. The API is free but rate-limited to 100 requests per day.
Sign in to create API keys
You need to be signed in to create and manage your API keys.
Quick Start
Authentication
Include your API key in requests using either the Authorization header or query parameter:
Authorization: Bearer YOUR_API_KEY GET /api/v1/products?api_key=YOUR_API_KEY Rate Limits
The API is rate-limited to 100 requests per day per API key. Rate limit headers are included in every response:
X-RateLimit-Limit: 100X-RateLimit-Remaining: 99X-RateLimit-Reset: 86400Example Request
curl -H "Authorization: Bearer YOUR_API_KEY" \ "/api/v1/products?search=milk&limit=10"API Reference
Full API documentation with all available endpoints
Interactive Documentation
Try out the API endpoints directly in the browser with the interactive API Explorer.
Available Endpoints
/api/v1/supermarketsList all available supermarkets
/api/v1/brochuresList brochures with pagination and filtering
/api/v1/brochures/:idGet a specific brochure with pages
/api/v1/productsList products with pagination, search, and filtering
/api/v1/products/searchSemantic search products using AI embeddings
/api/v1/products/:idGet a specific product by ID
/api/v1/categoriesList all product categories with counts
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
limit | integer | Items per page (max: 100) |
search | string | Search by name or description |
category | string | Filter by category name |
supermarket | string | Filter by supermarket slug |
min_price | number | Minimum price in BGN |
max_price | number | Maximum price in BGN |
has_discount | boolean | Filter by discount status |
only_valid | boolean | Only valid promotions (default: true) |