Integration Overview

Key things to know before you start.

Overview

Our API uses the OpenAPI 2.0 specification, making it easy for our partners to integrate. We want to ensure the best possible experience when integrating with our stack.

Environments

Environment	URL
Production V2	https://api.autograb.com.au/v2/

Regions

Certain API endpoints require that a region be passed as part of the request URL. Where necessary it is expected that region=nz be included where region is required.

For example: https://api.autograb.com.au/v2/vehicle/239c8928fnc934fc?region=nz

Region

Country	Region Code
New Zealand	nz

API Keys

Your account manager will provision API keys for your account. If you require a key to be revoked please get in touch with your account manager.

Quota Limits

APIs have soft quota limits that are enforced based on your contract agreement. To discuss these limits please get in touch with your account manager.

Rate Limiting

We strictly monitor the number of requests per second — if you exceed your allocation the API will respond with HTTP 429 Too Many Requests. We will also return additional headers to help you better understand when rate limits will be applied.

The limits are applied per API product and are decided based on your contract agreement. Rate limits do not relate to quotas.

Header	Example	Description
Rate-Limit-Remaining	60	Number of remaining requests until the limit is reset.
Rate-Limit-Total	60	Number of total requests that can be made until the limit is reset.
Rate-Limit-Reset	1609459200	The timestamp of when the limit will reset.
Monthly-Base-Request-Quota	100	Number of requests included in your contract.
Monthly-Max-Request-Quota	100000	Maximum number of requests allowed in your contract.
Monthly-Request-Total	100	Monthly requests performed for this request type.