# 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 $UPSCRAPE_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. From 1 to 50. Default: `10`. |
| `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 example shows one response. Values and optional fields vary with the data available.

```json
{
  "count": 1,
  "fetched_at": "2026-09-24T08:10:32Z",
  "query": "Connaught Place",
  "suggestions": [
    {
      "entity_name": "Connaught Place, New Delhi, Delhi, India",
      "is_order_location": true,
      "latitude": 28.6304203,
      "location_type": "geocode",
      "longitude": 77.2177216,
      "subtitle": "New Delhi, Delhi, India",
      "title": "Connaught Place"
    }
  ]
}
```
### 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` | 1 |
| `fetched_at` | `string` | 2026-09-24T08:10:32Z |
| `query` | `string` | Connaught Place |
| `suggestions` | `array` | 1 items |
| `suggestions` | `array` | 1 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)
