Account

Usage Quota

GET/v2/account/quota

Returns current monthly usage count, limit, and remaining calls for the API key.

Free in every plan, including the trial.

Authentication

Send your API key in the x-api-key header on every request to https://api.bavest.co. The samples read it from the BAVEST_API_KEY environment variable. Get an API key · Authentication guide

Parameters

This route takes no path or query parameters.

Try it

This route takes no parameters.

GET /v2/account/quota

Sent only to api.bavest.co for this request; not stored.

Sign in to sendGet an API keySends with the key above, or sign in to use your account's key. Each request counts as one API call.

Response 200

Successful response · application/json

  • dataobject
    • apiKeystring

      API Gateway key identifier

      Example ut4lshj85e

    • usageinteger

      API calls used in current billing period

      Example 4521

    • limitinteger | null

      Monthly request limit (null if unlimited)

      Example 100000

    • remaininginteger | null

      Remaining API calls (null if unlimited)

      Example 95479

    • periodstring

      Current billing period (YYYY-MM)

      Example 2026-03

  • metaResponseMeta

    Response envelope metadata. Always present on a 200: time is set by core/response.py on every successful response. Errors carry the same block, built by the same code, so a client parses one meta shape whether the call succeeded or failed.

    • timeinteger

      Server-side processing time in milliseconds

      Example 17

    • parametersobject

      Echo of the request parameters the endpoint resolved

Errors

  • 400Invalid request parameters. Returned when required query parameters are missing, have invalid types, or violate constraints (e.g., providing both symbol and isin when they are mutually exclusive).
  • 401Missing or invalid API key.
  • 404Resource not found.
  • 429Rate limit exceeded. Retry after the `Retry-After` header interval.
  • 500An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
  • 502Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
  • 504The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
  • defaultAn unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.

For AI agents: this page as Markdown at /docs/v2_account_quota.md, every route in /llms.txt, the OpenAPI spec at /openapi.json.