---
title: "Obtém os dados de prelúdio"
method: GET
path: "/v1/prelude"
tags: ["Dados Gerais"]
---

# Obtém os dados de prelúdio

`GET /v1/prelude`

## Request

- Base URL: `https://api.fipex.com.br`
- URL: `https://api.fipex.com.br/v1/prelude`
- Auth: none declared

Retorna combustíveis, tipos de veículos, períodos de referência recentes e
estatísticas de banco de dados em uma única chamada. Útil para inicialização
de aplicações cliente.

Dados servidos de memória (`consts.Prelude`), populados na inicialização do servidor.
Alterações no banco de dados não são refletidas até o servidor reiniciar.

Retornado no envelope padrão `{ "data": { ... } }`.

## Response `200`

Dados de prelúdio obtidos com sucesso.

- GetPreludeResponse
  - `data` Prelude, required: Dados de prelúdio (combustíveis, tipos, períodos, estatísticas) servidos de memória.
    - `fuels` Fuel[], required
      - `id` string, uuid, required
      - `acronym` string, required: Acrônimo do combustível (ex. "g", "e", "d").
      - `name` string, required
    - `types` VehicleType[], required
      - `id` string, uuid, required
      - `name` string, required: Nome legível (ex: "Carros").
      - `slug` string, required: Identificador em formato slug (ex: "carros").
    - `periods` ReferencePeriod[], required
      - `id` string, uuid, required
      - `month` integer, required: Mês de referência (1-12).
      - `month_name` string, required: Nome do mês por extenso (ex: "Junho").
      - `year` integer, required: Ano de referência.
      - `price_count` integer, required: Quantidade de preços publicados nesta referência (estoque).
      - `added` integer, nullable: Combinações veículo/ano/combustível presentes nesta referência e ausentes na referência anterior (fluxo). Ausente (null) na referência mais antiga do dataset, que não tem antecessora — nesse caso o valor nunca é 0.
      - `removed` integer, nullable: Combinações veículo/ano/combustível presentes na referência anterior e ausentes nesta (fluxo). Ausente (null) na referência mais antiga do dataset, que não tem antecessora — nesse caso o valor nunca é 0.
      - `fipe_id` integer, required: Número de sequência de publicação da própria FIPE. Chave monotônica que ordena as referências (prefira-a a tuplas (year, month)).
    - `stats` PreludeStats, required
      - `total_prices` string, int64
      - `total_models` string, int64
      - `oldest_entry` string, date-time, nullable
      - `last_sync` string, date-time, nullable
      - `prices_in_latest_period` string, int64
      - `oldest_price_year` integer, nullable

## Other responses

- `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)