BserClient.BserHttpClient Class Reference

Black Survival Eternal Return (bser) Http Client Implements rate limiting and the v1 endpoints. More...

Public Member Functions
	BserHttpClient (string apiKey, string version="v1", int rateLimit=1, int burstLimit=2)
async Task< BserMetaData >	GetData ()
	Fetch game data by metadata - calls /v1/data/{metaType} More...
async Task< BserTypeData >	GetData (string metaType)
	Overloaded function that can get values for given metadata type Fetch game data by metadata - calls /v1/data/{metaType} More...
async Task< BserRankTop >	GetRankTop (int seasonId=0, int matchingTeamMode=1)
	Fetch game data by metadata - calls /v1/rank/top/{seasonId}/{matchingTeamMode}
async Task< BserRankUser >	GetRankUser (int userNum, int seasonId=0, int matchingTeamMode=1)
	Fetch game data by metadata - calls /v1/rank/{userNum}/{seasonId}{matchingTeamMode}
async Task< BserUserGames >	GetUserGames (int userNum, int next=0)
	Fetch game data by metadata - calls /v1/user/games/{userNum}
async Task< BserUserGames >	GetFullGame (int gameNum)
	Fetch full game data, returns an list of user games for each player in the game
async Task< BserUserStats >	GetUserStats (int userNum, int seasonId=1)
	Fetch game data by metadata - calls /v1/user/games/{userNum}
async Task< BserUserNickname >	GetUserNickname (string nickname)
	Fetch user details by username
async Task< BserRecommendedRoutes >	GetWeaponRoutes ()
	Obtain recommended weapon routes
async Task< BserRecommendedRoute >	GetWeaponRoutesById (int routeId)
async Task< Bserl10n >	Getl10nData (string language="English")
	Get international data options are Korean, English, Japanese, ChineseSimplified, ChineseTraditional, French, Spanish, //SpanishLatin, Portuguese, PortugueseLatin, Indonesian, German, Russian, Thai, Vietnamese

Static Public Member Functions
static void	PrintRespErrors (BserRespData bserData)
	Output code and message for erronous requests

Properties
HttpClient	Client = new HttpClient() [get]

Detailed Description

Black Survival Eternal Return (bser) 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

BserHttpClient()

BserClient.BserHttpClient.BserHttpClient ( string  apiKey, string  version = "v1", int  rateLimit = 1, int  burstLimit = 2  )

inline

Parameters

apikey	Bser apikey from developer api portal.
rateLimit	Rate limit for requests (should be 1 for personal apikey).
burstLimit	Burst limit for requests (should be 2 for personal apikey).

Todo:

TODO figure out how to handle urls when v2 comes out

Member Function Documentation

GetData() [1/2]

async Task< BserMetaData > BserClient.BserHttpClient.GetData ( )

inline

Fetch game data by metadata - calls /v1/data/{metaType}

Parameters

metaType

Meta Type, use 'hash' to find all types

GetData() [2/2]

async Task< BserTypeData > BserClient.BserHttpClient.GetData ( string  metaType )

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:

• Client.cs