Twitter

Twitter

Twitter is an online social networking service that enables users to send and receive short messages called 'tweets'. Connect to Twitter to manage your tweets. You can perform various actions such as send tweet, search, view followers, etc.

LIMITS

The following are some of the limits and restrictions:

  1. Maximum number of connections per user: 2
  2. API call rate limit for POST operation: 12 per hour
  3. API call rate limit for other operations: 600 per hour
  4. Frequency of trigger polls: 60 seconds
  5. Maximum size of image upload: 5 MB
  6. Maximum size of video upload: 15 MB
  7. Maximum number of search results: 100

Additional restrictions for POST operation

Mentioning a @user while posting a tweet is not supported. Specifically, the "@" characters will be stripped while posting a tweet.

Throttling Limits

Name Calls Renewal Period
Frequency of trigger polls 1 60 seconds

Connections per account: 2

Actions

Get followers

This operation gets the list of users that follow a given user.

Required Parameters

User name
string
Twitter handle for the user

Optional Parameters

Maximum results
integer
Maximum number of users to return

Returns

array of UserDetailsModel

Get following

The operation gets the list of people the given user follows.

Required Parameters

User name
string
Twitter handle for the user

Optional Parameters

Maximum results
integer
Maximum number of users to return

Returns

array of UserDetailsModel

Get home timeline

This operation gets the most recent tweets and re-tweets posted by me and my followers.

Optional Parameters

Maximum results
integer
Maximum number of tweets to return

Returns

array of TweetModel

Get my followers

This operation gets the list of users who are following me.

Optional Parameters

Maximum results
integer
Maximum number of users to get

Returns

array of UserDetailsModel

Get my following

This operation gets the list of users that I am following.

Optional Parameters

Maximum results
integer
Maximum number of users to return

Returns

array of UserDetailsModel

Get user

This operation gets the profile details for a given user, such as user name, description, followers count, and more.

Required Parameters

User name
string
Twitter handle for the user

Returns

Body
UserDetailsModel

Represents a user.

Get user timeline

This operation gets a list of the most recent tweets posted by a given user.

Required Parameters

User name
string
Twitter handle for the user

Optional Parameters

Maximum results
integer
Maximum number of tweets to return

Returns

array of TweetModel

Post a tweet

This operation posts a new tweet.

Optional Parameters

Tweet text
string
Text to be posted
Media
binary
Media to be posted

Returns

Body
TweetResponseModel

Represents the response of a tweet post.

Search tweets

This operation gets a list of relevant tweets matching the search query.

Required Parameters

Search text
string
Search term like "happy hour", #haiku, love OR hate

Optional Parameters

Maximum results
integer
Maximum number of tweets to return
sinceId
string
Return tweets after the specified tweet ID

Returns

array of TweetModel

Triggers

When a new tweet is posted

This operation triggers a flow when a new tweet that matches a given search query is posted.

Required Parameters

Search text
string
Search term like "happy hour", #haiku, love OR hate

Returns

Body
TriggerBatchResponse[TweetModel]

Represents a wrapper object for batch trigger response

Definitions

TweetModel

Represents a tweet post.

Created at
string
Time at which the tweet was posted
Favorited
boolean
Indicates whether the tweet is marked as favorited or not
Media urls
array of string
Url of the media posted along with the tweet
OriginalTweet
OriginalTweetModel
Represents an original tweet post.
Retweet count
integer
Total number of re-tweets for the tweet
Tweet id
string
Id of the tweet
Tweet language
string
Language code of the tweet
Tweet text
string
Text content of the tweet
Tweeted by
string
Name of the user who has posted the tweet
User mentions
array of UserMentionsModel
List of users mentioned in the tweet
UserDetails
UserDetailsModel
Represents a user.
in_reply_to_user_id
string
User Id of the author of the tweet that the current tweet is a reply to

UserMentionsModel

Represents a user mentioned in a tweet.

Mentioned user full name
string
Full name of the user
Mentioned user id
integer
Twitter id (handle) of the user
Mentioned user name
string
Screen name of the user

OriginalTweetModel

Represents an original tweet post.

Original tweet created at
string
Time at which original tweet was posted
Original tweet favorited
boolean
Indicates whether the original tweet is marked as favorited
Original tweet id
string
Id of the original tweet
Original tweet in_reply_to_user_id
string
User Id of the author of the tweet that the current original tweet is a reply to
Original tweet language
string
Language code for the original tweet
Original tweet media urls
array of string
Url of the media posted along with the original tweet
Original tweet retweet count
integer
Total number of re-tweets for this original tweet
Original tweet text
string
Text content of the original retrieved tweet
Original tweet tweeted by
string
User name of the person who posted the original tweet
Original tweet user mentions
array of OriginalTweetUserMentionsModel
The list of user mentioned in the tweet
UserDetails
OriginalTweetUserDetailsModel
Represents a user who posted an original tweet

UserDetailsModel

Represents a user.

Description
string
User description
Favourites count
integer
Number of tweets that the user has favorited
Followers count
integer
Number of followers
Friends count
integer
Number of friends
Location
string
Location of the user
Name
string
Name of the user
Profile image url
string
Url of the profile image
Statuses count
integer
User status count
User id
integer
Twitter id (handle) of the user
User name
string
Screen name of the user

OriginalTweetUserMentionsModel

Represents a user mentioned in an original tweet.

Original tweet mentioned user full name
string
Full name of the user
Original tweet mentioned user id
integer
Twitter id (handle) of the user
Original tweet mentioned user name
string
Screen name of the user

OriginalTweetUserDetailsModel

Represents a user who posted an original tweet

Original tweet user Description
string
User description
Original tweet user Location
string
Location of the user
Original tweet user favourites count
integer
Number of tweets that the user has favorited
Original tweet user followers count
integer
Number of followers
Original tweet user friends count
integer
Number of friends
Original tweet user full name
string
Name of the user
Original tweet user id
integer
Twitter id (handle) of the user
Original tweet user name
string
Screen name of the user
Original tweet user profile image url
string
Url of the profile image
Original tweet user statuses count
integer
User status count

TweetResponseModel

Represents the response of a tweet post.

Tweet id
string
ID of the tweet posted

TriggerBatchResponse[TweetModel]

Represents a wrapper object for batch trigger response

value
array of TweetModel
A list of the response objects