Graph API Version

IGUser

Reading

Instagram User object

Example

Graph API Explorer
GET v21.0/...?fields={fieldname_of_type_IGUser} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '...?fields={fieldname_of_type_IGUser}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "...?fields={fieldname_of_type_IGUser}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "...?fields={fieldname_of_type_IGUser}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"...?fields={fieldname_of_type_IGUser}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The id of the object

biography
string

Biography of the user

business_discovery

Loads business discovery information

followers_count
integer

Active follower count of the user

follows_count
integer

Active follows count of the user

ig_id
integer

Ig Id of the user

legacy_instagram_user_id
numeric string

Legacy Instagram user id still used in some endpoints

media_count
integer

Filtered media count of the user

mentioned_comment
ShadowIGComment

Loads the comment if the user is mentioned in it

mentioned_media
ShadowIGMedia

Loads the media if the user is mentioned in the caption

name
string

Name of the user

profile_picture_url
string

The cdn url to query the raw profile picture of the user

shopping_review_status
enum

Status of the Shopping Merchant Review process for this account

username
string

Username handle of the user

website
string

Url in the profile

Edges

EdgeDescription
Edge<IGBCAdsPermission>

branded_content_ad_permissions

Edge<BrandedContentShadowIGMediaID>

branded_content_advertisable_medias

Edge<ContentPublishingLimitResponse>

content_publishing_limit

Edge<InstagramInsightsResult>

Insights data of this IG user

Edge<ShadowIGMedia>

live_media

Edge<ShadowIGMedia>

Timeline media of this IG user

Edge<UserPageOneTimeOptInTokenSettings>

notification_message_tokens

Edge<IGShoppingProductAppeal>

product_appeal

Edge<ShadowIGHashtag>

Recently searched hashtags through the Graph API by an Instagram User

Edge<ShadowIGMedia>

Stories of this IG user

Edge<ShadowIGMedia>

Media that this user is tagged in

Error Codes

ErrorDescription
110Invalid user id
100Invalid parameter
200Permissions error
190Invalid OAuth 2.0 Access Token
80002There have been too many calls to this Instagram account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
2500Error parsing graph query
3006Not enough users
368The action attempted has been deemed abusive or is otherwise disallowed

Creating

You can make a POST request to media edge from the following paths:
When posting to this edge, an IGUser will be created.

Parameters

ParameterDescription
caption
string
Default value: ""

Caption for the media to be created

collaborators
array<string>

Field that adds collaborators to a media

image_url
string

A URL where the image to be uploaded

is_carousel_item
boolean

is_carousel_item

location_id
numeric string

Location id tagged in media

media_type
string
Default value: "IMAGE"

media_type

product_tags
array<JSON object>

IG Shopping products tagged in media

share_to_feed
boolean

share_to_feed

thumb_offset
string

A numberic string for thumbnail offset in video stream to generate thumbmail

user_tags
array<JSON object>

IG users tagged in media

username
string

username

Required
x
float

x

y
float

y

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
uri: string,
}

Error Codes

ErrorDescription
80002There have been too many calls to this Instagram account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
100Invalid parameter
9004Only photo or video can be accepted as media type.
36003The aspect ratio is not supported.
110Invalid user id
36001The image format is not supported.
190Invalid OAuth 2.0 Access Token
210User not visible
36004The caption was too long.
200Permissions error

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.