LogoLogo
API StatusSupportPostmanContact Us
🇬🇧 UK AutoGrab API Doc
🇬🇧 UK AutoGrab API Doc
  • AutoGrab Basics
    • AutoGrab Developer Hub
    • Integration Overview
    • API Test Cases
    • FAQ
  • Authentication
    • API Key
    • OAuth Authentication
  • Vehicle Search
    • Vehicle Searching Basics
    • Plain-text Search
    • VRM Search
    • VIN Search
    • Facet Search
    • Vehicle ID Search
    • Marketplace ID Lookup
  • Sourcing
    • Sourcing Basics
    • Market Overlay
    • Market Statistics
    • Stock Feeds
  • Vehicle Data
    • Vehicle Data Basics
    • Recall Search
    • MOT & Tax Search
    • Vehicle History
    • Factory Build Data
    • Factory Fitted Options
  • Valuation
    • Valuation Basics
    • Valuation Predictions
    • Residual Valuations
    • Max Offer Configuration
    • Gauge API
  • Embeddable Products
    • Embeddable Basics
    • Gauge Widget
    • Valuation Widget
    • Market Overlay Widget
  • Customer Recapture
    • Customer Recapture
    • Webhooks Integration
  • Insurance
    • Pre-Accident Valuation
Powered by GitBook
LogoLogo

Links

  • Terms of Use

2024 © AutoGrab Pty Ltd. ABN 79 638 468 569

On this page

Was this helpful?

Export as PDF
  1. Valuation

Gauge API

Create your own price indication and benchmarking gauge.

PreviousMax Offer ConfigurationNextEmbeddable Basics

Last updated 3 months ago

Was this helpful?

The AutoGrab AutoGauge is an endpoint that delivers market benchmarking information with inputs of listing information. It supports a range of inputs depending on your use case.

Example Post Body

The body of the request can accept a range of inputs depending on your listing data. All available inputs are below.

{
  "region": "au",
  "odometer": 10000,
  "listing_price": 30000,
  "vehicle_id": "5257788510961664",
  "vin": "2T1BY32E95C347786",
  "rego": "BMT038",
  "state": "VIC",
  "vehicle_description": "2015 Toyota Corolla Ascent Automatic",
  "marketplace": "autotrader.com.au",
  "marketplace_id": "13495712"
}

The response for this request is below. The AutoGauge can be presented with a broad range of vehicle identifiers and will consider them dependent on your commercial agreement. In the scenario above, the AutoGrab ID was presented and used, and all other inputs were supplied as backups.

{
  "success": true,
  "gauge": {
    "id": "b2824bfd-d4a4-45e4-a81a-bed7b92c5cd9",
    "fill": 0.5,
    "listing_price": 24000,
    "market_range_min": 21000,
    "market_range_max": 26000,
    "confidence": 0.85,
    "sample_size": 10,
    "vehicle_title": "2015 Toyota Corolla Ascent Automatic"
  }
}

Use Case Driven Implementation Examples

Marketplace Implementation

If you are a marketplace you will store your own marketplace IDs against each listing. You can submit those via the request body to produce an AutoGauge response.

{
  "region": "au",
  "odometer": 10000,
  "listing_price": 30000,
  "marketplace": "example.com.au",
  "marketplace_id": "53445712"
}

Dealer Website Implementation (AutoGrab Customer)

As a customer with an existing AutoGrab API integration, you will likely have stored the AutoGrab IDs from vehicle search steps you've previously taken. In this case supply your known vehicle_id as part of the request. This is the lowest-cost implementation as it does not require a VIN or Registration search.

{
  "region": "au",
  "odometer": 10000,
  "listing_price": 30000,
  "vehicle_id": "5257788510961664",
  "vehicle_description": "2015 Toyota Corolla Ascent Automatic",
}

Dealer Website Implementation (Non-Direct Customer)

As an app or new customer, you may only have the VIN and registration information for your vehicles. You can pass them into the request body as below.

{
  "region": "au",
  "odometer": 10000,
  "listing_price": 30000,
  "vin": "2T1BY32E95C347786",
  "rego": "BMT038",
  "state": "VIC",
  "vehicle_description": "2015 Toyota Corolla Ascent Automatic",
}

Registration or VIN-driven AutoGauge requests attract an additional lookup fee. Speak to your account representative for commercial implications.

  • POSTProduce the inputs to make a gauge UI based on vehicle or listing-driven inputs
  • Example Post Body
  • Use Case Driven Implementation Examples

Produce the inputs to make a gauge UI based on vehicle or listing-driven inputs

post

Produce the inputs to make a gauge UI based on vehicle or listing-driven inputs

Authorizations
Query parameters
regionstring · enumOptional

The region to perform this request in

Possible values:
reference_idstringOptional

An optional reference id which will be stored against usage records if supplied

Body
regionstring · enumRequiredPossible values:
odometerintegerRequired
listing_priceintegerRequired
vehicle_idstringOptional
vinstringOptional
regostringOptional
statestringOptional
vehicle_descriptionstringOptional
marketplacestringOptional
marketplace_idstringOptional
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
post
POST /v2/valuations/gauge/ HTTP/1.1
Host: api.autograb.com.au
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "region": "au",
  "odometer": 1,
  "listing_price": 1,
  "vehicle_id": "text",
  "vin": "text",
  "rego": "text",
  "state": "text",
  "vehicle_description": "text",
  "marketplace": "text",
  "marketplace_id": "text"
}
{
  "success": true,
  "gauge": {
    "id": "text",
    "fill": 1,
    "listing_price": 1,
    "market_range_min": 1,
    "market_range_max": 1,
    "confidence": 1,
    "sample_size": 1,
    "vehicle_title": "text"
  }
}