Catálogo

Cores para uma configuração

GET/api/{brand}/{model}/{year}/{variant}/{trim}/colors

Cores mostradas para este carro, mantidas deliberadamente compactas: as cores da casa Vehicle Imagery (disponíveis em qualquer carro) mais as cores da própria marca deste carro. Qualquer cor ativa do catálogo pode ser solicitada em qualquer carro. Passe um nome como ?color= no endpoint da imagem. O catálogo completo com a combinação de marcas está em /api/colors; veja também o guia *Cores de pintura* em /info/guides/colors.

As cores pertencem à marca: se essa configuração exata não estiver no catálogo (por exemplo, um acabamento desconhecido), as cores da marca são retornadas de qualquer forma, com id: null e vehicle_found: false. Apenas uma marca desconhecida responde 404.

API v2 add-on: para um carro com imagens de adição, a resposta também inclui any_hex_color: true. Sua pintura pode ser definida para qualquer cor hexadecimal de 6 dígitos, por exemplo, ?color=c8102e.

Parâmetros de caminho

Nome	Tipo	Descrição
`brand` obrigatório	string	Nome da marca ou apelido (insensível a maiúsculas e minúsculas).
`model` obrigatório	string	Nome do modelo
`year` obrigatório	integer.	Ano do modelo (4 dígitos). Se o ano exato estiver ausente, a geração mais próxima disponível é usada (nota de erro `Y01`).
`variant` obrigatório	string	Variante de carroceria.
`trim` obrigatório	string	Nível de acabamento.

Parâmetros de consulta

Nome	Tipo	Descrição
`version`	string	Resultados de apenas uma versão: `v1` = imagens padrão, `v2` = add-on da API v2 (sem recair nas imagens padrão). Sem ele: tudo o que sua chave permite. Não permitido para sua chave → `403`. `v1v2`

Solicitar

curl "https://api.vehicleimagery.com/api/bmw/m4/2024/coupe/base/colors?version=v1" \
  -H "x-api-key: YOUR_API_KEY"

200 · Cores.

[
  {
    "id": 911,
    "brand": "Abarth",
    "model": "124_Spider_Abarth",
    "year": 2016,
    "variant": "Basis",
    "trim": "base",
    "resolution": "default",
    "format": "png",
    "colors": [
      "default",
      "black",
      "white",
      "blue",
      "orange",
      "wine_red"
    ]
  }
]

401 · `x-api-key` ausente ou inválida.

{
  "error": "Invalid API key"
}

403 · Restrição de plano (recurso, formato ou marca não permitido) ou solicitação bloqueada.

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

404 · Nenhum dado para o caminho solicitado.

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