Swiggy API reference

Swiggy Area Ads Search

swiggy.area.ads.search

Track sponsored search placements across a grid of Swiggy delivery areas for one query and location.

Swiggy Area Ads Search API: overview and live sample

At a glance

Endpoint ID: swiggy.area.ads.search
Price: 1 credit per call; failed calls are free
Runs for up to: 120 seconds
Request: POST /execute; Run an endpoint
MCP tool when pinned: swiggy__area__ads__search; Pin tools
OpenAPI: openapi.json; Download

Request

Send the endpoint ID as capability and its fields as input. Set UPSCRAPE_API_KEY to your key first.

curl --request POST \  --url https://data.upscrape.com/execute \  --header "Authorization: Bearer $UPSCRAPE_API_KEY" \  --header "Content-Type: application/json" \  --header "Prefer: wait=30" \  --data '{  "capability": "swiggy.area.ads.search",  "input": {    "center_latitude": 12.9121181,    "center_longitude": 77.6445548,    "limit": 5,    "max_cells": 2,    "query": "rolls",    "radius_km": 1,    "step_km": 1  }}'

import jsonimport osimport requestspayload = json.loads(r'''{  "capability": "swiggy.area.ads.search",  "input": {    "center_latitude": 12.9121181,    "center_longitude": 77.6445548,    "limit": 5,    "max_cells": 2,    "query": "rolls",    "radius_km": 1,    "step_km": 1  }}''')response = requests.post(    "https://data.upscrape.com/execute",    headers={        "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}",        "Content-Type": "application/json",        "Prefer": "wait=30",    },    json=payload,)response.raise_for_status()print(json.dumps(response.json(), indent=2))

const response = await fetch("https://data.upscrape.com/execute", {  method: "POST",  headers: {    "Authorization": `Bearer ${process.env.UPSCRAPE_API_KEY}`,    "Content-Type": "application/json",    "Prefer": "wait=30",  },  body: JSON.stringify({  "capability": "swiggy.area.ads.search",  "input": {    "center_latitude": 12.9121181,    "center_longitude": 77.6445548,    "limit": 5,    "max_cells": 2,    "query": "rolls",    "radius_km": 1,    "step_km": 1  }}),});if (!response.ok) {  throw new Error(`Upscrape request failed: ${response.status}`);}console.log(JSON.stringify(await response.json(), null, 2));

Input

Field	Type	Required	What it does	Example
`query`	string	yes	Search keyword.	rolls
`center_latitude`	number	no	Center latitude for radius mode.	12.9121181
`center_longitude`	number	no	Center longitude for radius mode.	77.6445548
`city`	string	no	City name.
`concurrency`	integer	no	Number of concurrent requests.
`limit`	integer	no	Maximum number of results.	5
`max_cells`	integer	no	Maximum grid cells to crawl.	2
`max_latitude`	number	no	Maximum latitude of bounding box.
`max_longitude`	number	no	Maximum longitude of bounding box.
`min_latitude`	number	no	Minimum latitude of bounding box.
`min_longitude`	number	no	Minimum longitude of bounding box.
`radius_km`	number	no	Radius in kilometers.	1
`step_km`	number	no	Grid step size in kilometers.	1

Response

A finished call answers with HTTP 200; the data is in results[0].data, and billing.credits_charged is what it cost. A call still running after the wait answers 202: see jobs and results.

This is results[0].data from a real run:

results[0].data

{  "summary": {    "captured_at": "2026-08-01T10:58:23Z",    "cells": 2,    "crawl_id": "e6b50735-72e1-406c-86b4-0c141b7956bd",    "query": "rolls",    "run_id": "3907afc5-96f1-44bc-b930-1bb9c9de8abc",    "surface": "search",    "total_items": 10  },  "items": [    {      "rating": 4.1,      "ad_entity_id": "59445",      "ad_entity_type": "RESTAURANT",      "ad_group_id": "2722daef-9160-4647-ae6e-64ae18dcc2a4",      "ad_tracking_id": "cid=2722daef-9160-4647-ae6e-64ae18dcc2a4~p=0~adgrpid=2722daef-9160-4647-ae6e-64ae18dcc2a4#ag1~mp=SWIGGY_IN~bl=FOOD~aet=RESTAURANT~aeid=5944…",      "area_name": "Bommanahalli",      "business_line": "FOOD",      "campaign_id": "2722daef-9160-4647-ae6e-64ae18dcc2a4",      "captured_at": "2026-08-01T10:58:23Z",      "cell_id": "cell-0001",      "cell_latitude": 12.903109,      "cell_longitude": 77.635312,      "cell_rank": 1,      "crawl_id": "e6b50735-72e1-406c-86b4-0c141b7956bd",      "cuisines_text": "Wraps, rolls, Fast Food, Burger, shawarma, Rice Bowls",      "delivery_time_minutes": 24,      "event_id": "b6cd66f3-9d1e-4991-9798-aad792f8b67e",      "is_promoted": true,      "latitude": 12.903109,      "locality": "Devrachikkanahalli Main Road",      "longitude": 77.635312,      "market_platform": "SWIGGY_IN",      "offer_text": "ITEMS",      "paid_position": "0",      "placement": "SEARCH:RESTAURANT",      "query": "rolls",      "rank": 1,      "rating_text": "4.1",      "restaurant_id": "59445",      "restaurant_name": "Faasos - Wraps, Rolls & Shawarma",      "restaurant_url": "https://www.swiggy.com/city/1/faasos-bommanahalli-arekere-rest59445",      "run_id": "3907afc5-96f1-44bc-b930-1bb9c9de8abc",      "search_term": "roll",      "sla_text": "20-25 MINS",      "surface": "search",      "total_ratings_text": "13K+",      "cuisines": [        "Wraps",        "rolls"      ]    },    {      "rating": 4.1,      "area_name": "Madiwala Post",      "captured_at": "2026-08-01T10:58:23Z",      "cell_id": "cell-0001",      "cell_latitude": 12.903109,      "cell_longitude": 77.635312,      "cell_rank": 1,      "crawl_id": "e6b50735-72e1-406c-86b4-0c141b7956bd",      "cuisines_text": "Rolls & Wraps, Snacks, Fast Food, North Indian",      "delivery_time_minutes": 27,      "is_promoted": false,      "latitude": 12.903109,      "locality": "Roopena Agrahara",      "longitude": 77.635312,      "offer_text": "50% OFF",      "query": "rolls",      "rank": 2,      "rating_text": "4.1",      "restaurant_id": "955727",      "restaurant_name": "Rolls On Wheels - Shawarma & Wraps",      "run_id": "3907afc5-96f1-44bc-b930-1bb9c9de8abc",      "sla_text": "25-30 MINS",      "surface": "search",      "total_ratings_text": "701",      "cuisines": [        "Rolls & Wraps",        "Snacks"      ]    }  ]}

Fields

Field	Type	Example
`items[].rating`	number	4.1
`items[].cuisines_text`	string	Wraps, rolls, Fast Food, Burger, shawarma, Rice Bowls
`items[].latitude`	number	12.9
`items[].surface`	string	search
`items[].rating_text`	string	4.1
`items[].placement`	string	SEARCH:RESTAURANT
`items[].search_term`	string	roll
`items[].offer_text`	string	ITEMS
`items[].event_id`	string	b6cd66f3-9d1e-4991-9798-aad792f8b67e
`items[].cell_latitude`	number	12.9
`items[].cell_rank`	integer	1
`items[].business_line`	string	FOOD
`items[].crawl_id`	string	e6b50735-72e1-406c-86b4-0c141b7956bd
`items[].run_id`	string	3907afc5-96f1-44bc-b930-1bb9c9de8abc
`items[].campaign_id`	string	2722daef-9160-4647-ae6e-64ae18dcc2a4
`items[].total_ratings_text`	string	13K+
`items[].rank`	integer	1
`items[].ad_entity_id`	string	59445
`items[].cell_longitude`	number	77.64
`items[].restaurant_url`	string	https://www.swiggy.com/city/1/faasos-bommanahalli-arekere-rest5…
`items[].ad_tracking_id`	string	cid=2722daef-9160-4647-ae6e-64ae18dcc2a4~p=0~adgrpid=2722daef-9…
`items[].restaurant_id`	string	59445
`items[].cell_id`	string	cell-0001
`items[].ad_entity_type`	string	RESTAURANT
`items[].is_promoted`	boolean	true
`items[].captured_at`	string	2026-08-01T10:58:23Z
`items[].longitude`	number	77.64
`items[].restaurant_name`	string	Faasos - Wraps, Rolls & Shawarma
`items[].locality`	string	Devrachikkanahalli Main Road
`items[].sla_text`	string	20-25 MINS
`items[].paid_position`	string	0
`items[].delivery_time_minutes`	integer	24
`items[].cuisines`	array	Wraps, rolls, Fast Food
`items[].query`	string	rolls
`items[].ad_group_id`	string	2722daef-9160-4647-ae6e-64ae18dcc2a4
`items[].area_name`	string	Bommanahalli
`items[].market_platform`	string	SWIGGY_IN
`items`	array	3 records
`summary`	object	7 fields
`summary.captured_at`	string	2026-08-01T10:58:23Z
`summary.cells`	integer	2
`summary.crawl_id`	string	e6b50735-72e1-406c-86b4-0c141b7956bd
`summary.query`	string	rolls
`summary.run_id`	string	3907afc5-96f1-44bc-b930-1bb9c9de8abc
`summary.surface`	string	search
`summary.total_items`	integer	10

If a call fails

A failed call costs nothing. The response carries an error.code you can branch on; Errors and retries lists every code and which ones to retry.

Other Swiggy endpoints

Something missing or unclear? Ask the team that builds the Swiggy endpoints.