Get Blob Storage usage

GET

account

stats

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

{
  "status": "success",
  "response": {
    "usage": {
      "objects": 1284,
      "storage": 3221225472
    },
    "plan": {
      "included": 5368709120
    },
    "billing": {
      "extraStorage": 0,
      "storagePrice": 0,
      "objectsPrice": 0,
      "totalEstimate": 0
    },
    "month": {
      "days": 24,
      "average_storage": 3006477107
    }
  }
}

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: number of files, bytes stored, the storage included in your plan, this month’s average usage and the estimated cost of anything held beyond the included storage (R$ 0.20 per started GiB). Use it to build a usage meter or check headroom before a large batch of uploads. Requires the blob:read scope. The response is cached for 1 minute, and your own uploads and deletes clear that cache, so they show up right away.

Rate limits

20 requests per minute, blocked for a short period past that (RATE_LIMITED, 429).

Response

string

“success” if successful, “error” if not.

object

Show Toggle object

object

number

The number of files in your account.

number

The total size of your files, in bytes.

object

number

The storage included in your plan, in bytes.

object

number

The storage beyond the included amount, in bytes.

number

The estimated cost of that storage, in BRL (R$ 0.20 per started GiB).

number

Reserved for per-file pricing; always 0.

number

The total estimate, in BRL.

object

number

How many days of the current month (UTC) have a usage sample.

number

The average of those daily samples, in bytes.

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

{
  "status": "success",
  "response": {
    "usage": {
      "objects": 1284,
      "storage": 3221225472
    },
    "plan": {
      "included": 5368709120
    },
    "billing": {
      "extraStorage": 0,
      "storagePrice": 0,
      "objectsPrice": 0,
      "totalEstimate": 0
    },
    "month": {
      "days": 24,
      "average_storage": 3006477107
    }
  }
}

Errors

Code	HTTP	When
`RATE_LIMITED`	429	More than 20 requests in a minute.

Blob SDK: blob.stats()

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

{
  "status": "success",
  "response": {
    "usage": {
      "objects": 1284,
      "storage": 3221225472
    },
    "plan": {
      "included": 5368709120
    },
    "billing": {
      "extraStorage": 0,
      "storagePrice": 0,
      "objectsPrice": 0,
      "totalEstimate": 0
    },
    "month": {
      "days": 24,
      "average_storage": 3006477107
    }
  }
}

Get started

Objects

Chunked uploads

Account

Share links

S3

Rate limits

Response

Errors

​Rate limits

​Response

​Errors

​Related

Rate limits

Response

Errors

Related