Zomato API Capability

Location Search

Search Zomato locations (cities, neighborhoods, landmarks) by name.

Capability ID zomato.location.search

Cost 1 credit per request

Maximum runtime 30 seconds

# Location Search

Search Zomato locations (cities, neighborhoods, landmarks) by name.

- Platform: [Zomato](https://docs.upscrape.com/docs/platforms/zomato)
- Capability ID: `zomato.location.search`
- 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 YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "query": "Connaught Place"
  },
  "capability": "zomato.location.search"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | Maximum location suggestions to return. |
| `query` | `string` | Yes | City, neighborhood, or landmark to find. |

### Example input

```json
{
  "query": "Connaught Place"
}
```

## 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
{
  "count": 10,
  "query": "Connaught Place",
  "source_url": "[redacted:acquisition_url]",
  "suggestions": [
    {
      "entity_name": "Connaught Place, New Delhi, Delhi, India, India",
      "is_order_location": 1,
      "latitude": 28.6304203,
      "location_type": "geocode",
      "longitude": 77.21772159999999,
      "place_id": "ChIJV9BBtzf9DDkR8cOTc-SI7s0",
      "subtitle": "New Delhi, Delhi, India, India",
      "title": "Connaught Place"
    },
    {
      "entity_name": "Connaught place, Connaught Place, New Delhi, Delhi, India, India",
      "is_order_location": 1,
      "latitude": 28.6328963,
      "location_type": "establishment",
      "longitude": 77.2193156,
      "place_id": "ChIJ1aKMFgD9DDkRUE4zJ1XZxxY",
      "subtitle": "Connaught Place, New Delhi, Delhi, India, India",
      "title": "Connaught place"
    },
    {
      "entity_name": "Connaught Place SOCIAL, Middle Circle, Block B, Connaught Place, New Delhi, Delhi, India, India",
      "is_order_location": 1,
      "latitude": 28.634607,
      "location_type": "bar",
      "longitude": 77.2187783,
      "place_id": "ChIJn6jFcKT9DDkRSbsVBMHSqbQ",
      "subtitle": "Middle Circle, Block B, Connaught Place, New Delhi, Delhi, India, India",
      "title": "Connaught Place SOCIAL"
    }
  ]
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `count` | `integer` | 10 |
| `query` | `string` | Connaught Place |
| `source_url` | `string` | [redacted:acquisition_url] |
| `suggestions` | `array` | 3 items |
| `suggestions` | `array` | 3 items |

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

limit integer optional

Maximum location suggestions to return.

query string required

City, neighborhood, or landmark to find.

Example Connaught Place

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 full redacted fixture is shown in the response panel.

Illustrative output fields

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

Path	Observed type	Example
`count`	`integer`	10
`query`	`string`	Connaught Place
`source_url`	`string`	[redacted:acquisition_url]
`suggestions`	`array`	3 items
`suggestions`	`array`	3 items

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 YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "query": "Connaught Place" }, "capability": "zomato.location.search" }'

import json import requests payload = json.loads(r'''{ "input": { "query": "Connaught Place" }, "capability": "zomato.location.search" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "count": 10, "query": "Connaught Place", "source_url": "[redacted:acquisition_url]", "suggestions": [ { "entity_name": "Connaught Place, New Delhi, Delhi, India, India", "is_order_location": 1, "latitude": 28.6304203, "location_type": "geocode", "longitude": 77.21772159999999, "place_id": "ChIJV9BBtzf9DDkR8cOTc-SI7s0", "subtitle": "New Delhi, Delhi, India, India", "title": "Connaught Place" }, { "entity_name": "Connaught place, Connaught Place, New Delhi, Delhi, India, India", "is_order_location": 1, "latitude": 28.6328963, "location_type": "establishment", "longitude": 77.2193156, "place_id": "ChIJ1aKMFgD9DDkRUE4zJ1XZxxY", "subtitle": "Connaught Place, New Delhi, Delhi, India, India", "title": "Connaught place" }, { "entity_name": "Connaught Place SOCIAL, Middle Circle, Block B, Connaught Place, New Delhi, Delhi, India, India", "is_order_location": 1, "latitude": 28.634607, "location_type": "bar", "longitude": 77.2187783, "place_id": "ChIJn6jFcKT9DDkRSbsVBMHSqbQ", "subtitle": "Middle Circle, Block B, Connaught Place, New Delhi, Delhi, India, India", "title": "Connaught Place SOCIAL" } ] }