v0.8.4
Home GitHub

Balance and Quota

Last updated

Which provider packages expose a Usage function and which UsageRemaining fields each one fills.

Signature

Every package below exports the same function:

func Usage(ctx context.Context, config llmrouter.Config) (llmrouter.UsageRemaining, error)

type UsageRemaining struct {
    FiveHour *float64 `json:"five_hour,omitempty"` // percentage left in the 5-hour window
    Week     *float64 `json:"week,omitempty"`      // percentage left in the weekly window
    Balance  *float64 `json:"balance,omitempty"`   // account balance or credits left
    Total    *float64 `json:"total,omitempty"`     // percentage left of the overall quota
}

Each provider sets only the fields it reports; the rest stay nil, so check a field before dereferencing it.

Fields per package

Package Credentials Fields set
core/openRouter APIKey Balance = total_credits - total_usage
core/deepseek APIKey Balance = first balance_infos[].total_balance
core/ollamaCloud APIKey Total = (1 - limits.monthly.usage) * 100
core/copilot Token Total = remaining percentage of chat or premium interactions
core/openaiCodex APIKey, optional AccountID FiveHour / Week = 100 - used_percent of the primary / secondary rate-limit window
core/grokOauth APIKey Total = remaining credit percentage

A missing credential returns an error before any request is sent.

Example

remaining, err := openaiCodex.Usage(ctx, llmrouter.Config{APIKey: token.AccessToken, AccountID: token.AccountID})
if err != nil {
    return err
}
if remaining.FiveHour != nil && remaining.Week != nil {
    fmt.Printf("5h: %.0f%% left, week: %.0f%% left\n", *remaining.FiveHour, *remaining.Week)
}
中文