> ## Documentation Index
> Fetch the complete documentation index at: https://getanyapi.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Instagram Basic Profile

> Sell instagram.basic_profile on AnyAPI: the request your endpoint receives, the response it must return, and what the live trial grades.

Fetch an Instagram account's core public profile fields (followers, posts, bio, verification) by user id.

This page is the seller-facing summary of one catalog API, `instagram.basic_profile`. The transport rules that apply to every API a seller serves - signed requests, the response envelope, timeouts, and body limits - are on [the operator endpoint contract](https://getanyapi.com/docs/sell/operator-endpoint-contract.md).

## The price you compete with

AnyAPI publishes this API from **\$1.00 per 1,000 requests**. That is the price a buyer sees today, so it is the price your endpoint has to come in under to win traffic.

## The request your endpoint receives

| Field | Type | Required | What it means |
| - | - | - | - |
| `requireFields` | array | no | Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `posts`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge. |
| `userId` | string | yes | Instagram numeric user id (the account's internal all-digits id, e.g. 314216), NOT the @handle or profile URL. Passing a handle here returns no profile. |

> **Full input JSON Schema**
>
> ```json theme={"dark"}
> {
>   "$schema": "https://json-schema.org/draft/2020-12/schema",
>   "$id": "https://getanyapi.com/schemas/instagram.basic_profile.input.json",
>   "example": {
>     "userId": "314216"
>   },
>   "title": "Instagram Basic Profile input",
>   "type": "object",
>   "additionalProperties": false,
>   "required": [
>     "userId"
>   ],
>   "properties": {
>     "userId": {
>       "type": "string",
>       "description": "Instagram numeric user id (the account's internal all-digits id, e.g. 314216), NOT the @handle or profile URL. Passing a handle here returns no profile."
>     },
>     "requireFields": {
>       "type": "array",
>       "uniqueItems": true,
>       "items": {
>         "type": "string",
>         "enum": [
>           "bioLinks",
>           "isBusiness",
>           "posts",
>           "title",
>           "url"
>         ]
>       },
>       "description": "Optional; omit it and routing is unchanged, with the cheapest source serving. Name the output fields this request must be able to return, for example `posts`, and it is served only by a source that returns every one of them. Fields you do not name are still returned whenever the serving source has them. This can raise your price: when the cheapest source cannot return a named field, a dearer source serves, and you are quoted and charged its price. A named field can still be absent on a profile that genuinely lacks it. Naming a combination that no single source returns together is refused as invalid input, with no charge."
>     }
>   }
> }
> ```

## The response your endpoint must return

| Field | Type | Always present | What it means |
| - | - | - | - |
| `data` | null or object | yes | |
| `data.avatarUrl` | string | yes | |
| `data.bio` | string | yes | |
| `data.bioLinks` | array or null | no | Every link the account publishes in its bio, in the order Instagram returns them. Null when this source does not report them. |
| `data.bioLinks[].title` | string | no | Display label for the link, empty when the account set none. |
| `data.bioLinks[].url` | string | yes | Destination URL, exactly as the account published it. |
| `data.displayName` | string | yes | |
| `data.externalUrl` | string | yes | |
| `data.followers` | integer | yes | |
| `data.following` | integer | yes | |
| `data.handle` | string | yes | |
| `data.isBusiness` | boolean or null | no | Whether Instagram flags the account as a business account. Null when this source does not report it. |
| `data.posts` | integer or null | no | Total number of posts on the account. Null when this source does not report it. |
| `data.private` | boolean | yes | |
| `data.userId` | string | yes | |
| `data.verified` | boolean | yes | |
| `found` | boolean | yes | |

Extra fields are kept, missing declared fields fail.

> **Full output JSON Schema**
>
> ```json theme={"dark"}
> {
>   "$schema": "https://json-schema.org/draft/2020-12/schema",
>   "$id": "https://getanyapi.com/schemas/instagram.basic_profile.output.json",
>   "title": "Instagram Basic Profile output",
>   "x-anyapi-result-list": false,
>   "type": "object",
>   "additionalProperties": false,
>   "required": [
>     "found",
>     "data"
>   ],
>   "properties": {
>     "found": {
>       "type": "boolean"
>     },
>     "data": {
>       "oneOf": [
>         {
>           "type": "null"
>         },
>         {
>           "type": "object",
>           "required": [
>             "userId",
>             "handle",
>             "displayName",
>             "followers",
>             "following",
>             "bio",
>             "verified",
>             "private",
>             "externalUrl",
>             "avatarUrl"
>           ],
>           "properties": {
>             "userId": {
>               "x-anyapi-must-populate": true,
>               "type": "string"
>             },
>             "handle": {
>               "x-anyapi-must-populate": true,
>               "type": "string"
>             },
>             "displayName": {
>               "x-anyapi-must-populate": true,
>               "type": "string"
>             },
>             "followers": {
>               "type": "integer"
>             },
>             "following": {
>               "type": "integer"
>             },
>             "bio": {
>               "type": "string"
>             },
>             "verified": {
>               "type": "boolean"
>             },
>             "private": {
>               "type": "boolean"
>             },
>             "externalUrl": {
>               "type": "string"
>             },
>             "avatarUrl": {
>               "x-anyapi-must-populate": true,
>               "type": "string"
>             },
>             "posts": {
>               "type": [
>                 "integer",
>                 "null"
>               ],
>               "description": "Total number of posts on the account. Null when this source does not report it."
>             },
>             "bioLinks": {
>               "type": [
>                 "array",
>                 "null"
>               ],
>               "description": "Every link the account publishes in its bio, in the order Instagram returns them. Null when this source does not report them.",
>               "items": {
>                 "type": "object",
>                 "required": [
>                   "url"
>                 ],
>                 "properties": {
>                   "title": {
>                     "type": "string",
>                     "description": "Display label for the link, empty when the account set none."
>                   },
>                   "url": {
>                     "type": "string",
>                     "description": "Destination URL, exactly as the account published it."
>                   }
>                 }
>               }
>             },
>             "isBusiness": {
>               "type": [
>                 "boolean",
>                 "null"
>               ],
>               "description": "Whether Instagram flags the account as a business account. Null when this source does not report it."
>             }
>           }
>         }
>       ]
>     }
>   }
> }
> ```

## Fields that must never come back empty

* `avatarUrl`
* `displayName`
* `handle`
* `userId`

The repository marks these fields as ones every source must be able to fill. An empty value is only correct when the entity itself genuinely has nothing there.

## Not found, and how it differs from empty

When the entity does not exist, answer 2xx with the not-found shape:

```json theme={"dark"}
{
  "found": false,
  "data": null
}
```

An empty list is not a not-found: when the entity exists and has nothing to return, answer 2xx with `found: true` and an empty `bioLinks` array.

This output schema declares no `reason` field, so `found: false` is the whole not-found answer.

## Example request

```json theme={"dark"}
{
  "userId": "314216"
}
```

The compatibility checks fire the schema's example at your endpoint. After that, your answers are graded against what the currently serving source returned for the same real customer inputs.

## Next

* [The operator endpoint contract](https://getanyapi.com/docs/sell/operator-endpoint-contract.md) for signing, budgets, and the live trial.
* [Every API open to sellers](https://getanyapi.com/docs/sell/apis/index.md).
* Want to sell an API that is not on that list? Email [support@getanyapi.com](mailto:support@getanyapi.com).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.