twitter

Documentation

Index

• type AdditionalTweetMetadata
• type Client
  • func NewClient(clientId, clientSecret string) *Client
  • func (c *Client) GetUserById(ctx context.Context, id string) (*User, error)
  • func (c *Client) GetUserByUsername(ctx context.Context, username string) (*User, error)
  • func (c *Client) GetUserTweets(ctx context.Context, userId string, maxResults int, nextToken *string) ([]*Tweet, *string, error)
  • func (c *Client) SearchRecentTweets(ctx context.Context, searchString string, maxResults int, nextToken *string) ([]*Tweet, *string, error)
• type PublicMetrics
• type Tweet
  • func (t *Tweet) IsRetweet() bool
• type User

Types

type AdditionalTweetMetadata

type AdditionalTweetMetadata struct {
	Author *User
}

AdditionalTweetMetadata adds additinal metadata to a tweet that isn't directly represented in the Twitter API response

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(clientId, clientSecret string) *Client

NewClient returns a new Twitter client

func (*Client) GetUserById

func (c *Client) GetUserById(ctx context.Context, id string) (*User, error)

GetUserById makes a request to the Twitter API and returns the user's information by ID

func (*Client) GetUserByUsername

func (c *Client) GetUserByUsername(ctx context.Context, username string) (*User, error)

GetUserByUsername makes a request to the Twitter API and returns the user's information by username

func (*Client) GetUserTweets

func (c *Client) GetUserTweets(ctx context.Context, userId string, maxResults int, nextToken *string) ([]*Tweet, *string, error)

GetUserTweets gets tweets for a given user

func (*Client) SearchRecentTweets

func (c *Client) SearchRecentTweets(ctx context.Context, searchString string, maxResults int, nextToken *string) ([]*Tweet, *string, error)

SearchRecentTweets searches for recent tweets within the last 7 days matching a search string.

type PublicMetrics

type PublicMetrics struct {
	FollowersCount int `json:"followers_count"`
	FollowingCount int `json:"following_count"`
	TweetCount     int `json:"tweet_count"`
	LikeCount      int `json:"like_count"`
}

PublicMetrics represents the structure for public metrics in the Twitter API response

type Tweet

type Tweet struct {
	ID       string  `json:"id"`
	Text     string  `json:"text"`
	AuthorID *string `json:"author_id"`

	AdditionalMetadata AdditionalTweetMetadata
}

Tweet represents the structure for a tweet in the Twitter API response

func (*Tweet) IsRetweet

func (t *Tweet) IsRetweet() bool

IsRetweet returns whether the tweet is a retweet

type User

type User struct {
	ID              string        `json:"id"`
	Username        string        `json:"username"`
	Name            string        `json:"name"`
	VerifiedType    string        `json:"verified_type"`
	ProfileImageUrl string        `json:"profile_image_url"`
	PublicMetrics   PublicMetrics `json:"public_metrics"`
}

User represents the structure for a user in the Twitter API response