Library referenceClasses
PublicPlayersApi
GET /players/*: the social profile, search, sales, followers and feed
Constructors
Constructor
new PublicPlayersApi(gapi): PublicPlayersApi;Parameters
| Parameter | Type |
|---|---|
gapi | KrunkerClient |
Returns
PublicPlayersApi
Methods
feed()
feed(playerId, limit?): Promise<FeedPost[]>;GET /social/feed, a player's posts
Parameters
| Parameter | Type | Default value |
|---|---|---|
playerId | number | undefined |
limit? | number | 20 |
Returns
Promise<FeedPost[]>
followers()
followers(playerName): Promise<PlayerFollow[]>;GET /players/:name/followers, 100 at most
Parameters
| Parameter | Type |
|---|---|
playerName | string |
Returns
Promise<PlayerFollow[]>
following()
following(playerName): Promise<PlayerFollow[]>;GET /players/:name/following
Parameters
| Parameter | Type |
|---|---|
playerName | string |
Returns
Promise<PlayerFollow[]>
get()
get(playerName): Promise<PlayerSocialProfile>;GET /players/:name, case-insensitive, 404 "player not found"
Parameters
| Parameter | Type |
|---|---|
playerName | string |
Returns
Promise<PlayerSocialProfile>
listings()
listings(playerName): Promise<unknown[]>;GET /players/:name/listings, only ever seen empty, the developer api has the real one
Parameters
| Parameter | Type |
|---|---|
playerName | string |
Returns
Promise<unknown[]>
sales()
sales(playerName, range?): Promise<PlayerSale[]>;GET /players/:name/sales, one row per day with market sales: f = kr earned, t = items sold, d = date
Parameters
| Parameter | Type | Default value |
|---|---|---|
playerName | string | undefined |
range? | number | 3 |
Returns
Promise<PlayerSale[]>
search()
search(query, limit?): Promise<PlayerSearchResult[]>;GET /players/search, prefix match on the name
Parameters
| Parameter | Type | Default value |
|---|---|---|
query | string | undefined |
limit? | number | 5 |
Returns
Promise<PlayerSearchResult[]>