Factory Fitted Options

Get the options fitted to a given vehicle by VIN.

Overview

The Factory Fitted Options (FFO) API provides a record of the optional features (as opposed to standard features) that a vehicle had when it left the factory. It achieves this by:

• Obtaining a vehicle ID using VRM Search

• Requesting a Build Sheet from OEM partners to determine the original factory specifications.

• Using advanced machine learning models to distinguish between standard and optional features.

• Scoring and structuring the data into an API response for downstream use.

The final output is a list of fitted options, including a confidence score and other relevant details.

Get fitted options for a vehicle

post

Get fitted options for a vehicle

Authorizations

ApiKeyAuth

ApiKeystringRequired

Body

application/json

regionstring · enumOptionalPossible values:

vehicle_idstringRequired

The Vehicle ID to get fitted options for, using the specified catalogue

Example: 829630320230801

cataloguestringRequired

The vehicle catalogue that you are using (autograb or jato)

Example: jato

vinstringRequired

Plate number of the registered vehicle

Example: WVWZZZCD3RW836864

Responses

200

Success

application/json

successbooleanOptionalDefault: true

debug_logstring[]Optional

shows the incremental process of adding each fitted option to the finalised scenario

400

Bad Request

application/json

401

Unauthorized

application/json

post

/v2/vehicles/fitted_options

HTTPcURLJavaScriptPython

POST /v2/vehicles/fitted_options HTTP/1.1
Host: api.autograb.com.au
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "region": "au",
  "vehicle_id": "829630320230801",
  "catalogue": "jato",
  "vin": "WVWZZZCD3RW836864",
  "features": [
    "build_sheet"
  ]
}

{
  "success": true,
  "fitted_options": [
    {
      "build_sheet_lines": [
        "text"
      ],
      "option_id": "text",
      "option_code": "text",
      "option_title": "text",
      "option_details": [
        "text"
      ],
      "match_score": 1,
      "match_category": "text",
      "msrp": 1
    }
  ],
  "debug_log": [
    "text"
  ],
  "build_sheet": [
    {
      "code": "text",
      "description": "text"
    }
  ],
  "grouped_options": {
    "common_matches": [
      [
        {
          "id": "text",
          "type": "text",
          "title": "text",
          "details": [
            "text"
          ],
          "msrp": 1,
          "matches": [
            {
              "input_line": "text",
              "score": 1,
              "detail_idx": 1
            }
          ]
        }
      ]
    ],
    "mutually_exclusive_matches": [
      {
        "common_matches": [
          {
            "input_line": "text",
            "score": 1,
            "detail_idx": 1
          }
        ],
        "options": [
          {
            "id": "text",
            "type": "text",
            "title": "text",
            "details": [
              "text"
            ],
            "msrp": 1,
            "matches": [
              {
                "input_line": "text",
                "score": 1,
                "detail_idx": 1
              }
            ]
          }
        ]
      }
    ]
  }
}

Response Data Definitions

The response provides a fitted option report and can be interpreted using the following table.

build_sheet_lines	"LEVER FINISHing - METAL PAINT", "FUEL FILLER Door FINISHing - BODY COLOR	These are the lines in the build sheet, received from the OEM, that the FFO system has determined to be correlated to an optional extra.
option_id	1037	This is the option_ID as available in the JATO dataset.
option_code	JATOMET	This is the option_code as available in the JATO dataset.
option_title	Metallic paint	This is the option_title as available in the JATO dataset.
option_details	Metallic paint, two-tone metallic paint	This gives a detailed description of the option specified in the option_title
match_score	0.7	This is the confidence score of the match. The match_score categories are given below. Refer to the “Understanding The Option Match Score” section below for more information.
match_category	Matched	The various values for match_category are explained below.
msrp	600	This is the MSRP (the price of the option) as available in the JATO dataset. Expressed in local currency.

Match Category Data Definitions

Matched	The option was included on the build sheet. The confidence is based on the similarity of the build sheet description(s) to the JATO option title and details.
Included directly by <option>	Because <option> is fitted, this option is included free of charge. This option may or may not have also been matched from the build sheet. If this option was also matched from the build sheet, the confidence may be increased.
Required directly by <option>	Because <option> is fitted, this option must be included at an additional cost. This option may or may not have also been matched from the build sheet - if so the confidence may be increased.
Price changed directly by <option>	Because <option> is fitted, this option is charged at an adjusted price. The MSRP will be updated to reflect this. This option may or may not also be matched on the build sheet, and if so the confidence may be increased.
Included recursively by <option>	This option is included free of charge due to a chain of dependencies that involves <option>. This option was not matched directly, and the confidence will be lowered to indicate this.
Required recursively by <option>	Because of an existing chain of option dependencies, this option must be included. However, this option was not matched directly, so the confidence will be lowered.
Prerequisites Met	All of the included options in this option pack were already matched, so this pack has been added as well, because it causes the overall price to be lower than if the options were individually included.

Option Match Score Definitions

The “Technical Description” is for integration partners who need to understand what's at play behind the scenes. The “Public Facing Description” is a simplification of the technical description that boils it down to a basic likelihood scale.

The match score runs from 0.6 to 1 with no other responses supported outside this range.

Fitted Options Response Time

Due to the multiple external and internal API calls and the nature of LLM model responses below covers expected average response times for the fitted options API based on AutoGrabs internal benchmarking.

• certain OEM build sheet providers have widely varying response times

• some DVLA responses are slower

• Couples with the compute time for the model to generate the fitted options, this can extend the processing time before a successful response is returned by the API.

Excluding VRM Lookup below is our average benchmark across our internal test set of 100 VINs:

Average	2.75
Min	1.00
Max	19.8

Our DVLA VRM connection benchmarks at the following speeds across our test set:

Average	0.44
Min	0.21
Max	0.76

Example Response

{
  "success": true,
  "fitted_options": [
    {
      "build_sheet_lines": [
        "4 alloy wheels \"Ventura\" 7.5J x 17",
        "Tires 225/45 R17 91W",
        "\"Ventura\" 7.5J x 17, tires 225/45 R17"
      ],
      "option_id": "1245",
      "option_code": "PJ3",
      "option_title": "Alloy wheels 17\" 'Ventura'",
      "option_details": [
        "Front and rear wheels: 17 inch two-tone alloy rims ; width: 7.5 inches",
        "Front and rear tyres: 17 inch diameter, 225mm wide, 45% profile (official data)"
      ],
      "match_score": 0.9,
      "match_category": "Matched",
      "msrp": 675
    },
    {
      "build_sheet_lines": [
        "\"drive select\""
      ],
      "option_id": "1248",
      "option_code": "PDD",
      "option_title": "Dynamic Chassis Control (DCC)",
      "option_details": [
        "Driver selectable electronic responsive suspension",
        "Selectable driving modes that affect suspension"
      ],
      "match_score": 0.7,
      "match_category": "Matched",
      "msrp": 1045
    },
    {
      "build_sheet_lines": [
        "Side windows in heat-insulating glass, from B-pillar and rear window dark tinted"
      ],
      "option_id": "1249",
      "option_code": "4KF",
      "option_title": "Rear tinted glass",
      "option_details": [
        "Privacy glass on the rear window and on the rear side windows"
      ],
      "match_score": 0.7,
      "match_category": "Matched",
      "msrp": 275
    },
    {
      "build_sheet_lines": [
        "Automatic headlight control with LED separate daytime running light and entry and exit lighting"
      ],
      "option_id": "1271",
      "option_code": "PXD",
      "option_title": "IQ.Light - LED Matrix headlights inc dynamic cornering",
      "option_details": [
        "LED low beam LED high beam headlights",
        "LED dipped headlights, rear lights and main beam headlights",
        "Headlight control systems: steering sensor, speed sensor, active high beam, automatic height adjustment, internal height adjustment and matrix"
      ],
      "match_score": 0.7,
      "match_category": "Matched",
      "msrp": 1940
    },
    {
      "build_sheet_lines": [
        "voice control"
      ],
      "option_id": "1256",
      "option_code": "QH1",
      "option_title": "Voice Control",
      "option_details": [
        "Voice activating system includes audio player, phone, sat nav and air-con"
      ],
      "match_score": 0.7,
      "match_category": "Matched",
      "msrp": 225
    },
    {
      "build_sheet_lines": [
        "multifunction camera"
      ],
      "option_id": "1265",
      "option_code": "KA2",
      "option_title": "Rear view camera",
      "option_details": [
        "Rear sensor & camera-type parking distance system",
        "Rear/reverse parking guidance display"
      ],
      "match_score": 0.7,
      "match_category": "Matched",
      "msrp": 330
    }
  ]
}

Supported Manufactures

When integrating this service it is important for it to be aware of our expanding list of supported manufactures. In order to check if a vehicle you should reference the endpoint below for a live list.

curl --location 'https://api.autograb.co.uk/v2/vehicles/fitted_options/supported_oems?region=uk' \
--header 'accept: application/json' \
--header 'ApiKey: ***'

{
    "success": true,
    "supported_oems": [
        "Abarth",
        "Alfa Romeo",
        "Alpina",
        "Audi"
        "BMW",
        "Buick",
        "Cadillac",
        /// trimmed for doc
 }