API URL: https://api.autosyncstudio.com/

API keys may be generated in the portal: https://portal.autosyncstudio.com/

1. Legend

URL query parameter prefixes:

• f- - (filter) denotes a parameter that narrows down the result set or specifies preferred records, e.g. f-year

• i- - (include) denotes a parameter that adds optional data to the result, e.g. i-colors

• p- - (page) denotes a parameter that pertains to pagination, e.g. p-number

• s- - (sort) denotes a parameter that orders a collection by a specified field, e.g. s-price

2. Authorization

All vehicle and wheel endpoints require a valid key to pass authorization. Each key determines access to resources.

Append key parameter to a URL to specify a key:

If key parameter is not specified or a provided key is invalid, the API will return the following response for endpoints requiring authorization:

GET /keys/validate

To test if an API key is valid, you can query the following endpoint:

A successfully validated key passed to the endpoint will result in the following response:

3. Segments

The endpoints are divided into the following segments:

• Accessories

• Tires

• Vehicles

• Wheels

Each set of endpoints is guarded by a permission. An attempt to access an endpoint without appropriate permission assigned to an API key will result in the following error:

If you see the error and believe this is a mistake, please contact AutoSync.

4. API Key Configuration

GET /keys/config

Configuration set for an API key. This includes theming and filtering.

Sample response for a valid key:

• BrandIds - IDs of allowed brands

• Locations - a list of locations assigned to a retailer or manufacturer; empty if none specified

  • Coordinates - latitude and longitude of the address; null if not available

• MakeIds - if vehicle makes are filtered, this array will list IDs of allowed makes; otherwise it will be empty

• Segments - see “3. Segments” for more information

• VehicleTypes - if vehicle types are filtered, this array will list allowed types; otherwise it will be empty

• Visualizer - configuration for visualizers

  • AlignHomeContentToTop - home page content should be placed right at the top of the content container

  • BgImg - home page background image URL

  • BgImgOpacity - home page background image opacity

  • BrandColor - theme accent color

  • BrandLogo - URL of the brand logo shown on the home page

  • Ga4Key - Google Analytics key for tracking events

  • ListVehicleModelsByYear - Separate vehicle models by year

  • PaginationSize - default pagination size

  • ScrollIntoView - scroll container into the viewport on user input when the embedded on a page with more content

  • TireLogo - “Shop by Tire” image URL

  • VehicleLogo - “Shop by Vehicle” image URL

  • VehicleThumbnails - either color or mono

  • WheelLogo - “Shop by Wheel” image URL

POST /keys/config

Update API key configuration. Propagating changes may take up to 5 minutes.

Data must be submitted in the body and be JSON-encoded:

where (* - required):

• * vehicleModels - vehicle models filter

  • * use - include or exclude to either

  • * modelIds - an array of vehicle model IDs; empty array disables the filter

Example 1. JavaScript code for sending a sample request for quote:

Response:

5. Errors

In case of an error, HTTP status will be different than 200 and an error message will be included.

Example 1. Invalid path:

Response (HTTP status 404):

Example 2. Invalid parameter value:

Response (HTTP status 400):

Example 3. Implementation error that needs to be addressed by AutoSync (response HTTP status 500):

HTTP status 200 and no error property signify a successful response.

6. Pagination

Every endpoint returning a single collection includes pagination information:

• MoreItems - true or false denoting the end of a collection or additional records on the next page

By default, collections are limited to 10 records per page.

Example 1. The first page of 10 Ford models (out of 51 in total):

Response:

All endpoints may include query parameters for specifying pagination settings:

• p-number - page number beginning at 1

• p-size - page size, i.e the number of collection items to be fetched (1-500)

Example 2. The last of three 25-item pages of Ford’s models:

Response:

Endpoints containing objects with multiple collections, e.g. /wheels/filters, do not include pagination information.

Example 3. No page indicators for collections under filters (models and diameters):

Response:

7. Rate Limiting

The maximum permitted request rate is 20 requests per second per API key. If the rate limit is exceeded, a 429 Too Many Requests response will be returned.

8. Vehicle Endpoints

GET /vehicles/years

A list of all supported vehicle years.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/vehicles/years

Results are sorted by year in ascending order.

Example 1. All supported years (page size increased to 100 to include all results):

Response:

Example 2. Years for Audi A4 Sport:

Response:

GET /vehicles/makes

A list of vehicle makes.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/vehicles/makes

Results are sorted by make in ascending order.

Example 1. A list of all makes:

Response:

Example 2. A list of Truck or Van makes:

Response:

Example 3. A list of makes that manufactured vehicles in 2012 with their logos and the total number of vehicles released that year:

Response:

Appending Logo to LogoUrlBase composes a complete logo image URL, for example:

GET /vehicles/models

A list of vehicle models.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/vehicles/models

Results are sorted by make and model in ascending order.

Example 1. A list of models by year and make:

Response:

Example 2. Mustang models:

Response:

Example 3. 2018 Mazda models with body types:

Response:

Example 4. 2009 Hummer H2 models with vehicle types:

Response:

Example 4. Ford Freestyle model split by year:

Response:

Example 5. Filter by year (2016), make (“BMW”) and include images in the default color for each model together with the years of the vehicles in the images:

Response:

Appending image path to ImgUrlBase composes a complete image URL, for example:

Open

GET /vehicles/submodels

A list of vehicle sub models.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/vehicles/submodels

Results are sorted by make, model and sub model in ascending order.

Example 1. A list of 2012 Audi A4 sub models:

Response:

Example 2. A list of 2010 Honda Civic sub models:

Response:

Example 3. Full-text search results for “2020 jag I-Pace“:

Response:

Example 4. A list of Ford F-150 sub models manufactured in 2020 with 032 angle images 960 px wide in the default color:

Response:

Appending image path to ImgUrlBase composes a complete image URL, for example:

Open

GET /vehicles

A list of vehicles.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/vehicles

Results are sorted by year in descending order.

A. Filtering Vehicles

Example 1. Vehicles filtered by year, make, model, and sub model:

Response:

Example 2. Vehicles filtered by year, make, model, sub model, and body type:

Response:

B. Fetching Vehicle by ID

Example. Vehicle with ID equal to 3635:

Response:

C. Image URLs

Supported sizes (width in pixels):

• 2400 – 2400 px × 1250 px

• 960 - 960 px × 522 px

• 640 - 640 px × 348 px

• 350 - 350 px × 190 px

• 240 - 240 px × 130 px

Example. Including images of angles 001 and 014:

Response:

Appending image path to ImgUrlBase composes a full resource URL, for example:

https://storage.googleapis.com/autosync-vehicles/13780/13780_2400_001_E7.webp

If an image in a given size is not available, null value will be returned.

ImgColorId indicates which color was selected for the images.

D. Selecting a Preferred Color

Image URL query parameters may be combined with f-colorId in order to specify a desired color.

Example. Vehicle ID 5851 in color ID 130664 (“Velocity Blue”):

Response:

If f-colorId is not specified, the default color of a vehicle will be selected.

E. Available colors

To include a list of available colors for each vehicle, append i-colors parameter with no value.

Example. A vehicle with a list of its colors:

Response:

Appending Swatch to SwatchUrlBase composes a complete color swatch URL, e.g.:

Each object under Colors includes Img001, Img014, and Img032 properties. They signify whether a vehicle image is available for a given angle and in the color.

F. Fitment Data

Appending i-fitments and i-optionalFitments to the URL includes OE and OE optional fitments. i-fitments also adds the following fields:

• BoltCircle

• Bore

• BoreRear - null if the same as Bore

• DefaultChassisId - if multiple chassis are mapped to the vehicle, this value will represent the closest match

• LoadRating - minimum tire load rating

• LoadRatingRear - null if the same as LoadRating

• LugCount

• MaxWheelLoad - maximum weight the vehicle would exert on each wheel while in operation

• Staggered - the vehicle is commonly fitted with staggered wheels and tires

i-tags includes tags, and niche tags.

Niche tags identify wheels (and their corresponding vehicles) that are made for specific vehicles only. They are used primarily for replica wheels made for specific vehicles.

Each OE fitment is compatible with the vehicle without a need for vehicle modifications (e.g. lift kits).

In addition to OE fitments, plus sizes may be requested with i-plusSizes parameter. Plus sizes will only be returned if fitments are requested. Plus sizes are intended for the tuning market. They can be used to show the aftermarket wheel fitment sizes, and tire sizes for that wheel size. Plus size notes provide information on special requirements.

Note. Plus sizes must be matched with fitments by ChassisId.

Each fitment is identified by Id, has ChassisId, and is often described by Name to differentiate it from other options. Typically, a vehicle would have a few fitments sharing the same chassis and multiple plus size for each chassis. Some vehicles may have fitments coming from chassis. This is because sub model alone doesn’t uniquely identify vehicle chassis. For example, vehicle ID 83184 has two chassis:

• "ChassisId": 70429, "Name": "19\"" - 2 fitments, 14 plus sizes

• "ChassisId": 92428, "Name": "Ceramic Brake Package" - 1 fitment, 9 plus sizes

Depending on which OE fitment is selected by the end user, either the 14 or the 9 plus sizes may be offered with additional wheel/tire sizes.

Example. A vehicle with OE fitments and plus sizes:

Response:

Format identifies tire format:

• M - metric, e.g. “245/70R17”; SectionWidth, AspectRatio, and RimDiameter will be specified

• F - flotation, e.g. “37x12.50R17”; Diameter, RimWidth, and RimDiameter will be specified.

Notes will take a form of an empty array if there are no special requirements for the fitment. Otherwise, a list of strings will be returned, for example:

Staggered indicates whether a vehicle is commonly fitted with staggered wheels (is a staggered fitment candidate). For example 2022 Chevrolet Camaro LS does not come with factory staggered wheels, but is often upgraded to staggered fitment.

G. Wheel coordinates

To include wheel coordinates append i-coordinates=<agnles> to the URL where <angles> is a comma-separated list of one or more of the following values:

• 001 - side angle

• 014 - rear angle

• 032 - front angle

Example. A vehicle with coordinates for angles 014 and 032:

Response:

Wheel coordinates include two sets of four values in the following order:

1. x1 - top left corner’s x value

2. y1 - top left corner’s y value

3. x2 - bottom right corner’s x value

4. y2 - bottom right corner’s y value

Each value is expressed in percents, counting vehicle image’s top-left corner as the starting point.

Overlayed front and rear wheel images match original rims best when slightly rotated. Each set of coordinates (for each vehicle angle) will have a corresponding set of rotation values (in degrees):

In the example above, the left wheel should be rotated by -10 deg (counterclockwise) and the right wheel should be rotated by 10 deg (clockwise) for vehicle angle 001.

Wheel angles specify preferred wheel angles for each vehicle angle and each wheel. For example:

indicates that the vehicle, when shown in angle 032, should have wheel angle 0100 layered on top of the first (counting from left to right) wheel and angle 0200 over the second wheel (on the right).

Exceptions:

1. Dually trucks, being an exception, and will return 0300Front and 0300Rear wheel angles for 001 vehicle angle (instead of 0300 for non-dually vehicles):

2. Some vehicles my have externally-mounted full size spare wheels. In their case, an additional set of coordinates and associated data will be returned for angle 014 at the end of each array (3rd place):

InImageWheelDiameters is a list of wheel diameters corresponding with vehicle images:

• Front - front wheel diameter as visible in the vehicle image

• FrontMax - maximum front wheel diameter visually fitting the vehicle image

• Rear - rear wheel diameter as visible in the vehicle image

• RearMax - maximum rear wheel diameter visually fitting the vehicle image

Wheel coordinates are set for Front and FrontMax diameters and need to be proportionally scaled up for diameters between Front and FrontMax, and between Rear and RearMax.

If information for InImageWheelDiameters is not available, a null value will be returned:

H. Sample Positioning Implementation

Having the following values returned from /vehicles endpoint:

and the following data returned from /wheels endpoint:

we can overlay the wheels on top of the vehicles with the following HTML and CSS code:

Live CodePen example:

GET /vehicles/vehicle/[vehicleId]/accessories

A list of accessories for a requested vehicle.

Required URI parameters:

• * vehicleId - vehicle ID

Optional query parameters:

• Data

  • i-imgVov - include accessory VoV images for selected angles together with coordinates and rotation angles; a comma-separated list of one or more of the following values:001, 014, 032

  • i-vehicleImg - include vehicle images for selected angles; a comma-separated list of one or more of the following values:001, 014, 032

  • i-commonMinScale - some accessories may require different vehicle scales to fit them on top of vehicle images; the scales may differ not only between vehicles but also vehicle angles (for example a hitch bike rack may require a smaller scale for angle 001); this parameter includes at least one scale that is the same for all vehicle angles (001, 014, 032) for a given vehicle and accessory; it takes effect only if i-imgVov is specified

• Filters

  • f-vehicleColorId - specify vehicle color by ID; takes precedence over f-vehicleColor

  • f-vehicleColor - specify vehicle image color: rand – random color (default), mono – prefer monochromatic color; f-vehicleColorId parameter takes precedence if both are specified

Example 1. List accessories with their coordinates and images for all angles for vehicle ID 38050 (2021 Ford F-150 XL Extended Cab):

Response:

Base Accessories

Accessories can depend on other accessories to be properly visualized. For example a cargo box may require a roof rack. BaseAccessoryIds provide a list of IDs of alternative accessories required by the main accessory. Any one from the list may be selected.

The image above shows an accessory (green rectangle) with its dependent accessory (orange rectangle).

Coordinates

Visualizing accessories may require scaling down vehicle images. For each angle (001, 014 or 032), there may be a set of different vehicle scales. The biggest, is the maximum scale for which the accessory stays within the canvas of the requested vehicle image. Smaller scales are provided to match other accessories that require smaller scales.

In the example above, the accessory requires scaling the vehicle image down to 90% or less. 0.8 coordinates are provided because another accessory returned in the response requires 80% scale. When two accessories are overlaid on a vehicle, the highest common scale should be used.

The values are adjusted for each scale.

Coordinates are provided in four-element arrays: x1, y1, x2, y2:

Top left corner of a vehicle image is the (0,0) point.

In some cases, vehicle scales may be different for different vehicle angles. For example Yakima - Hitch Mounted Snow Sport requires a smaller scale on angle 001.

However, if it’s desired to preserve vehicle scale between different angles, i-commonMinScale parameter may be added which will ensure at least one common scale will be included between vehicle angles.

A common scale between different accessories is always included.

Images

Two accessory images are returned for each angle:

Any of them can be null. The first image (back) is meant to be placed behind a vehicle image and the second (front) on top of it.

When positioning images, their coordinates should be applied to both images in the same way.

In addition to coordinates, accessory images may require rotation. Same as for coordinates, rotation should be applied the same way for both images (back and front). Rotation requirements are provided by Rotation001, Rotation014 or Rotation032.

9. Wheel Endpoints

GET /wheels/brands

A list of wheel brands.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/wheels/brands

Example 1. All brands:

Response:

Example 2. All brands with their logos and the number of wheels:

Response:

Appending Logo to BrandLogosUrlBase composes a complete logo image URL, for example:

GET /wheels/filters

A list of wheel filters.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/wheels/filters

Example 1. All diameters:

Response:

Example 2. Diameters filtered by “TNT” brand:

Response:

Example 3. Brands, short finishes, diameters, offsets, and price range filtered by “Vision” brand:

Response:

Example 4. Brands with logos filtered by “Classic” segment tag:

Response:

Example 5. Brands that have wheels with bolt circle 1 or bolt circle 2 equal to 114 mm:

Response:

GET /wheels/styles

A list of wheel styles.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/wheels/styles

Example 1. Styles filtered by “Black Rhino” brand with wheel count:

Response:

Example 2. A list of styles with forged aluminum wheels that includes specification data, 0001 angle images and a list of short colors:

Response:

Appending Img<angle> to ImgUrlBase composes a complete image URL, for example:

When i-imgDetails query parameter is present and at least one image URL is requested, results will include additional information describing the image:

• ImgWheelId

• ImgDiameter

• ImgOffset

• ImgAccent

• ImgColor

• ImgShortColor

• ImgFinish

• ImgShortFinish

Example 3. Styles filtered by “Drag” brand with specs:

Response:

Example 4. Off-road wheel styles for trucks and SUVs:

Response:

Example 5. Wheel styles with no niche tag assigned and those with niche tag set to “Porsche 911-991”:

Response:

Example 6. Black Rhino wheel styles with sizes, offsets and short finishes:

Response:

Example 7. ATX wheels styles with 205x130 bolt pattern:

Response:

Example 8. Fuel wheels styles that have wheels of two specified widths:

Response:

When two diameters and/or two widths are specified, values that may differ between wheels of the two sizes will be listed separately, for example Offsets will list all offsets of the first size, and Offsets2 will list all offsets of the second size.

Example 9. Fuel wheels styles that have 15” wheels of two specified widths (same as above but restricting wheel diameter):

Response:

GET /wheels

A list of wheels.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/wheels

Example 1. Wheels by style ID 416 (Fuel Contra D615):

Response:

Example 2. Wheels by style ID 416 with specification data and tags:

Response:

Example 3. A wheel with vendor part number equal “531147“ with description and feature benefit data:

Response:

Example 4. A wheel with ID equal “2945“ with 0001, 1001 and 0002 angle images:

Response:

Appending Img<angle> to ImgUrlBase composes a complete image URL, for example:

Example 5. Wheels for American muscle vehicles:

Response:

Example 6. Full-text search for BMW replica wheels:

Response:

Example 7. Specs and images of a front dually wheel:

Response:

Front dually wheels, when queried for images of angle 0300, include two paths (instead of one):

That’s to accommodate different VoV (view on vehicle) profile images:

When i-spec parameter is added to the URL, front dually wheels include LinkedDuallyWheels section:

This section lists IDs of all other related dually wheels, i.e. a matching inner dually wheel and matching outer dually wheels.

POST /wheels/favorites

Mark a wheel as added to the favorites through the visualizer app.

Data must be submitted in the body and be JSON-encoded:

where (* - required):

• * wheelId - ID of the wheel added to favorites

Example 1. JavaScript code for sending a sample request for quote:

Response:

10. Tire Endpoints

Definitions

GET /tires/brands

A list of tire brands.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/tires/brands

Example 1. All brands:

Response:

Example 2. All brands with their logos and the number of tires:

Response:

Appending Logo to BrandLogosUrlBase composes a complete logo image URL, for example:

GET /tires/filters

A list of tire filters.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/tires/filters

Example 1. All rim diameters:

Response:

Example 2. Rim diameters filtered by “Goodyear” brand:

Response:

Example 3. Aspect ratios and rim diameters of metric tire models that have 225 mm and 235 mm section widths (for vehicles that take wider rear tires):

Response:

Example 4. Inch widths and rim diameters of floatation tire models that have 31” and 33” overall diameters (for vehicles that take larger-diameter rear tires):

Response:

GET /tires/models

A list of tire models.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/tires/models

Example 1. Tire models with tire count sorted by brand first and then by model:

Response:

Example 2. Winter tire models for light-duty or medium-duty trucks:

Response:

Example 3. Tire models filtered by “Michelin” brand with their specification and images:

Response:

Appending image path (ImgThumb, ImgAngle, ImgFront, ImgSide1, ImgSide2) to ImgUrlBase composes a full resource URL, for example:

https://storage.googleapis.com/autosync-tires/c4857df1f52eae568218d7ca98fa0bae.webp

If an angle is not available, null value will be returned.

GET /tires

A list of tires.

For a complete list of query parameters please visit the API reference:

https://api.autosyncstudio.com/docs/#get-/tires

Example 1. 225/50R17 size Michelin tires sorted by tire model:

Response:

Example 2. Michelin Crossclimate 2 tires with images and specification:

Response:

Appending image path (ImgThumb, ImgAngle, ImgFront, ImgSide1, ImgSide2) to ImgUrlBase composes a full resource URL, for example:

https://storage.googleapis.com/autosync-tires/2363aea9629e696f8ca6983e61bec53e.webp

If an angle is not available, null value will be returned.

If ImgRotationDir is not null, its value represents a folder with rotation images. For example:

Append ImgRotationDir to RotationImgUrlBase to form a URL to a folder with rotation images. Each folder contains 36 WebP images. For example, to access the first image:

https://storage.googleapis.com/autosync-tire-spins/fb887ecb39f711c09fa50d8e27a27fb3/1.webp

For time-effective deployments, it is recommend to use a library for spins provided by AutoSync.

Live CodePen example:

11. Request for Quote Endpoint

POST /request-for-quote

Submit a request for quote. Email notifications will be sent to all email addresses linked to the API key and a confirmation email will be sent to the customer.

Data must be submitted in the body and be JSON-encoded:

where (* - required):

• * customer - customer information

  • * firstName - between 1 and 30 characters

  • * lastName - between 1 and 30 characters

  • * phone - between 10 and 20 characters

  • * email - maximum 50 characters

• locationId - AutoSync ID of a retailer or manufacturer location; if specified, email addresses to be notified will be taken from the location (instead of the API key settings)

• vehicleId - AutoSync ID of the selected vehicle

• * products - an array of objects

  • * type - product type; possible values: wheel, tire

  • * id - AutoSync product ID

  • qty - product quantity

• message - customer notes; maximum 500 characters

Example 1. JavaScript code for sending a sample request for quote:

Response:

Sample email sent to a customer:

Sample email sent to a retailer: