> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar o uso do Blob Storage

> Consulte o uso do Blob Storage com GET /v1/account/stats: arquivos, bytes, armazenamento incluído, a média do mês e a estimativa do que passar da cota.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

As Estatísticas da Conta retornam um retrato do seu uso do Blob Storage: número de arquivos, bytes armazenados, o armazenamento incluído no seu plano, o uso médio deste mês e o custo estimado de tudo que estiver além do armazenamento incluído (R\$ 0,20 por GiB iniciado). Use-as para montar um medidor de uso ou verificar a folga antes de um grande lote de uploads. Exige o escopo `blob:read`.

A resposta fica em cache por 1 minuto, e os seus próprios uploads e exclusões limpam esse cache, então eles aparecem na hora.

## Limites de taxa

<Note>20 requisições por minuto, com bloqueio por um curto período acima disso (`RATE_LIMITED`, 429).</Note>

## Resposta

<ResponseField name="status" type="string">
  "success" se bem-sucedida, "error" caso contrário.
</ResponseField>

<ResponseField name="response" type="object">
  <Expandable title="Alternar objeto">
    <ResponseField name="usage" type="object">
      <ResponseField name="objects" type="number">
        O número de arquivos na sua conta.
      </ResponseField>

      <ResponseField name="storage" type="number">
        O tamanho total dos seus arquivos, em bytes.
      </ResponseField>
    </ResponseField>

    <ResponseField name="plan" type="object">
      <ResponseField name="included" type="number">
        O armazenamento incluído no seu plano, em bytes.
      </ResponseField>
    </ResponseField>

    <ResponseField name="billing" type="object">
      <ResponseField name="extraStorage" type="number">
        O armazenamento além da quantidade incluída, em bytes.
      </ResponseField>

      <ResponseField name="storagePrice" type="number">
        O custo estimado desse armazenamento, em BRL (R\$ 0,20 por GiB iniciado).
      </ResponseField>

      <ResponseField name="objectsPrice" type="number">
        Reservado para cobrança por arquivo; sempre 0.
      </ResponseField>

      <ResponseField name="totalEstimate" type="number">
        A estimativa total, em BRL.
      </ResponseField>
    </ResponseField>

    <ResponseField name="month" type="object">
      <ResponseField name="days" type="number">
        Quantos dias do mês atual (UTC) têm uma amostra de uso.
      </ResponseField>

      <ResponseField name="average_storage" type="number">
        A média dessas amostras diárias, em bytes.
      </ResponseField>
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={"system"}
  curl --request GET \
    --url 'https://blob.squarecloud.app/v1/account/stats' \
    --header 'Authorization: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json Resposta - [cache de 1m] theme={"system"}
  {
    "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
      }
    }
  }
  ```
</ResponseExample>

## Erros

| Código | HTTP | Quando |
| - | - | - |
| `RATE_LIMITED` | 429 | Mais de 20 requisições em um minuto. |

## Relacionados

* SDK do Blob: [`blob.stats()`](/pt-br/sdks/blob/rules_and_stats)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.