Sign in

v1

latestOpenAPI 3.1.02026-08-0450121252.8 KB
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):

  • AUTHENTICATION_ERROR
  • REQUEST_VALIDATION_ERROR
  • RESOURCE_NOT_FOUND
  • SERVER_ERROR
get/v1/rate-limits

Query parameters

objectIdstring required

The ID of the object to get the rate limits for

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

Response

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