Account
API Status
/v2/account/statusReturns 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 (free trial) · Authentication guide.
Parameters
This route takes no path or query parameters.
Response 200
Successful response · application/json
data- object
2 fields in data
status- string
One of
not_active,active.version- string
API version identifier
Example:
v2
meta- ResponseMeta
Response metadata, including server-side processing time and resolved request parameters. Successful and error responses use the same metadata shape.
2 fields in meta
time- integer
Server-side processing time in milliseconds
Example:
17parameters- object
Echo of the request parameters the endpoint resolved
Errors
- 400 Invalid 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).
- 401 Missing or invalid API key.
- 404 Resource not found.
- 429 Rate limit exceeded. Retry after the `Retry-After` header interval.
- 500 An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
- 502 Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
- 504 The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
- default An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
403from the gateway: the API key is invalid or switched off.429with messageLimit Exceeded: the monthly quota of the key is used up. WithToo Many Requests: the key is throttled, or this route is not in the key's plan. Wait forRetry-Afterwhen it is sent.

