Rate Limit

Get Rate Limits

Get the rate limits for a specific entity. For instance, could fetch rate limits applied to a specific vehicle.

The rate limit domain specifies the context the limit is applied to, e.g. for start / stop charge commands.

Possible Codes in Error Response (see Errors for error response schema and meaning of codes):

get/v1/rate-limits

Request

Base URL
https://api.volteras.com
Auth
OAuth 2
Client credentials
Token URL/v1/oauth2/token
TypeScript
https://skmtc.dev/volteras/apis/volteras-connect/docs/v1/rate-limits/get.ts
A function with typed inputs. Its response is checked against the schema.

objectIdstring required

The ID of the object to get the rate limits for

domain'VEHICLE' required

The domain of the object to get the rate limits for

Successful Response

remainingRequestsinteger required

The count of remaining requests before the rate limit is breached

maxRequestsinteger required

The maximum count of requests on the rate limit over the window period

domain'VEHICLE' required

windowSizeSecondsinteger required

The window size in seconds over which the rate limit is calculated

objectIdstring required

The ID of the object on which the rate limit is applied

key'BMW_ENERGY_API_COMMANDS' | 'BMW_ENERGY_API_STOP_COMMANDS' | 'BMW_ENERGY_API_COMMANDS_AND_FETCH_STATE' required

No recorded changes to this operation across all 17 revisions of this API.