Swiggy API Capability

Ads list

Track ad placements and promoted restaurants on Swiggy's first listing page for a delivery location.

Capability ID swiggy.ads.list

Cost From $1.25 per 1,000 requests · 1 credit

Maximum runtime 30 seconds

# Ads list

Track ad placements and promoted restaurants on Swiggy's first listing page for a delivery location.

- Platform: [Swiggy](https://docs.upscrape.com/docs/platforms/swiggy)
- Capability ID: `swiggy.ads.list`
- Cost: 1 credit per request
- Maximum runtime: 30 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
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 '{
  "input": {
    "latitude": 12.9121181,
    "limit": 5,
    "longitude": 77.6445548
  },
  "capability": "swiggy.ads.list"
}'
```

## Input


| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `latitude` | `number` | No | Latitude; supply together with longitude, or omit both for the default delivery area. From -90 to 90. |
| `limit` | `integer` | No | Maximum number of results, taken from Swiggy's first listing page. |
| `longitude` | `number` | No | Longitude; supply together with latitude, or omit both for the default delivery area. From -180 to 180. |
| `offset` | `string` | No | Not supported: Swiggy serves one listing page per location, so there is no next page to continue. Omit it; any value is rejected as invalid_input. |

### Example input

```json
{
  "latitude": 12.9121181,
  "limit": 5,
  "longitude": 77.6445548
}
```

## Response

Successful output is returned in `results[0].data`.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This example shows one response. Values and optional fields vary with the data available.

```json
{
  "items": [
    {
      "area_name": "HSR Layout",
      "captured_at": "2026-08-01T10:58:26Z",
      "cuisines": [
        "Pizzas"
      ],
      "cuisines_text": "Pizzas",
      "delivery_time_minutes": 25,
      "is_promoted": false,
      "latitude": 12.9121181,
      "locality": "14th Main",
      "longitude": 77.6445548,
      "offer_text": "50% OFF",
      "rank": 1,
      "rating": 4,
      "rating_text": "4.0",
      "restaurant_id": "10581",
      "restaurant_name": "Pizza Hut",
      "restaurant_url": "https://www.swiggy.com/city/bangalore/[redacted:token]",
      "run_id": "521ec12e-e52a-45ee-8029-c5018509e3fe",
      "sla_text": "25-30 mins",
      "surface": "list",
      "total_ratings_text": "21K+"
    },
    {
      "area_name": "HSR Layout",
      "captured_at": "2026-08-01T10:58:26Z",
      "cuisines": [
        "Bubble Tea",
        "Burger",
        "Korean"
      ],
      "cuisines_text": "Bubble Tea, Burger, Korean, Beverages, Fast Food, Juice and shake",
      "delivery_time_minutes": 22,
      "is_promoted": false,
      "latitude": 12.9121181,
      "locality": "5TH SECTOR",
      "longitude": 77.6445548,
      "offer_text": "60% OFF",
      "rank": 2,
      "rating": 4.2,
      "rating_text": "4.2",
      "restaurant_id": "819617",
      "restaurant_name": "Boba Bhai - Bubble Tea & Korean Street Food",
      "restaurant_url": "https://www.swiggy.com/city/bangalore/[redacted:token]",
      "run_id": "521ec12e-e52a-45ee-8029-c5018509e3fe",
      "sla_text": "20-25 mins",
      "surface": "list",
      "total_ratings_text": "1.2K+"
    },
    {
      "area_name": "HSR Layout",
      "captured_at": "2026-08-01T10:58:26Z",
      "cuisines": [
        "Burgers",
        "Beverages",
        "Cafe"
      ],
      "cuisines_text": "Burgers, Beverages, Cafe, Desserts",
      "delivery_time_minutes": 26,
      "is_promoted": false,
      "latitude": 12.9121181,
      "locality": "HSR Layout",
      "longitude": 77.6445548,
      "offer_text": "ITEMS",
      "rank": 3,
      "rating": 4.3,
      "rating_text": "4.3",
      "restaurant_id": "23682",
      "restaurant_name": "McDonald's",
      "restaurant_url": "https://www.swiggy.com/city/bangalore/mcdonalds-hsr-layout-rest23682",
      "run_id": "521ec12e-e52a-45ee-8029-c5018509e3fe",
      "sla_text": "25-30 mins",
      "surface": "list",
      "total_ratings_text": "79K+"
    }
  ],
  "summary": {
    "captured_at": "2026-08-01T10:58:26Z",
    "has_more": true,
    "latitude": 12.9121181,
    "longitude": 77.6445548,
    "pages_fetched": 1,
    "run_id": "521ec12e-e52a-45ee-8029-c5018509e3fe",
    "stop_reason": "limit",
    "surface": "list",
    "total_items": 5,
    "truncated": true
  }
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `items` | `array` | 3 items |
| `items` | `array` | 3 items |
| `summary` | `object` | 10 fields |
| `summary.captured_at` | `string` | 2026-08-01T10:58:26Z |
| `summary.has_more` | `boolean` | true |
| `summary.latitude` | `number` | 12.9121181 |
| `summary.longitude` | `number` | 77.6445548 |
| `summary.pages_fetched` | `integer` | 1 |
| `summary.run_id` | `string` | 521ec12e-e52a-45ee-8029-c5018509e3fe |
| `summary.stop_reason` | `string` | limit |
| `summary.surface` | `string` | list |
| `summary.total_items` | `integer` | 5 |
| `summary.truncated` | `boolean` | true |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

latitude number optional

Latitude; supply together with longitude, or omit both for the default delivery area. From -90 to 90.

Example 12.9121181

limit integer optional

Maximum number of results, taken from Swiggy's first listing page.

Example 5

longitude number optional

Longitude; supply together with latitude, or omit both for the default delivery area. From -180 to 180.

Example 77.6445548

offset string optional

Not supported: Swiggy serves one listing page per location, so there is no next page to continue. Omit it; any value is rejected as invalid_input.

Response

Successful output is returned in results[0].data.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

Illustrative sample The example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

Path	Observed type	Example
`items`	`array`	3 items
`items`	`array`	3 items
`summary`	`object`	10 fields
`summary.captured_at`	`string`	2026-08-01T10:58:26Z
`summary.has_more`	`boolean`	true
`summary.latitude`	`number`	12.9121181
`summary.longitude`	`number`	77.6445548
`summary.pages_fetched`	`integer`	1
`summary.run_id`	`string`	521ec12e-e52a-45ee-8029-c5018509e3fe
`summary.stop_reason`	`string`	limit
`summary.surface`	`string`	list
`summary.total_items`	`integer`	5
`summary.truncated`	`boolean`	true

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

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 '{ "input": { "latitude": 12.9121181, "limit": 5, "longitude": 77.6445548 }, "capability": "swiggy.ads.list" }'

import json import os import requests payload = json.loads(r'''{ "input": { "latitude": 12.9121181, "limit": 5, "longitude": 77.6445548 }, "capability": "swiggy.ads.list" }''') 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))

{ "items": [ { "area_name": "HSR Layout", "captured_at": "2026-08-01T10:58:26Z", "cuisines": [ "Pizzas" ], "cuisines_text": "Pizzas", "delivery_time_minutes": 25, "is_promoted": false, "latitude": 12.9121181, "locality": "14th Main", "longitude": 77.6445548, "offer_text": "50% OFF", "rank": 1, "rating": 4, "rating_text": "4.0", "restaurant_id": "10581", "restaurant_name": "Pizza Hut", "restaurant_url": "https://www.swiggy.com/city/bangalore/[redacted:token]", "run_id": "521ec12e-e52a-45ee-8029-c5018509e3fe", "sla_text": "25-30 mins", "surface": "list", "total_ratings_text": "21K+" }, { "area_name": "HSR Layout", "captured_at": "2026-08-01T10:58:26Z", "cuisines": [ "Bubble Tea", "Burger", "Korean" ], "cuisines_text": "Bubble Tea, Burger, Korean, Beverages, Fast Food, Juice and shake", "delivery_time_minutes": 22, "is_promoted": false, "latitude": 12.9121181, "locality": "5TH SECTOR", "longitude": 77.6445548, "offer_text": "60% OFF", "rank": 2, "rating": 4.2, "rating_text": "4.2", "restaurant_id": "819617", "restaurant_name": "Boba Bhai - Bubble Tea & Korean Street Food", "restaurant_url": "https://www.swiggy.com/city/bangalore/[redacted:token]", "run_id": "521ec12e-e52a-45ee-8029-c5018509e3fe", "sla_text": "20-25 mins", "surface": "list", "total_ratings_text": "1.2K+" }, { "area_name": "HSR Layout", "captured_at": "2026-08-01T10:58:26Z", "cuisines": [ "Burgers", "Beverages", "Cafe" ], "cuisines_text": "Burgers, Beverages, Cafe, Desserts", "delivery_time_minutes": 26, "is_promoted": false, "latitude": 12.9121181, "locality": "HSR Layout", "longitude": 77.6445548, "offer_text": "ITEMS", "rank": 3, "rating": 4.3, "rating_text": "4.3", "restaurant_id": "23682", "restaurant_name": "McDonald's", "restaurant_url": "https://www.swiggy.com/city/bangalore/mcdonalds-hsr-layout-rest23682", "run_id": "521ec12e-e52a-45ee-8029-c5018509e3fe", "sla_text": "25-30 mins", "surface": "list", "total_ratings_text": "79K+" } ], "summary": { "captured_at": "2026-08-01T10:58:26Z", "has_more": true, "latitude": 12.9121181, "longitude": 77.6445548, "pages_fetched": 1, "run_id": "521ec12e-e52a-45ee-8029-c5018509e3fe", "stop_reason": "limit", "surface": "list", "total_items": 5, "truncated": true } }