# Instagram Profile (`instagram.profile`)

Public profile of one Instagram account by handle: bio and links, follower, following and post counts, verification and business flags.

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

- Endpoint: `POST https://api.primaryapi.com/v1/run/instagram.profile`
- Category: Social · Platform: `instagram` · Kind: lookup · Status: live
- Price: 1 credit per call; up to 3 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.profile`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `handle` | string | yes |  | max 100 chars | Instagram username, with or without the leading @. |

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 |
|---|---|---|
| `handle` | string | Canonical username |
| `userId` | string \| null | Numeric Instagram user id (pk) |
| `url` | string \| null | Profile URL |
| `displayName` | string \| null |  |
| `bio` | string \| null |  |
| `bioLinks` | object[] | Links listed in the bio, in order |
| `bioLinks[].title` | string \| null |  |
| `bioLinks[].url` | string |  |
| `externalUrl` | string \| null | Primary website link |
| `avatarUrl` | string \| null | Profile picture URL (temporary CDN link) |
| `category` | string \| null | Category label of a business or creator account |
| `contactMethod` | string \| null | Contact button type shown on the profile (EMAIL, CALL, TEXT …) |
| `followers` | integer \| null |  |
| `following` | integer \| null |  |
| `posts` | integer \| null |  |
| `highlightsCount` | integer \| null | Number of story highlight reels |
| `verified` | boolean \| null |  |
| `private` | boolean \| null |  |
| `isBusiness` | boolean \| null | Business or professional (creator) account |

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.profile" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"handle":"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": {
      "handle": "nasa",
      "userId": "string",
      "url": "https://example.com",
      "displayName": "string",
      "bio": "string",
      "bioLinks": [
        {
          "title": "string",
          "url": "https://example.com"
        }
      ],
      "externalUrl": "https://example.com",
      "avatarUrl": "https://example.com",
      "category": "string",
      "contactMethod": "string",
      "followers": 0,
      "following": 0,
      "posts": 0,
      "highlightsCount": 0,
      "verified": true,
      "private": true,
      "isBusiness": true
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: up to 3 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.profile`

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

Private accounts are found (private=true) with whatever public metadata Instagram exposes; unknown handles return found=false (not_found). Avatar URLs are signed CDN links that expire.

