twstclient

README

twitter-stream-client

client for GET /2/tweets/search/stream

Homebrew (macOS and Linux)

$ brew install mashiike/tap/twitter-stream-client

Binary packages

Releases

Usage

Usage of pkg/twitter-stream-client--darwin-amd64:
  -bearer string
        twitter v2 API bearer token (default "*****************")
  -debug
        set log min level = debug
  -expansions expansions
        query parameters expansions
  -i    alias of --inject-created-at flag
  -inject-created-at
        inject tweet.created_at to the top level
  -media-fields media.fields
        query parameters media.fields
  -place-fields place.fields
        query parameters place.fields
  -poll-fields poll-fields
        query parameters poll-fields
  -tweet-fields tweet.fields
        query parameters tweet.fields (default "id,text")
  -user-fields user.fields
        query parameters user.fields
  -werker int
        number of worker for stream processing (default 5)

Quick Start

$ export TWITTER_BEARER_TOKEN=**************
$ twitter-stream-client  -i --tweet-fields=id,text,author_id,attachments,context_annotations,created_at,entities,source,public_metrics,referenced_tweets --user-fields=id,name,username,public_metrics --media-fields=url,preview_image_url,media_key --expansions=referenced_tweets.id,attachments.media_keys > tweets.json
2021/05/18 16:45:22 [INFO] start mainloop
2021/05/18 16:45:23 [INFO] connect success
2021/05/18 16:45:24 [INFO] end mainloop
... polling data

Documentation

Index

• type App
  • func New(config *Config) (*App, error)
  • func (app *App) Run(ctx context.Context) error
• type Client
  • func NewClient(config *Config) (*Client, error)
  • func (c *Client) GetStream(ctx context.Context, params url.Values) (<-chan string, error)
• type Config
  • func (config *Config) Validate() error

Types

type App

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

func New

func New(config *Config) (*App, error)

func (*App) Run

func (app *App) Run(ctx context.Context) error

type Client

type Client struct {
	Endpoint    string
	BearerToken string
	HTTPClient  *http.Client
}

func NewClient

func NewClient(config *Config) (*Client, error)

func (*Client) GetStream

func (c *Client) GetStream(ctx context.Context, params url.Values) (<-chan string, error)

type Config

type Config struct {
	Endpoint        string
	BearerToken     string
	WorkerNum       int
	QueryParams     url.Values
	Output          io.Writer
	InjectCreatedAt bool
}

func (*Config) Validate

func (config *Config) Validate() error