Struct WakaClient 

pub struct WakaClient { /* private fields */ }

Async HTTP client for the WakaTime API v1.

All requests are authenticated via HTTP Basic auth using the supplied API key. The client performs automatic retry with exponential back-off on transient errors (network failures and HTTP 5xx responses).

Example

use waka_api::WakaClient;

let client = WakaClient::new("waka_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx");
let me = client.me().await?;
println!("Logged in as {}", me.username);

Implementations

impl WakaClient

pub fn new(api_key: &str) -> Self

Creates a new client pointing at the production WakaTime API.

Panics

Panics if the default base URL cannot be parsed (compile-time constant — this is unreachable in practice).

pub fn with_base_url(api_key: &str, base_url: &str) -> Result<Self, ApiError>

Creates a new client pointing at a custom base URL.

Primarily used in tests to target a wiremock mock server.

Errors

Returns an error if base_url is not a valid URL.

pub async fn me(&self) -> Result<User, ApiError>

Returns the profile of the currently authenticated user.

Calls GET /users/current.

Errors

Returns ApiError::Unauthorized if the API key is invalid. Returns ApiError::NetworkError on connection or timeout failures.

pub async fn summaries( &self, params: SummaryParams, ) -> Result<SummaryResponse, ApiError>

Returns coding summaries for the date range described by params.

Calls GET /users/current/summaries.

Errors

Returns ApiError::Unauthorized if the API key is invalid. Returns ApiError::NetworkError on connection or timeout failures. Returns ApiError::ParseError if the response cannot be deserialized.

pub async fn projects(&self) -> Result<ProjectsResponse, ApiError>

Returns all projects the authenticated user has logged time against.

Calls GET /users/current/projects.

Errors

Returns ApiError::Unauthorized if the API key is invalid. Returns ApiError::NetworkError on connection or timeout failures. Returns ApiError::ParseError if the response cannot be deserialized.

pub async fn stats(&self, range: StatsRange) -> Result<StatsResponse, ApiError>

Returns aggregated coding stats for the given predefined range.

Calls GET /users/current/stats/{range}.

Errors

Returns ApiError::Unauthorized if the API key is invalid. Returns ApiError::NetworkError on connection or timeout failures. Returns ApiError::ParseError if the response cannot be deserialized.

pub async fn goals(&self) -> Result<GoalsResponse, ApiError>

Returns all coding goals for the authenticated user.

Calls GET /users/current/goals.

Errors

Returns ApiError::Unauthorized if the API key is invalid. Returns ApiError::NetworkError on connection or timeout failures. Returns ApiError::ParseError if the response cannot be deserialized.

pub async fn leaderboard( &self, page: u32, ) -> Result<LeaderboardResponse, ApiError>

Returns the public WakaTime leaderboard for the given page.

Page numbers are 1-based. Calls GET /users/current/leaderboards.

Errors

Returns ApiError::Unauthorized if the API key is invalid. Returns ApiError::NetworkError on connection or timeout failures. Returns ApiError::ParseError if the response cannot be deserialized.

Trait Implementations

impl Clone for WakaClient

fn clone(&self) -> WakaClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WakaClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.