Blob Account Stats - Square Cloud

GET

account

stats

Blob Account Stats

curl --request GET \
  --url https://blob.squarecloud.app/v1/account/stats \
  --header 'Authorization: <authorization>'

import requests

url = "https://blob.squarecloud.app/v1/account/stats"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://blob.squarecloud.app/v1/account/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://blob.squarecloud.app/v1/account/stats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://blob.squarecloud.app/v1/account/stats"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://blob.squarecloud.app/v1/account/stats")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://blob.squarecloud.app/v1/account/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "usage": {
      "objects": 0,
      "storage": 0
    },
    "plan": {
      "included": 0
    },
    "billing": {
      "extraStorage": 0,
      "storagePrice": 0,
      "objectsPrice": 0,
      "totalEstimate": 0
    }
  }
}

Authorization

string

required

The API key for your account. You can find this in your account settings.

Account Stats returns a snapshot of your Blob Storage usage: object count, total bytes stored, how much of your plan’s included storage you’ve used, and the estimated cost in USD of anything over that allowance (US$ 0.25 per additional GiB, rounded up). Use it to build a usage meter or check headroom before a large batch of uploads. The response is cached per account for 1 minute, but a successful upload or delete invalidates that cache immediately, so your own writes show up right away even though the TTL bounds staleness from other sources. Calls are rate limited to 20 requests per 60 seconds, blocked for 5 minutes past that. To see which objects make up your usage, check Object List; to free up space, use Object Delete.

Status updates every 1 minute.

Response

status

string

Indicates whether the call was successful. “success” if successful, “error” if not.

response

object

Show Toggle object

usage

object

objects

number

The total number of objects in your account.

storage

number

The total size of all objects in your account, in bytes.

plan

object

included

number

The total storage size included on the plan, in bytes.

billing

object

extraStorage

number

The extra space used, in bytes.

storagePrice

number

The estimated cost of the storage beyond your included quota, in USD (US$ 0.25 per additional GiB, rounded up).

objectsPrice

number

Reserved for per-object pricing; currently always 0.

totalEstimate

number

The total estimated overage cost for the account, in USD.

{
  "status": "success",
  "response": {
    "usage": {
      "objects": 0,
      "storage": 0
    },
    "plan": {
      "included": 0
    },
    "billing": {
      "extraStorage": 0,
      "storagePrice": 0,
      "objectsPrice": 0,
      "totalEstimate": 0
    }
  }
}

Troubleshooting

401 Status Code
429 Status Code

Unauthorized

// The API key is missing or invalid. Set a valid key in the Authorization header.
{
    "status": "error",
    "code": "ACCESS_DENIED"
}

Rate limited

// Stats rate limit reached (20 requests per 60s window).
{
    "status": "error",
    "code": "RATE_LIMITED"
}

Object ListThis documentation provides a comprehensive overview of the GET /v1/objects endpoint of the SquareCloud Blob API.

Blob Account Stats

curl --request GET \
  --url https://blob.squarecloud.app/v1/account/stats \
  --header 'Authorization: <authorization>'

import requests

url = "https://blob.squarecloud.app/v1/account/stats"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://blob.squarecloud.app/v1/account/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://blob.squarecloud.app/v1/account/stats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://blob.squarecloud.app/v1/account/stats"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://blob.squarecloud.app/v1/account/stats")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://blob.squarecloud.app/v1/account/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "usage": {
      "objects": 0,
      "storage": 0
    },
    "plan": {
      "included": 0
    },
    "billing": {
      "extraStorage": 0,
      "storagePrice": 0,
      "objectsPrice": 0,
      "totalEstimate": 0
    }
  }
}

​Response

​Troubleshooting

​Unauthorized

​Rate limited

Response

Troubleshooting

Unauthorized

Rate limited