Namespace Guild

Index

Classes

Interfaces

Functions

Functions

Const get

get(): Promise<Guild>

remarks

Requires Settings.sessionId to be set.

endpoint

https://api.pathofexile.com/guild

throws

APIError

Returns Promise<Guild>

Guild data of the account the session ID belongs to

Const getAccountPointTransactions

getAccountPointTransactions(options?: StashHistoryOptions): Promise<PointTransactions>

remarks

Requires Settings.sessionId to be set.

endpoint

https://api.pathofexile.com/account/guild/point-transactions

throws

APIError

Parameters
- Optional options: StashHistoryOptions
Returns Promise<PointTransactions>

Point transactions the account the session ID belongs to has made to guilds

Const getPointTransactions

getPointTransactions(options?: StashHistoryOptions): Promise<PointTransactions>

remarks

Requires Settings.sessionId to be set.

endpoint

https://api.pathofexile.com/guild/point-transactions

throws

APIError

Parameters
- Optional options: StashHistoryOptions
Returns Promise<PointTransactions>

Point transactions for the guild the session ID belongs to

Const getStashHistory

getStashHistory(guildId: string, options?: StashHistoryOptions): Promise<StashHistory>

remarks

Requires Settings.sessionId to be set.

endpoint

https://api.pathofexile.com/guild/id/stash/history

throws

APIError

Parameters
- guildId: string
- Optional options: StashHistoryOptions
Returns Promise<StashHistory>

Generated using TypeDoc