ConScrap.StockTwitsClient Class Reference

Stock Twits Http Client Implements rate limiting and the v1 endpoints. More...

Public Member Functions
	StockTwitsClient (int rateLimit=200)
	Parameters rateLimit Rate limit for requests (should be 1 for personal apikey). More...
async Task< Types.stSymbolResp >	GetData (string ticker)
	Overloaded function that can get values for given metadata type Fetch game data by metadata - calls /v1/data/{metaType} More...

Properties
HttpClient	Client = new HttpClient() [get]

Detailed Description

Stock Twits Http Client Implements rate limiting and the v1 endpoints.

Todo:

label this package as v1 (intend to support v2 as a hobby)

<remark> Consider making validators in a different class </remark>

Constructor & Destructor Documentation

StockTwitsClient()

ConScrap.StockTwitsClient.StockTwitsClient ( int  rateLimit = 200 )

inline

Parameters

rateLimit

Rate limit for requests (should be 1 for personal apikey).

Todo:

TODO figure out how to handle urls when v2 comes out

Member Function Documentation

GetData()

async Task< Types.stSymbolResp > ConScrap.StockTwitsClient.GetData ( string  ticker )

inline

Overloaded function that can get values for given metadata type Fetch game data by metadata - calls /v1/data/{metaType}

<remark> Since arbitary json data is returned from the api, data is a List of dictionary of System.Text.Json.JsonElement </remark>

---

The documentation for this class was generated from the following file:

• StockTwits.cs