---
title: "Plan, quota used today and limits"
method: GET
path: "/v1/account"
tags: ["account"]
---

# Plan, quota used today and limits

`GET /v1/account`

## Request

- Base URL: `https://api.publicwww.com`
- URL: `https://api.publicwww.com/v1/account`
- Auth: HTTP bearer

Spends nothing and does not count against the request rate.

## Query parameters

- `format` 'json' | 'xml'

## Response `200`

The account.

- Account
  - `plan` string, required
  - `plan_until` integer, required: Unix time the plan is paid until; 0 without a plan.
  - `full_access` boolean, required: Whether the API is available to this account.
  - `quota` object, required
    - `searches` QuotaCounter, required
      - `limit` integer, required
      - `used` integer, required
      - `resets_at` integer, required: Unix time of the next reset (UTC midnight).
    - `snippets` QuotaCounter, required
      - `limit` integer, required
      - `used` integer, required
      - `resets_at` integer, required: Unix time of the next reset (UTC midnight).
  - `limits` object, required
    - `disclosed_positions` integer, required: How far down the popularity ranking results are shown.
    - `disclosed_positions_snippets` integer, required
    - `max_per_page` integer, required: Rows one query may return: the largest per_page, and the limit of page * per_page.
    - `max_per_page_snippets` integer, required
  - `clusters` object: Clusters on the account and the extraction allowance.
    - `count` integer
    - `max` integer
    - `max_size` integer
    - `extract_points_per_day` integer
    - `extract_points_left` integer
    - `resets_at` string, date-time

## Other responses

- `400`: The request cannot be served as asked: missing_query, unknown_format, unknown_column, format_not_available, per_page_too_large, page_too_deep, invalid_json.
- `401`: missing_key - no Authorization: Bearer header; invalid_key - the token does not name an account.

---

[API](https://skmtc.dev/publicwww/apis/publicwww-search-api.md) · [All operations](https://skmtc.dev/publicwww/apis/publicwww-search-api/llms.txt) · [OpenAPI document](https://skmtc.dev/publicwww/apis/publicwww-search-api/revisions/79d49d819de3?raw)