# Area Menu Items

Discover restaurants near a location and stream their menu items.

- Platform: [Swiggy](https://docs.upscrape.com/docs/platforms/swiggy)
- Capability ID: `swiggy.menu.area_items`
- Cost: 1 credit per request
- Maximum runtime: 120 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 YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "continue_on_menu_failures": true,
    "latitude": 12.9121181,
    "longitude": 77.6445548,
    "max_pages": 1,
    "max_restaurants": 2,
    "menu_item_limit": 5,
    "page_limit": 3
  },
  "capability": "swiggy.menu.area_items"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `continue_on_menu_failures` | `boolean` | No | Continue if a menu fetch fails. |
| `latitude` | `number` | No | Latitude of the location. |
| `longitude` | `number` | No | Longitude of the location. |
| `max_pages` | `integer` | No | Maximum pages to fetch. |
| `max_restaurants` | `integer` | No | Maximum restaurants to discover. |
| `menu_item_limit` | `integer` | No | Maximum menu items per restaurant. |
| `offset` | `integer` | No | Starting offset. |
| `page_limit` | `integer` | No | Results per page. |

### Example input

```json
{
  "continue_on_menu_failures": true,
  "latitude": 12.9121181,
  "longitude": 77.6445548,
  "max_pages": 1,
  "max_restaurants": 2,
  "menu_item_limit": 5,
  "page_limit": 3
}
```

## 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 redacted fixture is an example, not a fixed response schema.

```json
{
  "items": [
    {
      "category": "Hut Café",
      "default_price_minor": 19800,
      "description": "Get any 2 mocktails at Rs 189. For nutritional data of this meal, refer to individual products.",
      "final_price_minor": 18900,
      "image_id": "FOOD_CATALOG/IMAGES/CMS/2026/1/5/[redacted:token].jpg",
      "image_url": "https://media-assets.swiggy.com/swiggy/image/upload/FOOD_CATALOG/IMAGES/CMS/2026/1/5/[redacted:token].jpg",
      "in_stock": true,
      "is_veg": true,
      "item_id": "187073896",
      "name": "Double the Fizz!",
      "offer_ids": [
        "b1033082-58df-4382-a0a9-c76b7040acb5",
        "2a41f40c-6fbe-4ce5-8c15-35cf6ef311ff"
      ],
      "offer_ids_text": "b1033082-58df-4382-a0a9-c76b7040acb5 | 2a41f40c-6fbe-4ce5-8c15-35cf6ef311ff",
      "offer_tags": [
        "70% OFF"
      ],
      "offer_tags_text": "70% OFF",
      "restaurant_area_name": "HSR Layout",
      "restaurant_city": "Bangalore",
      "restaurant_cuisines": [
        "Pizzas"
      ],
      "restaurant_cuisines_text": "Pizzas",
      "restaurant_id": "10581",
      "restaurant_locality": "14th Main",
      "restaurant_name": "Pizza Hut",
      "restaurant_rating": 4,
      "restaurant_rating_text": "4.0",
      "restaurant_url": "https://www.swiggy.com/city/bangalore/pizza-hut-sector-7-hsr-rest10581",
      "source_url": "[redacted:acquisition_url]",
      "variant_group_count": 2,
      "variant_group_names": [
        "Choose 1st Mixology",
        "Choose 2nd Mixology"
      ],
      "variant_group_names_text": "Choose 1st Mixology | Choose 2nd Mixology"
    },
    {
      "addon_group_count": 4,
      "addon_group_names": [
        "Extra Cheese Topping",
        "Add More Veg Toppings Personal",
        "Make it a Meal."
      ],
      "addon_group_names_text": "Extra Cheese Topping | Add More Veg Toppings Personal | Make it a Meal. | Add More Non-Veg Toppings Personal",
      "category": "Flat 299",
      "description": "Amazingly flavourful Chicken Malai Tikka, Herbed Onion & Green Capsicum, spicy Red Paprika with flavourful pan sauce and mozzarella cheese. (PAN Per-269Kcal/100g). Contains Cereals containing Gluten (Wheat), Soya and Milk & Milk Products.",
      "final_price_minor": 29900,
      "image_id": "FOOD_CATALOG/IMAGES/CMS/2025/4/17/[redacted:token].jpg_compressed",
      "image_url": "https://media-assets.swiggy.com/swiggy/image/upload/FOOD_CATALOG/IMAGES/CMS/2025/4/17/[redacted:token].jpg_compressed",
      "in_stock": true,
      "item_id": "128413487",
      "name": "Murg Malai Chicken - Personal",
      "offer_ids": [
        "1dccf2be-0d17-4d74-88a1-4fc94344b2dc"
      ],
      "offer_ids_text": "1dccf2be-0d17-4d74-88a1-4fc94344b2dc",
      "price_minor": 41900,
      "rating": 4.3,
      "rating_count": "43 ratings",
      "restaurant_area_name": "HSR Layout",
      "restaurant_city": "Bangalore",
      "restaurant_cuisines": [
        "Pizzas"
      ],
      "restaurant_cuisines_text": "Pizzas",
      "restaurant_id": "10581",
      "restaurant_locality": "14th Main",
      "restaurant_name": "Pizza Hut",
      "restaurant_rating": 4,
      "restaurant_rating_text": "4.0",
      "restaurant_url": "https://www.swiggy.com/city/bangalore/pizza-hut-sector-7-hsr-rest10581",
      "source_url": "[redacted:acquisition_url]"
    },
    {
      "addon_group_count": 4,
      "addon_group_names": [
        "Extra Cheese Topping",
        "Add More Veg Toppings Personal",
        "Make it a Meal."
      ],
      "addon_group_names_text": "Extra Cheese Topping | Add More Veg Toppings Personal | Make it a Meal. | Add More Non-Veg Toppings Personal",
      "category": "Flat 299",
      "description": "Dhaba style chicken keema masala, with green chiili, crunchy onion with flavourful pan sauce, 100 % mozzarella cheese & a generous drizzle of mint mayo (PAN Per-270Kcal/100g). Contains Cereals containing Gluten (Wheat), Soya and Milk & Milk Products.",
      "final_price_minor": 29900,
      "image_id": "FOOD_CATALOG/IMAGES/CMS/2025/4/16/[redacted:token].jpg_compressed",
      "image_url": "https://media-assets.swiggy.com/swiggy/image/upload/FOOD_CATALOG/IMAGES/CMS/2025/4/16/[redacted:token].jpg_compressed",
      "in_stock": true,
      "item_id": "128413486",
      "name": "Dhabe Da Keema - Personal",
      "offer_ids": [
        "1dccf2be-0d17-4d74-88a1-4fc94344b2dc"
      ],
      "offer_ids_text": "1dccf2be-0d17-4d74-88a1-4fc94344b2dc",
      "price_minor": 33900,
      "rating": 4.7,
      "rating_count": "13 ratings",
      "restaurant_area_name": "HSR Layout",
      "restaurant_city": "Bangalore",
      "restaurant_cuisines": [
        "Pizzas"
      ],
      "restaurant_cuisines_text": "Pizzas",
      "restaurant_id": "10581",
      "restaurant_locality": "14th Main",
      "restaurant_name": "Pizza Hut",
      "restaurant_rating": 4,
      "restaurant_rating_text": "4.0",
      "restaurant_url": "https://www.swiggy.com/city/bangalore/pizza-hut-sector-7-hsr-rest10581",
      "source_url": "[redacted:acquisition_url]"
    }
  ],
  "summary": {
    "latitude": 12.9121181,
    "longitude": 77.6445548,
    "source_url": "[redacted:acquisition_url]",
    "total_items": 10
  }
}
```
### 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` | 4 fields |
| `summary.latitude` | `number` | 12.9121181 |
| `summary.longitude` | `number` | 77.6445548 |
| `summary.source_url` | `string` | [redacted:acquisition_url] |
| `summary.total_items` | `integer` | 10 |

## 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)
