---
title: "Anos-modelo e versões de uma família"
method: GET
path: "/v1/brands/{brand}/families/{family}"
tags: ["Hubs"]
---

# Anos-modelo e versões de uma família

`GET /v1/brands/{brand}/families/{family}`

## Request

- Base URL: `https://api.fipex.com.br`
- URL: `https://api.fipex.com.br/v1/brands/{brand}/families/{family}`
- Auth: none declared

Hub da família: para cada ano-modelo (0km primeiro, depois do mais novo
ao mais antigo) o número de versões e o preço mínimo, máximo e mediano
— a curva de preço por idade —, mais cada versão com os anos em que tem
preço (cada par versão × ano é uma página de veículo). Família
inexistente na marca retorna `404`.

Tudo vem do período mais recente da família (`ref_year`/`ref_month`):
versões e anos-modelo que a FIPE não precifica mais nesse mês ficam de
fora (suas páginas continuam respondendo). Uma família defasada
responde com o seu último mês, mais antigo que o da tabela.

## Path parameters

- `brand` string, required
- `family` string, required

## Response `200`

Hub da família.

- GetFamilyHubResponse
  - `data` FamilyHub, required
    - `brand` Brand, required: Marca de hub: une as marcas FIPE de mesmo nome entre tipos de veículo. `slug` é estável e sem sufixo (`fiat`); pode coincidir com o slug de uma das marcas FIPE unidas, mas é um identificador próprio.
      - `slug` string, required
      - `name` string, required: Nome de exibição (ex. `Volkswagen` para "VW - VolksWagen").
      - `vehicle_types` string[], required: Tipos de veículo presentes (`vehicle_types.name`).
      - `family_count` integer, required
      - `version_count` integer, required: Versões FIPE (modelos) distintas com preço no período mais recente da marca. `family_count` conta as famílias com ao menos uma delas (o hub da marca também lista as famílias defasadas).
      - `make_slugs` string[], required: Slugs reais das marcas FIPE unidas.
    - `slug` string, required
    - `name` string, required
    - `vehicle_types` string[], required
    - `version_count` integer, required: Versões FIPE (modelos) distintas com preço em `ref_year`/`ref_month` — as listadas em `versions`.
    - `years` FamilyYearSummary[], required: 0km primeiro, depois do mais novo ao mais antigo.
      - `year` YearOption, required: Representa um ano disponível para um modelo. Cada opção é auto-descritiva: `value` é o seletor canônico que pode ser enviado diretamente em `/v1/prices?year=<value>`.
        - `value` string, required: Seletor canônico do ano. `"2020"` para um ano-modelo, `"zero"` para um veículo 0km/novo. Use este valor em `year=` nos endpoints de preço.
        - `is_zero_km` boolean, required: `true` quando a opção é o veículo 0km/novo (`value == "zero"`); `false` para um ano-modelo concreto. Discriminador para ordenar e rotular sem precisar interpretar `value`.
      - `version_count` integer, required: Versões FIPE (modelos) distintas com preço nesse ano-modelo, no período da família.
      - `price` PriceRange, required
        - `min_cents` integer, required
        - `min_formatted` string, required
        - `max_cents` integer, required
        - `max_formatted` string, required
      - `median_cents` integer, required
      - `median_formatted` string, required
    - `versions` FamilyVersion[], required: Ordenadas por `model_name`.
      - `model_name` string, required
      - `make_slug` string, required
      - `model_slug` string, required
      - `fuel_acronym` string, required
      - `fuel_name` string, required
      - `fipe_code` string, required
      - `vehicle_type` string, required
      - `years` YearOption[], required: Anos-modelo com preço no período da família; 0km primeiro, depois do mais novo ao mais antigo.
        - `value` string, required: Seletor canônico do ano. `"2020"` para um ano-modelo, `"zero"` para um veículo 0km/novo. Use este valor em `year=` nos endpoints de preço.
        - `is_zero_km` boolean, required: `true` quando a opção é o veículo 0km/novo (`value == "zero"`); `false` para um ano-modelo concreto. Discriminador para ordenar e rotular sem precisar interpretar `value`.
    - `ref_year` integer, required: Período de referência (FIPE) mais recente entre os preços da família, o único que `years` e `versions` agregam. Anterior ao mês mais recente da tabela quando a família está defasada.
    - `ref_month` integer, required

## Other responses

- `400`: Erro de validação (400). Usado para TODOS os erros de validação — não há 422.
- `404`: Recurso não encontrado (404).
- `500`: Erro interno do servidor (500).

---

[API](https://skmtc.dev/fipex/apis/api-fipex.md) · [All operations](https://skmtc.dev/fipex/apis/api-fipex/llms.txt) · [OpenAPI document](https://skmtc.dev/fipex/apis/api-fipex/revisions/800eab7da73d?raw)
