> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bunny.build/llms.txt
> Use this file to discover all available pages before exploring further.

# POST /fake-data

> Gere dados falsos realistas para testes e desenvolvimento: nomes, e-mails, endereços e muito mais.

## Endpoint

```
POST https://api.bunny.build/api/v1/fake-data
```

## Autenticação

| Header         | Obrigatório | Valor                        |
| -------------- | ----------- | ---------------------------- |
| `X-API-Key`    | Sim         | Sua chave de API (`bun_...`) |
| `Content-Type` | Sim         | `application/json`           |

## Visão geral

Gere dados falsos realistas e com suporte a localidade para testes e desenvolvimento. Escolha entre dezenas de tipos de dados incluindo nomes, e-mails, endereços, números de telefone, empresas e muito mais. Solicite até 100 registros em uma única chamada com suporte opcional a localidade para dados específicos de cada região.

## Casos de uso

* Popular bancos de dados de desenvolvimento e homologação com dados de teste realistas
* Gerar dados de exemplo para demos e protótipos
* Preencher fixtures de testes automatizados sem armazenar dados pessoais
* Criar respostas de API simuladas para o desenvolvimento do frontend

## Detalhes

Tipos suportados incluem: `name`, `email`, `phone`, `address`, `company`, `username`, `password`, `date`, `url`, `ip`, `uuid`, `color`, `product`, `sentence`, `paragraph`. O parâmetro `locale` aceita tags de idioma BCP 47 (ex.: `en`, `pt-BR`, `de`, `es`). O count tem padrão `1` e limite máximo de `100`.

## Corpo da requisição

| Campo    | Tipo   | Obrigatório | Descrição                                                     |
| -------- | ------ | ----------- | ------------------------------------------------------------- |
| `type`   | string | Sim         | Tipo de dado falso a gerar (ex.: `name`, `email`, `address`)  |
| `count`  | number | Não         | Quantidade de registros a gerar (padrão: 1, máximo: 100)      |
| `locale` | string | Não         | Localidade BCP 47 para dados localizados (ex.: `pt-BR`, `de`) |

### Exemplo

```json theme={null}
{
  "type": "name",
  "count": 3,
  "locale": "pt-BR"
}
```

## Resposta

### 200 OK

| Campo  | Tipo      | Descrição                                |
| ------ | --------- | ---------------------------------------- |
| `type` | string    | O tipo de dado solicitado                |
| `data` | string\[] | Array de valores de dados falsos gerados |

**Exemplo**

```json theme={null}
{
  "type": "name",
  "data": [
    "Ana Paula Ferreira",
    "Carlos Eduardo Silva",
    "Mariana Oliveira"
  ]
}
```

### 401 Unauthorized

```json theme={null}
{
  "detail": "Missing API key. Include X-API-Key header."
}
```

### 402 Payment Required

```json theme={null}
{
  "detail": "Monthly quota exceeded. Upgrade your plan."
}
```

### 422 Unprocessable Entity

```json theme={null}
{
  "detail": "Unknown data type. Supported: name, email, phone, address, company, ..."
}
```

### 429 Too Many Requests

```json theme={null}
{
  "detail": "Rate limit exceeded. Try again in 60 seconds."
}
```

## Exemplo cURL

```bash theme={null}
curl -X POST https://api.bunny.build/api/v1/fake-data \
  -H "X-API-Key: bun_sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{"type": "name", "count": 3, "locale": "pt-BR"}'
```