Struct brawlhalla::APIConnection

pub struct APIConnection { /* fields omitted */ }

The actual API handler struct which is created from a ConnectionBuilder.

This struct handles all the API calling. You can construct it with a Builder struct, which you can get either from a ConnectionBuilder or the .builder() method.

Methods

impl APIConnection

pub fn builder<'a>() -> ConnectionBuilder<'a>

Returns a builder for an APIConnection. This just calls ConnectionBuilder::default().

pub async fn search_by_steam_id<'_>(
    &'_ self,
    steamid: u64
) -> Result<SearchResult, APIError>

Searches a Brawlhalla player by their steam64 id.

pub async fn rankings<'_, '_, '_>(
    &'_ self,
    bracket: &'_ str,
    region: &'_ str,
    page: u64
) -> Result<Vec<Rankings>, APIError>

Retrieves a specific page of ranked player stats. One page contains 50 entries. Warning: Indexing starts at 1 here!

pub async fn rankings_search<'_, '_, '_, '_>(
    &'_ self,
    bracket: &'_ str,
    region: &'_ str,
    name: &'_ str
) -> Result<Vec<Rankings>, APIError>

Searches a player by their name and returns ranked data for every possible match.

pub async fn player_stats<'_>(
    &'_ self,
    brawlhalla_id: u64
) -> Result<Player, APIError>

Retrieves information about the player with the specified Brawlhalla ID.

pub async fn ranked_stats<'_>(
    &'_ self,
    brawlhalla_id: u64
) -> Result<RankedStats, APIError>

Retrieves ranked stats about the player with the specified Brawlhalla ID.

pub async fn claninfo<'_>(&'_ self, clan_id: u64) -> Result<Clan, APIError>

Retrieves clan stats about the clan with the specified clan ID.

pub async fn legends<'_>(&'_ self) -> Result<Vec<SmallLegend>, APIError>

Retrieves miscellanous data about all legends, such as legend ID, bio, name etc.

pub async fn legendinfo<'_>(
    &'_ self,
    legendid: u64
) -> Result<FullLegend, APIError>

Retrieves extensive data about a single legend specified by their legend ID.