Instagram

Get an Instagram profile

Returns a profile by username, with the connected account’s relationship to it. Counts against the daily profile view allowance. Returns 429 when the account is at its limit.

GET

/api/v1/instagram/profiles/{identity}

Path parameters

identity

required

string

Username without @.

Query parameters

connectedAccountId

required

string · uuid

Connected account to act as

Response

200Instagram profile.

profile

object

username

string | null

profileUrl

string | null

firstName

string | null

Split out of fullName, the one name a profile carries.

lastName

string | null

fullName

string | null

biography

string | null

category

string | null

Business and creator accounts only.

location

string | null

City, on business accounts only.

imageUrl

string | null

imageUrlLarge

string | null

backgroundImageUrl

string | null

followerCount

number | null

followingCount

number | null

postCount

number | null

mutualFollowerCount

number | null

Followers shared with the connected account.

externalLinks

string[]

Links in the biography.

isPrivate

boolean

True when only a follower can read the posts and followers.

isVerified

boolean

followRequestPending

boolean

True while a follow request waits for an answer, which only a private account can do.

isFollowing

boolean

True when the connected account follows.

isFollowedBy

boolean

True when they follow the connected account.

remainingUsage

object

Remaining allowance for this action on the connected account across hourly, daily, and weekly windows. Each action type has its own limits.

hour

integer | null

Remaining hourly allowance for this action. Null when this action has no hourly cap.

day

integer

Remaining daily allowance for this action.

week

integer | null

Remaining weekly allowance for this action. Null when this action has no weekly cap.

requestId

string · uuid

Id of this request, for support and troubleshooting

Errors

  • 400: Bad request
  • 401: Unauthorized: missing or invalid API key
  • 403: Forbidden
  • 404: Not found
  • 422: Invalid request payload

Search docs

Search documentation, API reference, and MCP tools

We use cookies to enhance your experience on Needle and keep your data secure. Privacy Policy