Swiggy Instamart API Capability

Search suggestions

Return typed public autocomplete suggestions for a query in a known store.

Capability ID instamart.search.suggestions

Cost 1 credit per request

Maximum runtime 120 seconds

# Search suggestions

Return typed public autocomplete suggestions for a query in a known store.

- Platform: [Swiggy Instamart](https://docs.upscrape.com/docs/platforms/swiggy-instamart)
- Capability ID: `instamart.search.suggestions`
- 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": {
    "primary_store_id": "1396284",
    "query": "milk",
    "store_id": "1396284"
  },
  "capability": "instamart.search.suggestions"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `primary_store_id` | `string` | No | Primary store identifier. |
| `query` | `string` | Yes | Search query. |
| `store_id` | `string` | Yes | Store identifier. |
| `tracking_id` | `string` | No | Tracking identifier. |

### Example input

```json
{
  "primary_store_id": "1396284",
  "query": "milk",
  "store_id": "1396284"
}
```

## 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
{
  "suggestions": [
    {
      "highlighted_text": "{{Milk}}",
      "text": "Milk",
      "type": "SUGGESTION_TYPE_INSTAMART_CATEGORY"
    },
    {
      "highlighted_text": "Nandini {{milk}}",
      "text": "Nandini milk",
      "type": "SUGGESTION_TYPE_INSTAMART_HYBRID"
    },
    {
      "highlighted_text": "Organic {{Milk}}",
      "text": "Organic Milk",
      "type": "SUGGESTION_TYPE_INSTAMART_HYBRID"
    }
  ]
}
```
### Illustrative output fields

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

| Path | Observed type | Example |
| --- | --- | --- |
| `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

primary_store_id string optional

Primary store identifier.

Example 1396284

query string required

Search query.

Example milk

store_id string required

Store identifier.

Example 1396284

tracking_id string optional

Tracking identifier.

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
`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": { "primary_store_id": "1396284", "query": "milk", "store_id": "1396284" }, "capability": "instamart.search.suggestions" }'

import json import requests payload = json.loads(r'''{ "input": { "primary_store_id": "1396284", "query": "milk", "store_id": "1396284" }, "capability": "instamart.search.suggestions" }''') 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))

{ "suggestions": [ { "highlighted_text": "{{Milk}}", "text": "Milk", "type": "SUGGESTION_TYPE_INSTAMART_CATEGORY" }, { "highlighted_text": "Nandini {{milk}}", "text": "Nandini milk", "type": "SUGGESTION_TYPE_INSTAMART_HYBRID" }, { "highlighted_text": "Organic {{Milk}}", "text": "Organic Milk", "type": "SUGGESTION_TYPE_INSTAMART_HYBRID" } ] }