Buckets

Total balance of a bucket

Confirmed and unconfirmed, for every address in it; with height or time, the confirmed total at that point (and with members=true each address's). One request.

get/buckets/{bucket}/balance

Request

  • Base URL: https://sochain.com/api/v3
  • URL: https://sochain.com/api/v3/buckets/{bucket}/balance
  • Auth: one of:
    • API key in header API-KEY
    • API key in query parameter api_key

Path parameters

bucketstring required

Letters, numbers, - and _, up to 64 characters. Unique within your account.

Query parameters

heightinteger

The confirmed balance at the end of this block, instead of now.

timestring
Example:2025-12-31

The confirmed balance at this time, instead of now: Unix seconds, a UTC date (meaning the end of that day) or an RFC 3339 timestamp. It's taken at the last block at or before it. Not together with height.

membersboolean

With height or time: each address's balance too.

Response

Success.

status'success' required

Example response

{
  "data": {
    "confirmed": "0.00024300",
    "unconfirmed": "0.00024300"
  }
}

Changes

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