Raw schema
{
"type": "object",
"properties": {
"query": {
"type": "string",
"maxLength": 80,
"description": "Product to look for, in Italian. Brand and product words are combined (\"olio extravergine monini\"). Omit to browse the biggest discounts."
},
"city": {
"type": "string",
"maxLength": 60,
"description": "Italian municipality (comune) to search around: where the user is, or the place they ask about, e.g. \"Milano\", \"Reggio Emilia\", \"Sesto San Giovanni\". Only flyers valid in stores within radius_km of its centre are returned. Without a place the search covers all of Italy."
},
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90,
"description": "Latitude of the position of the user (WGS84, decimal degrees), together with longitude. Distances are then measured from this point, and only flyers valid in stores within radius_km of it are returned. Takes precedence over city. Used for this answer only, never stored."
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180,
"description": "Longitude of the position of the user, together with latitude."
},
"radius_km": {
"type": "number",
"minimum": 1,
"maximum": 50,
"description": "How far to look around the city centre or the coordinates, in km (default 15)."
},
"near_me": {
"type": "boolean",
"description": "Whether to search around the approximate position of the user that some clients share with the call (ChatGPT does). When omitted, that position is used if the call names no city and no coordinates. true: the same, and the answer is an error when no position came with the call. false: all of Italy."
},
"sort": {
"type": "string",
"enum": [
"relevance",
"price",
"unit_price",
"discount",
"nearest"
],
"description": "relevance (default with a query), price (lowest first), unit_price (lowest price per kg or litre first; only offers that state it), discount (biggest first; default without a query), nearest (closest chain first; needs a city or coordinates)."
},
"discounted_only": {
"type": "boolean",
"description": "Only offers whose flyer states a higher previous price."
},
"stores": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 10,
"description": "Only these chains, by name: e.g. [\"Lidl\", \"Esselunga\"]."
},
"max_price_eur": {
"type": "number",
"minimum": 0,
"description": "Only offers at or below this price."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 25,
"description": "Offers per page (default 10)."
},
"page": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"description": "Page of results (default 1)."
}
},
"additionalProperties": false
}