LogoLogo
API StatusSupportPostmanContact Us
🇳🇿 NZ AutoGrab API Doc
🇳🇿 NZ AutoGrab API Doc
  • AutoGrab Basics
    • AutoGrab Developer Hub
    • Integration Overview
    • Open API Reference
    • API & System Status
    • API Test Cases
  • Authentication
    • Basic Key Based Authentication
    • OAuth Authentication
  • Vehicle Search
    • Vehicle Searching Basics
    • Plain-text Search
    • Registration Plate Search
    • VIN Search
    • Facet Search
      • Facet Integration Worked Example
    • Marketplace ID Lookup
    • Vehicle ID Search
    • Matching Confidence
  • Sourcing
    • Sourcing Basics
    • Market Overlay
      • Features
    • Market Statistics
  • Vehicle Data
    • Vehicle Data Basics
    • Vehicle History
    • Factory Build Data
  • Valuation
    • Valuation Basics
    • Valuation Predictions
      • Adjustments
      • Condition Array
      • Valuation Features
    • Residual Valuations
    • Registration & VIN Valuations
    • Valuation Features
    • Max Offer Configuration
    • AutoGauge
  • Embeddable Products
    • Embeddable Basics
    • AutoGauge
    • Valuation Widget
    • Market Insights Snapshot
  • Other Products & Resources
    • Pre-Accident Valuation API Suite
    • URL Linking Structure
    • Webhooks Integration
    • Customer Recapture
    • Brand Guidelines
    • API Reference Parameter
    • Stock Feeds
    • FAQ
Powered by GitBook
LogoLogo

Links

  • Terms of Use

2024 © AutoGrab Pty Ltd. ABN 79 638 468 569

On this page
  • Registration Valuation
  • VIN Valuation
  • Implementation Constrains

Was this helpful?

Export as PDF
  1. Valuation

Registration & VIN Valuations

Generate a valuation with a Registration Plate or VIN

Registration Valuation

POST the registration plate and region to /v2/valuations/registrations/BMT038?

{
    "region": "nz",
}

Example Response

{
    "success": true,
    "prediction": {
        "id": "bc3df5a9-0488-4486-acb9-ca22482f127c",
        "vehicle_id": "5804870883868672",
        "kms": 57306,
        "price": 20622,
        "score": 0.9239,
        "retail_price": 20622,
        "trade_price": 17122,
        "adjustment": null
    }
}

VIN Valuation

POST the encapsulated VIN to /v2/valuations/vins/7AT08G0RX19303899

{
    "region": "nz",
    "kms": 216000
}

Example Response

{
    "success": true,
    "prediction": {
        "id": "efa792e6-8071-4289-a5b6-c098ac041702",
        "vehicle_id": "4871414033154048",
        "kms": 216000,
        "price": 9546,
        "score": 0.5407,
        "retail_price": 9546,
        "trade_price": 6205,
        "adjustment": null
    }
}

Implementation Constrains

This integration approach relies on the successful lookup of the vehicle. We recommend staggering your integration so you isolate the vehicle ID first using vehicle search methods and then proceed to valuation driven by the vehicle ID.

PreviousResidual ValuationsNextValuation Features

Last updated 12 months ago

Was this helpful?

This is done to avoid issues where the VIN lookup component of the valuation fails blocking your workflow. In the recommended scenario if your VIN or Rego lookup fails, you can fall back to or informed by the "upstream_vehicle" parameter.

Facet
Text Search