ExOsrsApi.OsrsApi (ExOsrsApi v0.1.1) View Source
Link to this section Summary
Link to this section Types
Specs
highscore_type() :: :deadman | :hardcore_ironman | :ironman | :regular | :seasonal | :tournament | :ultimate_ironman
Link to this section Functions
Link to this function
get_all_highscores(username, ratelimit \\ %{__struct__: ExOsrsApi.Ratelimit, limit: 60, timeout: 60000})
View SourceSpecs
get_all_highscores(String.t(), ExOsrsApi.Ratelimit.t()) :: [ ok: ExOsrsApi.PlayerHighscores.t(), error: ExOsrsApi.Errors.Error.t() ]
Link to this function
get_highscores(username, type, ratelimit \\ %{__struct__: ExOsrsApi.Ratelimit, limit: 60, timeout: 60000})
View SourceSpecs
get_highscores(String.t(), highscore_type(), ExOsrsApi.Ratelimit.t()) :: {:error, ExOsrsApi.Errors.Error.t()} | {:ok, ExOsrsApi.PlayerHighscores.t()}
Link to this function
get_multiple_all_highscores(usernames, ratelimit \\ %{__struct__: ExOsrsApi.Ratelimit, limit: 60, timeout: 60000})
View SourceSpecs
get_multiple_all_highscores([String.t()], ExOsrsApi.Ratelimit.t()) :: [ ExOsrsApi.PlayerHighscores.t() | {:error, ExOsrsApi.Errors.Error.t()} ]
Link to this function
get_multiple_highscores(usernames, type, ratelimit \\ %{__struct__: ExOsrsApi.Ratelimit, limit: 60, timeout: 60000})
View SourceSpecs
get_multiple_highscores([String.t()], highscore_type(), ExOsrsApi.Ratelimit.t()) :: [ExOsrsApi.PlayerHighscores.t() | {:error, ExOsrsApi.Errors.Error.t()}]
Link to this function
get_multiple_player_request(player_requests, ratelimit \\ %{__struct__: ExOsrsApi.Ratelimit, limit: 60, timeout: 60000})
View SourceSpecs
get_multiple_player_request( [ExOsrsApi.PlayerRequest.t()], ExOsrsApi.Ratelimit.t() ) :: [ExOsrsApi.PlayerHighscores.t() | {:error, ExOsrsApi.Errors.Error.t()}]
Link to this function
get_player_request(player_request, ratelimit \\ %{__struct__: ExOsrsApi.Ratelimit, limit: 60, timeout: 60000})
View SourceSpecs
get_player_request(ExOsrsApi.PlayerRequest.t(), ExOsrsApi.Ratelimit.t()) :: [ ExOsrsApi.PlayerHighscores.t() | {:error, ExOsrsApi.Errors.Error.t()} ]