Skip to main content
GET
/
v1
/
rate-limits
Get Rate Limits
curl --request GET \
  --url https://api.volteras.com/v1/rate-limits \
  --header 'Authorization: Bearer <token>'
[
  {
    "remainingRequests": 123,
    "maxRequests": 123,
    "domain": "<string>",
    "windowSizeSeconds": 123,
    "objectId": "<string>",
    "key": "BMW_ENERGY_API_COMMANDS"
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
objectId
string
required

The ID of the object to get the rate limits for

​
domain
string
required

The domain of the object to get the rate limits for

Allowed value: "VEHICLE"

Response

200 - application/json

Successful Response

​
remainingRequests
integer
required

The count of remaining requests before the rate limit is breached

​
maxRequests
integer
required

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

​
domain
string
required

The domain of the object on which the rate limit is applied (for example, if the rate limit is applied to a specific vehicle, the domain is VEHICLE)

Allowed value: "VEHICLE"
​
windowSizeSeconds
integer
required

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

​
objectId
string
required

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

​
key
enum<string>
required

The key of the rate limit, which can be used to uniquely identify the kind of rate limit applied

Available options:
BMW_ENERGY_API_COMMANDS,
BMW_ENERGY_API_STOP_COMMANDS,
BMW_ENERGY_API_COMMANDS_AND_FETCH_STATE