# Functions
NewClient returns a new Client instance using the provided application credentials, optional default consumer credentials, and optional HTTPClient.
WithAccessCredentials returns a new context with the provided parent context and AccessCredentials.
# Structs
AccessCredentials represents an OAuth token and secret pair.
BoundingBox represents a bounding box of coordinates which encloses a Place.
Client represents the client used to make requests to the Twitter API 1.1.
Configuration represents the configuration object received from Twitter help/configuration endpoint.
ConfigurationResponse represents a response from Twitter containing configuration.
ConsumerCredentials represents a token/secret pair of auth credentials.
Contributor represents a user who contributed to the authorship of a tweet.
Coordinates represents the geographic location of a Tweet as reported by the user or client application.
CreateFavoriteParameters represents query parameters for a /favorites/create.json request.
DeleteMessage represents a stream message that a given Tweet has been deleted.
DestroyDirectMessageParams ...
DestroyFavoriteParameters represents query parameters for a /favorites/create.json request.
DestroyTweetParams represents the query parameters for a /statuses/destroy/:id.json request.
DirectMessage ...
DirectMessageResponse represents a response from Twitter containing a single DirectMessage.
DirectMessagesResponse represents a response from Twitter containing multiple DirectMessages.
DisconnectMessage represents a stream message that the stream will disconnect with the provided code and reason.
Entities provides metadata and additonal contextual information about twitter content.
Error represents an individual error from Twitter.
Errors represents an error response from the Twitter API, possibly containing multiple individual errors.
ExtendedEntities provides metadata about the media entities present.
ExtendedTweet represents the full information for an extended tweet.
Friendship represents a relationship between two Twitter users.
FriendshipLookup represents a Twitter user's relationship to currently authorized user.
FriendshipLookupResponse represents a response from Twitter with a list of user relationship details relative to currently authorized user.
FriendshipResponse represents a response from Twitter with two objects describing the relationship between two users.
GetDirectMessagesParams ...
HashtagEntity represents hashtags which have been parsed out of the Tweet text.
HomeTimelineParams represents the query parameters for a /statuses/home_timeline.json request.
HTTPMock represents mock struct for http client to implement HTTPClient interface.
IDs represents a paginated list of string IDs.
IDsResponse represents a response from Twitter with paginated string IDs.
Image represents info on a Twitter image.
Language represents the language obejct received from Twitter help/langauges.
LanguagesResponse represents a response from Twitter containing languages.
LimitMessage represents a stream message that a filtered stream has matched more tweets than its current rate limit allows to be delivered.
ListFavoritesParams represents the query parameters for a /favorites/list.json request.
Location represents a set of lat/long coordinates.
LookupFriendshipsParams represents parameters for /friendships/lookup.json Twitter endpoint.
LookupParams represents the query parameters for a /statuses/lookup.json request.
LookupUsersParams represents parameters to send to /users/lookup.json Twitter endpoint.
MediaEntity represents media elements uploaded with a Tweet.
MediaInsights represents the smallest piece of Twitter's response object for a call to their insights API.
MediaSize represents the height, width, and resize string of a media element.
MediaSizes represents a range of media sizes.
MediaUpload represents a Twitter's response object for media upload.
MediaUploadParameters represents the query parameters for /media/upload.json request
INIT requires: Command=INIT, MediaType, TotalBytes APPEND requires: Command=APPEND, MediaID, Media OR MediaData, SegmentIndex FINALIZE requires: Command=FINALIZE, MediaID
.
MediaUploadResponse represents a response from Twitter after media is uploaded.
MentionsTimelineParams represents the query parameters for a /statuses/mentions_timeline.json request.
NewDirectMessageParams ...
OEmbed represents the response body for an oembed request.
OEmbedParams represents the query parameters for an oembed request.
OEmbedResponse represents a response from Twitter oembed request.
PhotoSize represents the photo size object iside configuration objectt.
Place represents a specific named location with corresponding geo coordinates.
PostInsightsParams represents the body parameters for the /insights/engagement/total request.
PostInsightsResponse represents a response from Twitter to retrieve insights for a given tween.
PrivacyResponse represents a response from Twitter containing privacy.
RateLimit represents the Twitter rate limit for the credentials used in the associated request.
RateLimitsRes ...
RateLimitStatusResponse represents a response from Twitter containing multiple RateLimitStatuses.
Relationship represents a pair of Twitter users' relationship with each other.
RelationshipTarget represents a Twitter user's relationship with a source.
RetweeterIDsParams represents the query parameters for a /statuses/retweeters/ids.json request.
RetweetParams represents the query parameters for a /statuses/retweet/:id.json request.
RetweetsOfMeParams represents the query parameters for a /statuses/retweets_of_me.json request.
RetweetsOfTweetParams represents the query parameters for a /statuses/retweets/:id.json request.
ScrubGeoMessage represents a stream message that geolocated data must be stripped from a range of Tweets.
SearchTweetsParams represents the query parameters for a /search/tweets.json request.
SearchUsersParams represents parameters to send to /users/search.json Twitter endpoint.
SentDirectMessagesParams ...
ShowFriendshipsParameters represents parameters for /friendships/show.json Twitter endpoint.
ShowTweetParams represents the query parameters for a /statuses/show/:id.json request.
ShowUserParams reperesents parameters to send to /users/show.json Twitter endpoint.
StatusWithheldMessage represents a stream message that the indicated tweet has been withheld.
Stream represents a Twitter stream connection.
StreamFilterParams represents the filter parameters used in a stream.
StreamMessage represents a message received from a Twitter stream.
TOSResponse represents a response from Twitter containing terms of service.
Tweet represents a Twitter tweet object.
TweetResponse represents a response from Twitter containing a single Tweet.
TweetsResponse represents a response from Twitter containing multiple Tweets.
UnretweetParams represents the query parameters for a /statuses/retweet/:id.json request.
UpdateTweetParams represents the query parameters for a /statuses/update.json request.
URLEntities represents a list of url entities.
URLEntity represents URLs included in the text of a Tweet or within textual fields of a user object.
User represents a twitter user object, as received using the twitter REST API.
UserMentionEntity represents other Twitter users mentioned in the text of a tweet.
UserResponse represents a response from Twitter with a user object.
UsersResponse represents a response from Twitter with a list of user objects.
UserTimelineParams represents the query parameters for a /statuses/user_timeline.json request.
UserWithheldMessage represents a steram message that tweets from the indicated user have been withheld.
Video represents info on a Twitter video.
VideoInfo represents information specific to videos.
VideoVariant represents video info for a single bitrate.
# Interfaces
Backoff is the interface for stream retries.
HTTPClient is the interface for making HTTP requests.
# Type aliases
InsightsData represents the object that wraps the response from Twitter's Insights API.
StreamErrFn represents a function that is called when an error is encountered in a stream and the connection will be retried.
TweetIDs represents a subset of the return object for the Twitter Insights API.