Taxonomy Auto-Complete

The Taxonomy Auto-Complete API provides a way to retrieve taxonomy values for various car specifications based on user input. This API is particularly useful for applications that require auto-completion of vehicle-related fields, such as make, model, trim, and other specifications without relying on current inventory data.

It leverages MarketCheck's extensive vehicle specifications database to return relevant terms based on user input, allowing for efficient and user-friendly search experiences.

Base Path

GET https://api.marketcheck.com/v2/specs/car/auto-complete

The following example demonstrates how to use the Taxonomy Auto-Complete API to get suggestions for vehicle makes and models based on user input.

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.marketcheck.com/v2/specs/car/auto-complete',
  params: {api_key: 'YOUR_API_KEY', field: 'make', input: 'toy'},
  headers: {Accept: 'application/json'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Request

The Taxonomy Auto-Complete API provides intelligent suggestions for vehicle specifications based on user input. This API leverages MarketCheck's comprehensive vehicle specifications database to deliver relevant auto-completion capabilities independent of current inventory data.

Parameters

Available parameters for configuring auto-completion behavior and filtering suggestions:

Required Parameters

The following parameters are required for taxonomy auto-completion requests:

• field - The field to search for auto-completion (see Available Fields below)
• input - The user input to match against the specified field

Defaults

Available Fields

Auto-completion is supported for the following vehicle specification fields:

Contextual Filtering

Apply additional vehicle specification filters to refine suggestions based on current search context. Use any of the available vehicle parameters to scope suggestions to specific criteria:

• Vehicle Filters: Apply make, model, year, etc. to get contextual suggestions
• Technical Specs: Use body_type, transmission, fuel_type to refine results
• Engine Specs: Filter by engine_size, engine_block for engine-related suggestions

Sorting

Auto-complete results are automatically sorted by relevance using intelligent matching algorithms:

Matching Types:

1. Prefix matches - Terms beginning with input (highest relevance)
2. Case-insensitive matches - Flexible text matching
3. Substring matches - Terms containing input anywhere

Performance Limits:

• Maximum 50 terms returned per request for optimal performance
• Results automatically ranked by relevance score
• No manual sorting parameters available

Response

The Taxonomy Auto-Complete API returns an array of matching terms based on the input and field parameters.

Schema

interface TaxonomyAutoCompleteResponse {
  terms: string[]; // Array of matching terms based on input and field
}

Success Response

• 200 OK - Returns a JSON object containing an array of matching taxonomy terms

{
  "terms": ["Ford", "Ford F-150", "Ford Explorer"]
}

Error Response

Use Cases & Examples

Auto-Complete Vehicle Specifications

Unlike the Auto-Complete API for inventory, this API does not depend on current inventory data. It provides auto-suggested taxonomy values from MarketCheck's comprehensive specs database for complete car specifications.

This is particularly useful for applications that require auto-completion of vehicle-related fields for configuration or search purposes.

Example:

Here we're getting auto-complete suggestions for vehicle makes starting with "for":

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.marketcheck.com/v2/specs/car/auto-complete',
  params: {api_key: 'YOUR_API_KEY', field: 'make', input: 'for'},
  headers: {Accept: 'application/json'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Get All Possible Values

Using this API, you can retrieve all possible values for a specific field, such as all models, trims, body types, etc. This is useful for applications that need to provide users with a complete list of options to choose from.

Other parameters could be used to filter the results based on other known specifications, such as make or year, to narrow down the suggestions.

Example:

Here in this example, we are retrieving all possible trim values for Ford F-150 vehicles:

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.marketcheck.com/v2/specs/car/auto-complete',
  params: {
    api_key: 'YOUR_API_KEY',
    field: 'trim',
    input: '',
    make: 'ford',
    model: 'f-150'
  },
  headers: {Accept: 'application/json'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

See Also

• Auto-Complete API
• Taxonomy Facets