Connectors Reference
Instagram is an online service for sharing pictures with friends and family. Connect to Instagram API to read photo streams on your Instagram account.
|
Status: Production |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
Get my profile |
|
|
Get my recent media |
|
|
Search users |
|
|
Get my profile |
|
|
Get user info |
|
|
Get my recent media |
|
|
Get user recent media |
|
|
Get my likes |
|
|
Get user follows |
|
|
Get user followed-by |
|
|
Get self requested-by |
|
|
Get user relationship |
|
|
UpdateUserRelation (string user-id, PostRelationshipRequest action) |
Update user relationship |
|
Get media info |
|
|
Get media by shortcode |
|
|
Get comments for media |
|
|
Delete media comment |
|
|
Get likes for media |
|
|
Like media |
|
|
Delete the like on the media |
|
|
Get tag |
|
|
Get location by id |
|
Name |
Summary |
|
When I upload a new media |
|
|
When a new tagged media is posted |
|
|
When I upload a new media |
|
Name |
Summary |
|
|
|
|
Comment |
|
|
Comments |
|
|
|
|
|
User |
|
|
Media List |
|
|
|
|
|
|
|
|
|
|
|
Media Item |
|
|
Media Item |
|
|
|
|
|
Media List |
|
|
Media List |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
User information |
|
|
|
|
|
User |
|
|
|
Summary: Get my profile
Description: This operation returns detailed information about a User.
Syntax:
Instagram.GetMyInfo_V2 ([advanced][Optional]string fields)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
fields |
string (Select Query) |
A comma-separated list of fields you want returned. If omitted, default fields will be returned. |
False |
Returns:
Type:User
Summary: User information
Description: Properties of a User.
Summary: Get my recent media
Description: This operation returns recent media posted by the logged in user.
Syntax:
Instagram.GetMyMedia_V2 ([advanced][Optional]string fields)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
fields |
string (Select Query) |
A comma-separated list of fields you want returned. If omitted, default fields will be returned. |
False |
Returns:
Summary: Media List
Description: List of media content.
Summary: Search users
Description: Search for users based on a string query
Syntax:
Instagram.SearchUsers (string q, [advanced][Optional]integer count)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
q |
string (Specify a query to retrieve Users.) |
Specify a query to retrieve Users. |
True |
|
|
count |
integer(int32) (Maximum Results) |
Specify the number of Users to return. |
False |
Returns:
Type:UsersReponse
Summary: Get my profile
Description: This operation returns detailed information about a User based on a username.
Syntax:
Instagram.GetMyInfo ()
Returns:
Type:UserReponse
Summary: User
Description: Details of a single user.
Summary: Get user info
Description: This operation returns detailed information about a User based on a username.
Syntax:
Instagram.GetUserInfo (string user-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
user-id |
string (User Id) |
Specify the id to retreive a User. |
True |
Returns:
Type:UserReponse
Summary: User
Description: Details of a single user.
Summary: Get my recent media
Description: This operation returns recent media posted by the logged in user.
Syntax:
Instagram.GetMyMedia ([Optional]number count, [advanced][Optional]string max_id, [advanced][Optional]string min_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
count |
number(double) (Max Count) |
Limit on the number of media objects to be retrieved (default, max = 100). |
False |
|
|
max_id |
string (Max Id) |
Return media earlier than this max Id. |
False |
|
|
min_id |
string (Min Id) |
Return media earlier than this min Id |
False |
Returns:
Type:MediasResponse
Summary: Media List
Description: List of newly posted media content.
Summary: Get user recent media
Description: Gets recent user media based on a username
Syntax:
Instagram.GetUserMedia (string user-id, [Optional]number count, [advanced][Optional]string max_id, [advanced][Optional]string min_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
user-id |
string (Unique ID of the user) |
Unique ID of the user |
True |
|
|
count |
number(double) (Limit on the number of media objects to be retrieved (default, max = 100)) |
Limit on the number of media objects to be retrieved (default, max = 100) |
False |
|
|
max_id |
string (Return media earlier than this max Id) |
Return media earlier than this max Id |
False |
|
|
min_id |
string (Return media earlier than this min Id) |
Return media earlier than this min Id |
False |
Returns:
Type:MediasResponse
Summary: Media List
Description: List of newly posted media content.
Summary: Get my likes
Description: Get the list of recent media liked by the logged in user.
Syntax:
Instagram.GetMyLikes ()
Returns:
Type:MediasResponse
Summary: Media List
Description: List of newly posted media content.
Summary: Get user follows
Description: Gets the list of follows for a user based on a username
Syntax:
Instagram.GetUserFollows (string user-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
user-id |
string (User Id) |
Specify the ID to retreive a User. |
True |
Returns:
Type:UsersReponse
Summary: Get user followed-by
Description: Gets the list of followers for a user based on a username
Syntax:
Instagram.GetUserFollowedBy (string user-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
user-id |
string (Specify the ID to retreive a User.) |
Specify the ID to retreive a User. |
True |
Returns:
Type:UsersReponse
Summary: Get self requested-by
Description: Gets the list of users who have requested this user's permission to follow
Syntax:
Instagram.GetSelfRequestedBy ()
Returns:
Type:UsersReponse
Summary: Get user relationship
Description: Gets the relationship between the current authenticated user and a desired user
Syntax:
Instagram.GetUserRelationship (string user-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
user-id |
string (Specify a query to retrieve Users.) |
Specify the ID to retreive a User. |
True |
Returns:
Type:RelationResponse
Summary: Update user relationship
Description: Modify the relationship between the current user and the target user.
Syntax:
Instagram.UpdateUserRelation (string user-id, PostRelationshipRequest action)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
user-id |
string (Specify a query to retrieve Users.) |
Specify the ID to retreive a User. |
True |
|
|
action |
|
|
True |
Returns:
Type:RelationResponse
Summary: Get media info
Description: This operation returns information about a media.
Syntax:
Instagram.GetMedia (string media-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
media-id |
string (Media Id) |
The ID of the media to fetch. |
True |
Returns:
Type:MediaResponse
Summary: Get media by shortcode
Description: This operation retrieves information about a media through a short code. A media object's shortcode can be found in its shortlink URL. An example shortlink is http://instagram.com/p/tsxp1hhQTG/. Its corresponding shortcode is tsxp1hhQTG.
Syntax:
Instagram.GetShortcodeMedia (string shortcode)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
shortcode |
string (Media Shortcode) |
The media shortcode to fetch the media by. |
True |
Returns:
Type:MediaItem
Summary: Media Item
Description: Properties of a single media item.
Summary: Get comments for media
Description: This operation returns a list of comments on a media object. It will return latest 150 comments.
Syntax:
Instagram.GetMediaComments (string media-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
media-id |
string (Media Id) |
Specify the media to fetch the comments. |
True |
Returns:
Type:CommentsResponse
Summary: Comments
Description: List of comments.
Summary: Delete media comment
Description: Delete the Media Comment
Syntax:
Instagram.DeleteMediaComments (string media-id, string comment-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
media-id |
string (Specify an ID to retrieve Media.) |
Specify the ID to retreive a Media. |
True |
|
|
comment-id |
string (Specify an ID to retrieve comment.) |
Specify the ID to retreive a comment. |
True |
Returns:
Summary: Get likes for media
Description: Gets the list of users who have liked a media object
Syntax:
Instagram.GetMediaLikes (string media-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
media-id |
string (Media id) |
Specify the media ID to fetch the likes |
True |
Returns:
Type:UsersReponse
Summary: Like media
Description: Set a like on this media by the currently authenticated user.
Syntax:
Instagram.LikeMedia (string media-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
media-id |
string (Specify an ID to retrieve Media.) |
Specify the ID to retreive a Media. |
True |
Returns:
Summary: Delete the like on the media
Description: Remove a like on this media by the currently authenticated user.
Syntax:
Instagram.UnlikeMedia (string media-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
media-id |
string (Specify an ID to retrieve Media.) |
Specify the ID to retreive a Media. |
True |
Returns:
Summary: Get tag
Description: Get Tag Details based on the tag name
Syntax:
Instagram.GetTag (string tag-name)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
tag-name |
string (Specify a name to retrieve Tag.) |
Specify a name to retrieve Tag. |
True |
Returns:
Type:TagResponse
Summary: Get location by id
Description: Gets all locations within the given distance of the given latitude and longitude
Syntax:
Instagram.GetLocation (string location-id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
location-id |
string (Location Id) |
The ID of the Location Object that is to be fetched. |
True |
Returns:
Type:LocationResponse
Summary: When I upload a new media
Description: This operation is triggered when a new media is posted to my feed.
Syntax:
Instagram.OnMyNewMedia_V2 ()
Returns:
Summary: Media List
Description: List of media content.
Summary: When a new tagged media is posted
Description: Starts a flow when a new media is posted with a certain hashtag.
Syntax:
Instagram.OnNewTaggedMedia (string tag-name)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
tag-name |
string (Name of the desired tag) |
Name of the desired tag |
True |
Returns:
Type:MediasResponse
Summary: Media List
Description: List of newly posted media content.
Summary: When I upload a new media
Description: This operation is triggered when a new media is posted to my feed.
Syntax:
Instagram.OnMyNewMedia ()
Returns:
Type:MediasResponse
Summary: Media List
Description: List of newly posted media content.
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
text |
string
|
Caption text on the media. |
|
created_time |
string
|
Unix time which the caption is posted. |
Summary: Comment
Description: Properties of a single comment.
Properties:
|
Name |
Type |
Summary |
|
created_time |
string
|
The time which the comment is created |
|
text |
string
|
The text commented. |
|
id |
string
|
The unique ID for the comment. |
|
from |
|
|
Summary: Comments
Description: List of comments.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (CommentItem)
|
The List of comment objects returned |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
media |
integer(int32)
|
Media count for the User. |
|
follows |
integer(int32)
|
Following count for the User. |
|
followed_by |
integer(int32)
|
Number of user who has followed the user. |
Summary: User
Description: Details of a single user.
Properties:
|
Name |
Type |
Summary |
|
username |
string
|
Username of the User. |
|
profile_picture |
string
|
Profile picture of the User. |
|
full_name |
string
|
Full name of the user. |
|
counts |
|
|
|
website |
string(uri)
|
Url of the User's instagram Page. |
|
bio |
string
|
Bio of the user. |
|
id |
string
|
Unique identifier of the user. |
Summary: Media List
Description: List of media content.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (Media)
|
The list of media items returned. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string(uri)
|
The url to an image on the media in set resolution. |
|
height |
integer(int32)
|
The height of an image on the media in set resolution. |
|
width |
integer(int32)
|
The width of an image on the media in set resolution. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
longitude |
number(double)
|
The longitude value of the location. |
|
latitude |
number(double)
|
The latitude value of the location. |
|
name |
string
|
Name of the location. |
|
id |
string Location id |
The unique ID of the location. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
|
Summary: Media Item
Description: Properties of a single media item.
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
The Media's ID. |
|
caption |
string
|
The Media's caption text. Not returnable for Media in albums. |
|
media_type |
string
|
The Media's type. |
|
media_url |
string(uri)
|
The Media's URL. |
|
permalink |
string(uri)
|
The Media's permanent URL. |
|
thumbnail_url |
string(uri)
|
The Media's thumbnail image URL. Only available on VIDEO Media. |
|
timestamp |
string(date-time)
|
The Media's publish date in ISO 8601 format. |
|
username |
string
|
The Media owner's username. |
Summary: Media Item
Description: Properties of a single media item.
Properties:
|
Name |
Type |
Summary |
|
images |
|
|
|
user |
|
|
|
link |
string(uri)
|
Link to the media. |
|
created_time |
string
|
Unix time which the media is created. |
|
id |
string
|
Unique ID for the media. |
|
caption |
|
|
|
tags |
array of (string)
|
Tags put on the media. |
|
filter |
string
|
Filtered media. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
Media Item |
Properties of a single media item. |
Summary: Media List
Description: List of newly posted media content.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (MediaItem)
|
The list of media items returned. |
Summary: Media List
Description: List of media content.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (Media)
|
The list of media items returned. |
|
paging |
Paging |
An object containing next data set retrievial URL. |
Summary: Paging
Description: An object containing next data set retrievial URL.
Properties:
|
Name |
Type |
Summary |
|
next |
string
|
The Graph API endpoint that will return the next page of data. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
action |
string
|
Specify the relationship action you want to perform Values: [follow, unfollow, approve, ignore] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
incoming_status |
string
|
Incoming relationship status. |
|
outgoing_status |
string
|
Outgoing relationship status. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
standard_resolution |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
media_count |
integer(int32)
|
Number of media items with the tag. |
|
name |
string
|
Name of the tag. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
|
Summary: User information
Description: Properties of a User.
Properties:
|
Name |
Type |
Summary |
|
account_type |
string
|
The User's account type. Can be BUSINESS, MEDIA_CREATOR, or PERSONAL. |
|
id |
string
|
The User's ID. |
|
ig_id |
string
|
The User's Instagram Legacy API User ID. This field will be deprecated on September 30th, 2020. |
|
media_count |
integer
|
The number of Media on the User. |
|
username |
string
|
The User's username. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
username |
string
|
Username of the user. |
|
profile_picture |
string
|
Profile picture of the user. |
|
first_name |
string
|
First name of the user. |
|
last_name |
string
|
Last name of the user. |
|
full_name |
string
|
Full name of the user. |
|
id |
string
|
Instagram ID of the user. |
Summary: User
Description: Details of a single user.
Properties:
|
Name |
Type |
Summary |
|
data |
User |
Details of a single user. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DetailedUserItem)
|
The List of users returned. |