---
title: "GET /uiapi/v2/readme"
method: GET
path: "/uiapi/v2/readme"
tags: ["ui_api"]
---

# GET /uiapi/v2/readme

`GET /uiapi/v2/readme`

Recupera o arquivo README com informações sobre o conjunto de dados. Permite filtrar o README com base em parâmetros opcionais de ano, mês e órgão

Comportamentos:
- Se nenhum filtro for aplicado, retorna o README original
- Com filtro de órgão, gera um README com observações específicas sobre potenciais falhas nos dados

## Query parameters

- `ano` string
- `mes` string
- `orgao` string

## Response `200`

README.txt com conteúdo detalhado

## Other responses

- `400` — Erro de validação de parâmetros (ano/mês inválidos)
- `500` — Erro interno ao processar o README

## Changes

- **2025-01-27** `627901bc4a69` — 1 info
  - endpoint added
- **2023-02-25** `758e871066be` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/dadosjusbr/apis/api-do-dadosjusbr-org/changes/uiapi/v2/readme/get.md)

---

[API](https://skmtc.dev/dadosjusbr/apis/api-do-dadosjusbr-org.md) · [All operations](https://skmtc.dev/dadosjusbr/apis/api-do-dadosjusbr-org/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dadosjusbr/api-do-dadosjusbr-org/revisions/7035398033aa/schema)