# Instagram Search (`instagram.search`)

Keyword search over Instagram users, hashtags or places with names, counts and links.

Docs: https://primaryapi.com/docs/api-reference/instagram/search

- Endpoint: `POST https://api.primaryapi.com/v1/run/instagram.search`
- Category: Social · Platform: `instagram` · Kind: search · Status: live
- Price: 1 credit per call; up to 29 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=instagram.search`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `query` | string | yes |  | max 500 chars | Keyword to search Instagram for, for example "coffee roastery". |
| `type` | enum | no | "user" | one of: user, hashtag, place | What to search for: user profiles, hashtags or places. |
| `limit` | integer | no | 20 | 1–20 | Maximum number of results to return (1-20, default 20). |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `items` | object[] |  |
| `items[].type` | enum |  |
| `items[].id` | string \| null |  |
| `items[].handle` | string \| null | Username (user results) |
| `items[].name` | string \| null | Full name (users), tag without # (hashtags) or place name |
| `items[].bio` | string \| null |  |
| `items[].followers` | integer \| null |  |
| `items[].following` | integer \| null |  |
| `items[].postsCount` | integer \| null | User's post count, or posts using the hashtag |
| `items[].verified` | boolean \| null |  |
| `items[].private` | boolean \| null |  |
| `items[].image` | string \| null |  |
| `items[].url` | string \| null |  |
| `items[].address` | string \| null |  |
| `items[].city` | string \| null |  |
| `items[].lat` | number \| null |  |
| `items[].lng` | number \| null |  |
| `nextCursor` | string \| null | Always null: one result page |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/instagram.search" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"nasa"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "items": [
        {
          "type": "user",
          "id": "string",
          "handle": "string",
          "name": "string",
          "bio": "string",
          "followers": 0,
          "following": 0,
          "postsCount": 0,
          "verified": true,
          "private": true,
          "image": "string",
          "url": "https://example.com",
          "address": "string",
          "city": "string",
          "lat": 0,
          "lng": 0
        }
      ],
      "nextCursor": null
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
  "nextCursor": null
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: up to 29 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=instagram.search`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

One page per call (Instagram search is personalised and volatile).

