> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Instagram Popular Search

Search Instagram by keyword without a login and get top posts and reels, related search terms and the topic's total media count.

`GET|POST https://api.scrapier.io/api/v2/instagram-popular-search/` · 1 credit per successful call · Cursor-paginated · Long-running

## Overview

Send a keyword in `queries`. You get back matching popular posts in `posts` (shortcode, URL, type, caption, video URL, play count, owner), plus `suggested_terms` and a topic summary: `title`, `total_media_count` and `description`.

No session cookie is needed. Page on with `cursor`.

## Use cases

- Find the most-watched content for a topic.
- Discover related search terms for keyword research.
- Gauge how big a topic is on Instagram.

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/instagram-popular-search/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "queries=ronaldo" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/instagram-popular-search/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"queries": "ronaldo"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["posts"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `queries` | string | yes | e.g. `ronaldo` | Search keyword. Required first call. title/total_media_count/description are only populated on page 1 (SSR-only fields; null on later pages). |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.posts`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "query": "ronaldo",
    "success": true,
    "title": "Ronaldo",
    "total_media_count": 110000000,
    "description": {
      "plain_text": "Cristiano Ronaldo was included in Portugal’s Nations League squad...",
      "source_uris": [
        "https://gulfnews.com/sport/football/cristiano-ronaldo-is-not-retiring..."
      ],
      "linked_terms": []
    },
    "suggested_terms": [
      "ronaldo jr",
      "ronaldinho",
      "cristiano ronaldo"
    ],
    "posts": [
      {
        "id": "POLARIS_3123456789012345678",
        "shortcode": "CxYzAbC123",
        "url": "https://www.instagram.com/reel/CxYzAbC123/",
        "type": "reel",
        "caption": "Ronaldo training highlights",
        "video_url": "https://scontent.cdninstagram.com/....mp4",
        "play_count": 5400000,
        "owner": {
          "id": "173560420",
          "username": "cristiano",
          "is_verified": true
        }
      }
    ],
    "next_cursor": "eyJ2ZXJzaW9uIjoxLCJxdWVyeSI6InJvbmFsZG8iLCJhZnRlciI6IlFWSlRSbmxSUFQwPSIsImxzZCI6IkFCQ2RlZiIsImNzcmZUb2tlbiI6IlhZWiJ9"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `query` | string | `ronaldo` |  |
| `success` | boolean | `true` |  |
| `title` | string | `Ronaldo` |  |
| `total_media_count` | integer | `110000000` |  |
| `description` | object | `{…}` |  |
| `suggested_terms` | array | `[3 items]` |  |
| `posts` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJ2ZXJzaW9uIjoxLCJxdWVyeSI6InJvbmFsZG8iLCJhZ…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `posts[].id` | string | `POLARIS_3123456789012345678` |  |
| `posts[].shortcode` | string | `CxYzAbC123` |  |
| `posts[].url` | string | `https://www.instagram.com/reel/CxYzAbC123/` |  |
| `posts[].type` | string | `reel` |  |
| `posts[].caption` | string | `Ronaldo training highlights` |  |
| `posts[].video_url` | string | `https://scontent.cdninstagram.com/....mp4` |  |
| `posts[].play_count` | integer | `5400000` |  |
| `posts[].owner` | object | `{…}` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/instagram-popular-search/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"queries": "ronaldo"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("posts") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- `title`, `total_media_count` and `description` are only filled on page 1. They are null on later pages.
- The response data carries its own `success` field from the scraper. The outer `success` is what counts: an HTTP 200 with outer `success: true` is billed, even if the inner field says otherwise.
- This endpoint can take several minutes. Set your client timeout to at least 210 seconds.

## Related

- [Instagram Profile Search](https://docs.scrapier.io/api-reference/instagram/instagram-profile-search.md): Search Instagram accounts by keyword and get usernames, names, follower counts and verification status.
