# Detailed Specifications Data

You can follow the steps outlined below to receive your detailed specifications payload.

{% hint style="info" %}
Using the Detailed Specifications API and Vehicle Search endpoints with the Jato parameter requires a commercial agreement between you and Jato. The agreed catalogue data is then served via AutoGrabs APIs on this endpoint.\
\
The content of the response will depend on your specific plan with Jato. For details on accessing this API, please contact AutoGrab.
{% endhint %}

> **TLDR?**
>
> Lookup the rego while including the `catalogue=jato` param.
>
> `https://api.autograb.com.au/v2/vehicles/registrations/CCU542?region=au&state=VIC&catalogue=jato`
>
> Lookup the detailed specifications using the ID you got from your lookup
>
> `https://api.autograb.com.au/v2/vehicles/2022-831964720220610/detailed-specs?region=au`

## Search For The Vehicle

### **Supported Methods**

**Registration Search**

```
GET /v2/vehicles/registrations/CCU542?region=au&state=VIC&catalogue=jato
```

**VIN Search**

```
GET /v2/vehicles/vin/LRW3F7FA1MC176142?region=au&catalogue=jato
```

**Text Search**

```
GET /v2/vehicles?region=au&search=2023 Hyundai Santa Fe MX5.V1 &catalogue=jato
```

### **Example Workflow**

In this scenario, we will use a text search to request the ID.

You would form your CURL

{% code overflow="wrap" %}

```json
curl --location 'https://api.autograb.com.au/v2/vehicles?region=au&search=2023%20Hyundai%20Santa%20Fe%20MX5.V1%20&catalogue=jato' \
--header 'apikey: ***APIKEY'
```

{% endcode %}

And receive the following response

```json
{
    "success": true,
    "vehicles": [
        {
            "id": "2023-771102220220919",
            "legacy_id": "2023-771102220220919",
            "badge": null,
            "make": "Hyundai",
            "model": "Santa Fe",
            "series": "TM.V4",
            "title": "2023 Hyundai Santa Fe 3.5 MPi Auto TM.V4 MY2023",
            "year": "2023",
            "body_config_type": null,
            "body_type": "SUV",
            "drive_type": "Front Wheel Drive",
            "engine_type": "Piston",
            "fuel_type": "Petrol",
            "transmission_type": "Automatic",
            "wheelbase_type": null,
            "capacity_cc": 3470,
            "power_kw": 200,
            "torque_nm": 200,
            "range": null,
            "num_cylinders": 6,
            "num_doors": 5,
            "num_gears": 8,
            "num_seats": 7,
            "model_year": "MY23",
            "release_month": 9,
            "release_year": 2022,
            "rrp": 46050
        }
    ],
    "total": 1,
    "confidence": "standard"
}
```

If you would like to receive additional lower confidence matches to power your UI you can enhance your request with our `prefer_more_results` parameter.

Receiving a "total" greater then one is not an issue if you confidence also recieved is "standard". This means that there are potential variants with nuanced differences available. Select the first one as the list is ranked by confidence.

{% code overflow="wrap" %}

```json
curl --location 'https://api.autograb.com.au/v2/vehicles/registrations/CCU542?region=au&state=VIC&prefer_more_results=true&catalogue=jato' \
--header 'apikey: ****APIKEY'
```

{% endcode %}

{% hint style="info" %}
Consider leveraging this feature in your user interface with a user input request. For example, “*Is this the correct vehicle?*” then allow the user to correct it with the additional results in this array.
{% endhint %}

Consider halting the process if your "confidence" is not "standard." This means the IDs returned are more likely to be incorrect. In this scenario, you have generally not given the text-matching system a detailed description enough to make a confident match. Consider using a registration lookup to enhance the detail available from the matcher.

```
GET /v2/vehicles/registrations/CCU542?region=au&state=VIC&catalogue=jato
```

{% hint style="warning" %}
A registration lookup is a separate commercial agreement from the general detailed specification agreement. Speak to your account executive to understand your options.&#x20;
{% endhint %}

## Request Detailed Specification

Now that you have isolated the Jato Code or AutoGrab ID  you can request the Detailed specs.

### **Branding Requirements**

If you use the Detailed Specifications on a dealership website, you are required to display a "Powered by JATO" and accompanying logo, as below. You can download a high-definition version here.

{% file src="/files/EWwv0R5WZQV4GSdrpht1" %}
The approved logo to be displayed on your dealership website
{% endfile %}

### **Example Workflow**

To request detailed specs use the Jato Code or AutoGrab ID you received from the earlier vehicle discovery step.

{% code overflow="wrap" %}

```json
curl --location 'https://api.autograb.com.au/v2/vehicles/2022-831964720220610/detailed-specs?region=au' \
--header 'apikey: ****APIKEY'
```

{% endcode %}

You will receive your pre-defined detailed specification payload. An example response is below.

{% hint style="warning" %}
The response you receive will be defined by the configuration we store for you based on your specific business case. This applies to the inclusion of particular items as well as the inclusion of the "type".&#x20;
{% endhint %}

```json
{
    "success": true,
    "specs": [
        {
            "category": "Version",
            "description": "Make",
            "value": "Volkswagen",
            "location": null
        },
        {
            "category": "Version",
            "description": "Model",
            "value": "Polo",
            "location": null
        },
        {
            "category": "Version",
            "description": "Version",
            "value": "85TSI Comfortline DSG",
            "location": null
        },
        {
            "category": "Version",
            "description": "Body type",
            "value": "hatchback",
            "location": null
        },
        {
            "category": "Version",
            "description": "Seating capacity",
            "value": "5",
            "location": null
        },
        {
            "category": "Equipment",
            "description": "Air Conditioning type",
            "value": "manual",
            "location": null
        },
        {
            "category": "Equipment",
            "description": "Front and rear power windows",
            "value": "S",
            "location": "F"
        },
    ],
    "confidence": "standard"
}
```

The standard Website Specification pack includes the following categories and counts of included items.&#x20;

<details>

<summary>The standard Website Specification pack includes the following categories and counts of included items. </summary>

Version: 12 items

Equipment: 28 items

Audio & Communication: 23 items

Interior design: 30 items

Exterior design: 20 items

Primary safety: 24 items

Secondary safety: 14 items

Loadspace: 2 items

Engine & Transmission: 31 items

Hybrid System: 1 item

Environmental Impact: 6 items

Safety: 16 items

Dimensions & Weights: 22 items

Warranty & Servicing: 12 items

Lighting: 2 items

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://devhub.autograb.com/my-autograb-api-doc/vehicle-data/detailed-specifications-data.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
