system

The account's spendable/refundable balance + atom display (session or ApiKey auth).

get/user/balance

Request

  • Base URL: https://snowsignals.io/v1
  • URL: https://snowsignals.io/v1/user/balance
  • Auth: one of:
    • API key in query parameter apiKey
    • API key in header Authorization

Response

Balance view. Amounts are micro-USD (1e-6 USD).

spendable_micro_usdinteger

Balance available to spend on metered requests.

refundable_micro_usdinteger

Amount currently in a refund/withdrawal hold.

spendPausedboolean

True while a refund is settling (requests return 423).

base_rate_micro_usdinteger

Price of one atom (base rate).

atomsinteger

Spendable balance expressed in whole atoms (floor(spendable / base rate)).

Example response

{
  "spendable_micro_usd": 4958060,
  "base_rate_micro_usd": 2314,
  "atoms": 2142,
  "multiplier_tiers": [
    {
      "max_rows": 5,
      "factor": 1.15
    }
  ],
  "deposit_addresses": [
    {
      "chain": "base",
      "address": "0x1234abcd...ef90"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.