Account

API Status

GET/v2/account/status

Returns API health status. Use for connectivity checks and uptime monitoring.

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/status

API key

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

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

curl 'https://api.bavest.co/v2/account/status' \
  -H "x-api-key: $BAVEST_API_KEY"

Samples read your key from BAVEST_API_KEY and follow the form.

Example response 200

{
  "data": {
    "status": "active",
    "version": "v2"
  }
}

From the docs, not your data. Long lists are cut to 3 items.

Response 200

Successful response · application/json

dataobject
- statusstring
  One of not_active active
- versionstring
  API version identifier
  Example v2
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_status.md, every route in /llms.txt, the OpenAPI spec at /openapi.json.