API v2 Add-on

360° spin: all frames of a ring

GET/api/{brand}/{model}/{year}/{variant}/{trim}/360/{ring}

API v2 add-on — keys with v2 access. Every frame of one ring in order, each with its own signed image_url and its angle — a spin viewer needs all of them. The image options (format, width, colour, background …) apply to every frame, so a spin is always consistent.

Path parameters

Name	Type	Description
`brand` required	string	Brand name (updated catalog naming for add-on cars).
`model` required	string	Model name.
`year` required	integer	Model year (4-digit). If the exact year is missing, the nearest available generation is used (errornote `Y01`).
`variant` required	string	Body variant.
`trim` required	string	Trim level.
`ring` required	string	Ring: eye_level, low or high (see 360° spin: rings).

Query parameters

Name	Type	Description
`format`	string	Delivery format. `pngwebpjpegavifauto`
`width`	integer	Width in px.
`color`	string	Paint: catalog colour name or 6-digit hex.
`lights`	string	API v2 add-on: headlights on or off (default `off`). Not available for an image → `off` + errornote `L26`. `onoff`
`background`	string	API v2 add-on: `white` (default), `transparent`, or a 6-digit hex colour like `f4f4f4`. Studio images only (lifestyle → errornote `B32`).
`windows`	string	API v2 add-on: `see_through` = glass as in the image (default), `dark` = privacy glass you cannot see through. Not available → errornote `W28`. `see_throughdark`
`plate`	string	API v2 add-on: licence plate — `none` = as in the image (default), `blank` = empty plate, `logo` = your logo on the plate (set up on your key; missing → blank + errornote `N30`). `noneblanklogo`
`fit`	string	API v2 add-on: how the car fills a `ratio` / `size` box — `contain` pads (default), `cover` crops. Lifestyle images always cover. `containcover`
`size`	string	API v2 add-on: longest side — `2k` 2560 px, `1080p` 1920 px, `720p` 1280 px, `540p` 960 px, `360p` 640 px, `thumb` 320 px. `width` / `height` win over `size`. `2k1080p720p540p360pthumb`

Request

curl "https://api.vehicleimagery.com/api/bmw/m4/2024/coupe/base/360/ring?format=png&width=800" \
  -H "x-api-key: YOUR_API_KEY"

200 · All frames of the ring.

[
  {
    "id": 900000003,
    "brand": "Audi",
    "model": "Q9",
    "year": 2026,
    "variant": "SUV",
    "trim": "Default",
    "group": "360",
    "ring": "eye_level",
    "frames": 32,
    "start": "front",
    "direction": "left",
    "resolution": "default",
    "ratio": "default",
    "format": "webp",
    "settings": {
      "color": "default",
      "lights": "off",
      "background": "white",
      "windows": "see_through",
      "plate": "none"
    },
    "images": [
      {
        "frame": 1,
        "angle": 0,
        "view": "360/eye_level/01",
        "image_url": "https://api.vehicleimagery.com/image/3/360-eye-level/01-of-32.webp?…"
      },
      {
        "frame": 2,
        "angle": 11.25,
        "view": "360/eye_level/02",
        "image_url": "https://api.vehicleimagery.com/image/3/360-eye-level/02-of-32.webp?…"
      }
    ]
  }
]

401 · Missing or invalid `x-api-key`.

{
  "error": "Invalid API key"
}

403 · Plan restriction (feature, format or brand not allowed) or blocked request.

{
  "error": "Mirroring is not allowed by your plan."
}

404 · No data for the requested path.

{
  "error": "Brand 'Xyz' not found — check /api/brands for valid brands."
}