---
title: "Search by rim"
method: GET
path: "/v2/by_rim/search/"
tags: ["Search By Rim"]
---

# Search by rim

`GET /v2/by_rim/search/`

## Request

- Base URL: `https://api.wheel-size.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.wheel-size.com/v2/by_rim/search/`
- Auth: API key in query parameter `user_key`
- TypeScript: <https://skmtc.dev/wheel-size/apis/wheel-fitment-api/docs/v2/by_rim/search/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of car models (along with their production years) compatible with a specified rim. 

Enhance the rim description with this compatibility list, offering customers a comprehensive view 
of all the car models that can accommodate this particular rim.

### Demos in action:
   - Enrich your product card by showing matching vehicles [Info](https://api-demo.wheel-size.com/info/by_rim/)
   - Search for cars by rim parameters [Form](https://api-demo.wheel-size.com/form/by_rim/)
   - Wheel Configurator Demo [Product Page](https://api-demo.wheel-size.com/configurator/by_rim/)
    

### Required parameters:

   - *`bolt_pattern`*;
   - *`rim_diameter`* or range combination: *`rim_diameter_min`* and *`rim_diameter_max`*;
   - *`rim_width`* or range combination: *`rim_width_min`* and *`rim_width_max`*;

Note:  if all three values are set (*`rim_width`*, *`rim_width_min`*, *`rim_width_max`*), 
an error occurs. The same issue applies to (*`rim_diameter`*, *`rim_diameter_min`*, 
*`rim_diameter_max`*).

## Query parameters

- `bolt_pattern` string, required
- `rim_diameter` number, double
- `rim_diameter_min` number, double
- `rim_diameter_max` number, double
- `rim_width` number, double
- `rim_width_min` number, double
- `rim_width_max` number, double
- `rim_offset` number, double
- `rim_offset_min` number, double
- `rim_offset_max` number, double
- `cb` number, double
- `cb_min` number, double
- `cb_max` number, double
- `fd` number, double
- `region` string[]
- `mode` 'both' | 'front_only' | 'rear_only'
- `add_configurator` boolean
- `configurator` boolean
- `ordering` string
- `limit` integer
- `offset` integer

## Response `200`

- SearchByRimCarReportOutput
  - `data` SearchParamsCarsData[], required
    - `make` TireMake, required
      - `slug` string, required
      - `name` string, required
      - `name_en` string, required: Original english name. Use it along with _**`lang`**_ query parameter
    - `slug` string, required: Model slug name (e.g. `outlander`)
    - `name` string, required: Model name (e.g. `Outlander`)
    - `name_en` string, required: Original english name. Use it along with _**`lang`**_ query parameter
    - `regions` unknown[], required
      - unknown
    - `year_ranges` string, required
    - `generations` MatchedGeneration[], required
      - `slug` string, required: Generation slug
      - `name` string, required: Generation name
      - `year_ranges` string, required
    - `configurator` string, required
  - `meta` SearchParamsCarsMeta, required
    - `count` integer, required: number of make model year modifications
    - `offset` integer, required: pagination offset
    - `limit` integer, required: pagination limit

---

[API](https://skmtc.dev/wheel-size/apis/wheel-fitment-api.md) - [All operations](https://skmtc.dev/wheel-size/apis/wheel-fitment-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wheel-size/apis/wheel-fitment-api/revisions/0283a9f8acf0?raw)