Connectors Reference

Instagram

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

 

Actions:

Name

Summary

SearchUsers (string q, [advanced][Optional]integer count)

Search users

GetMyInfo ()

Get my profile

GetUserInfo (string user-id)

Get user info

GetMyMedia ([Optional]number count, [advanced][Optional]string max_id, [advanced][Optional]string min_id)

Get my recent media

GetUserMedia (string user-id, [Optional]number count, [advanced][Optional]string max_id, [advanced][Optional]string min_id)

Get user recent media

GetMyLikes ()

Get my likes

GetUserFollows (string user-id)

Get user follows

GetUserFollowedBy (string user-id)

Get user followed-by

GetSelfRequestedBy ()

Get self requested-by

GetUserRelationship (string user-id)

Get user relationship

UpdateUserRelation (string user-id, PostRelationshipRequest action)

Update user relationship

SearchMedia (number lng, number lat, [Optional]integer distance, [advanced][Optional]string min_timestamp, [advanced][Optional]string max_timestamp)

Search media in a given area

GetMedia (string media-id)

Get media info

GetShortcodeMedia (string shortcode)

Get media by shortcode

GetMediaComments (string media-id)

Get comments for media

PostMediaComments (string media-id, PostCommentRequest comment)

Post media comments

DeleteMediaComments (string media-id, string comment-id)

Delete media comment

GetMediaLikes (string media-id)

Get likes for media

LikeMedia (string media-id)

Like media

UnlikeMedia (string media-id)

Delete the like on the media

SearchTags (string q)

Search tags

GetTag (string tag-name)

Get tag

GetTaggedMedia (string tag-name, [Optional]number count, [advanced][Optional]integer max_tag_id, [advanced][Optional]integer min_tag_id)

Get tagged media

SearchLocation ([Optional]integer distance, [Optional]string facebook_places_id, [Optional]string foursquare_v2_id, [Optional]number lng, [Optional]number lat)

Search locations

GetLocation (string location-id)

Get location by id

GetLocationMedia (string location-id, [advanced][Optional]integer max_timestamp, [advanced][Optional]integer min_timestamp, [advanced][Optional]string max_id, [advanced][Optional]string min_id)

Get media by location

 

Triggers:

Name

Summary

OnNewTaggedMedia (string tag-name)

When a new tagged media is posted

OnMyNewMedia ()

When I upload a new media

 

Objects:

Name

Summary

CaptionItem

 

CommentItem

Comment

CommentsResponse

Comments

CountsItem

 

DetailedUserItem

User

ImageItem

 

LocationItem

 

LocationResponse

 

LocationsResponse

 

MediaItem

Media Item

MediaResponse

 

MediasResponse

Media List

PostCommentRequest

 

PostRelationshipRequest

 

RelationItem

 

RelationResponse

 

ResolutionItem

 

TagItem

 

TagResponse

 

TagsResponse

 

UserItem

 

UserReponse

User

UsersReponse

 

 

Actions:

SearchUsers

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

 

GetMyInfo

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.

 

GetUserInfo

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.

 

GetMyMedia

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.

 

GetUserMedia

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.

 

GetMyLikes

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.

 

GetUserFollows

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

 

GetUserFollowedBy

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

 

GetSelfRequestedBy

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

 

GetUserRelationship

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

 

UpdateUserRelation

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

PostRelationshipRequest

 

 

True

 

Returns:

          Type:RelationResponse

 

SearchMedia

Summary: Search media in a given area

Description: Gets all media within the given distance of the given latitude and longitude

 

Syntax:

Instagram.SearchMedia (number lng, number lat, [Optional]integer distance, [advanced][Optional]string min_timestamp, [advanced][Optional]string max_timestamp)

 

Parameters:

Name

Type

Summary

Required

Related Action

lng

number(double)

(Longitude from which to search)

Longitude from which to search

True

lat

number(double)

(Latitude from which to search)

Latitude from which to search

True

distance

integer(int32)

(Distance from which to search from given latitude and longitude)

Distance from which to search from given latitude and longitude

False

min_timestamp

string

(Returns all media after the given timestamp)

Returns all media after the given timestamp

False

max_timestamp

string

(Returns all media before the given timestamp)

Returns all media before the given timestamp

False

 

Returns:

          Type:MediasResponse

          Summary: Media List

          Description: List of newly posted media content.

 

GetMedia

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

 

GetShortcodeMedia

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.

 

GetMediaComments

Summary: Get comments for media

Description: This operation returns a list of comments on a media object.

 

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.

 

PostMediaComments

Summary: Post media comments

Description: Post a comment to the

 

Syntax:

Instagram.PostMediaComments (string media-id, PostCommentRequest comment)

 

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

PostCommentRequest

 

 

True

 

Returns:

 

DeleteMediaComments

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:

 

GetMediaLikes

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

 

LikeMedia

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:

 

UnlikeMedia

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:

 

SearchTags

Summary: Search tags

Description: Search for tags based on a string query

 

Syntax:

Instagram.SearchTags (string q)

 

Parameters:

Name

Type

Summary

Required

Related Action

q

string

(Specify a query to retrieve Tags.)

Specify a query to retrieve Tags.

True

 

Returns:

          Type:TagsResponse

 

GetTag

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

 

GetTaggedMedia

Summary: Get tagged media

Description: Gets recent tagged media based on a tag name

 

Syntax:

Instagram.GetTaggedMedia (string tag-name, [Optional]number count, [advanced][Optional]integer max_tag_id, [advanced][Optional]integer min_tag_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

tag-name

string

(Name of the desired tag)

Name of the desired tag

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_tag_id

integer(int64)

(Return media earlier than this max_tag_id)

Return media earlier than this max_tag_id

False

min_tag_id

integer(int64)

(Return media earlier than this min_tag_id)

Return media earlier than this min_tag_id

False

 

Returns:

          Type:MediasResponse

          Summary: Media List

          Description: List of newly posted media content.

 

SearchLocation

Summary: Search locations

Description: Gets all locations within the given distance of the given latitude and longitude

 

Syntax:

Instagram.SearchLocation ([Optional]integer distance, [Optional]string facebook_places_id, [Optional]string foursquare_v2_id, [Optional]number lng, [Optional]number lat)

 

Parameters:

Name

Type

Summary

Required

Related Action

distance

integer(int32)

(Distance from which to search from given latitude and longitude)

Distance from which to search from given latitude and longitude

False

facebook_places_id

string

(Facebook Places Id)

Location mapped off of a Facebook places id

False

foursquare_v2_id

string

(Location mapped off of a Facebook places id)

Location mapped off a foursquare v2 api location id

False

lng

number(double)

(Longitude from which to search)

Longitude from which to search

False

lat

number(double)

(Latitude from which to search)

Latitude from which to search

False

 

Returns:

          Type:LocationsResponse

 

GetLocation

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

 

GetLocationMedia

Summary: Get media by location

Description: Gets recent media posted in the given location

 

Syntax:

Instagram.GetLocationMedia (string location-id, [advanced][Optional]integer max_timestamp, [advanced][Optional]integer min_timestamp, [advanced][Optional]string max_id, [advanced][Optional]string min_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

location-id

string

(Unique ID of the location)

Unique ID of the location

True

max_timestamp

integer(int64)

(Return media before this timestamp)

Return media before this timestamp

False

min_timestamp

integer(int64)

(Return media after this timestamp)

Return media after this timestamp

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.

 

Triggers:

Trigger OnNewTaggedMedia

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.

 

Trigger OnMyNewMedia

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.

 


 

CaptionItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

 

Caption text on the media.

created_time

integer(int64)

 

Unix time which the caption is posted.


 

CommentItem

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

UserItem

 

 


 

CommentsResponse

Summary: Comments

Description: List of comments.

 

          Properties:

Name

Type

Summary

data

array of (CommentItem)

 

The List of comment objects returned


 

CountsItem

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.


 

DetailedUserItem

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

CountsItem

 

 

website

string(uri)

 

Url of the User's instagram Page.

bio

string

 

Bio of the user.

id

string

 

Unique identifier of the user.


 

ImageItem

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.


 

LocationItem

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.


 

LocationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

LocationItem

 

 


 

LocationsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (LocationItem)

 

The List of Location Objects returned.


 

MediaItem

Summary: Media Item

Description: Properties of a single media item.

 

          Properties:

Name

Type

Summary

images

ResolutionItem

 

 

user

UserItem

 

 

link

string(uri)

 

Link to the media.

created_time

integer(int64)

 

Unix time which the media is created.

id

string

 

Unique ID for the media.

caption

CaptionItem

 

 

tags

array of (TagItem)

 

Tags put on the media.

filter

string

 

Filtered media.


 

MediaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

MediaItem

Media Item

Properties of a single media item.


 

MediasResponse

Summary: Media List

Description: List of newly posted media content.

 

          Properties:

Name

Type

Summary

data

array of (MediaItem)

 

The list of media items returned.


 

PostCommentRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

 

The text message of the comment to post.


 

PostRelationshipRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

Specify the relationship action you want to perform  Values: [follow, unfollow, approve, ignore]


 

RelationItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

incoming_status

string

 

Incoming relationship status.

outgoing_status

string

 

Outgoing relationship status.


 

RelationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

RelationItem

 

 


 

ResolutionItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

standard_resolution

ImageItem

 

 


 

TagItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

media_count

integer(int32)

 

Number of media items with the tag.

name

string

 

Name of the tag.


 

TagResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

TagItem

 

 


 

TagsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (TagItem)

 

The List of Tag Objects returned.


 

UserItem

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.


 

UserReponse

Summary: User

Description: Details of a single user.

 

          Properties:

Name

Type

Summary

data

DetailedUserItem

User

Details of a single user.


 

UsersReponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DetailedUserItem)

 

The List of users returned.