Documentação da API

Gere dados brasileiros fictícios via API REST. Sem autenticação, sem cadastro. Retorna JSON por padrão, ou CSV e SQL sob demanda.

Base URL

https://fakeforge.com.br/api/generate

GET/api/generate

Gera dados via query parameters.

Parâmetros

Param	Tipo	Default	Descrição
type	string	-	Tipo de dado (ver tabela abaixo)
quantity	number	10	Quantidade (1 a 10.000)
formatted	boolean	true	Incluir pontuação (123.456.789-00 vs 12345678900)
city	string	-	Só com `type=address` ou `type=cep`: endereço e CEP de uma capital, com a faixa de CEP e os bairros dela (ex.: `city=manaus`, `city=sao-paulo`). Lista das 27 em /gerador-cep.

Exemplo

# Gerar 5 CPFs formatados

curl "/api/generate?type=cpf&quantity=5"

# Resposta

{
  "type": "cpf",
  "quantity": 5,
  "data": [
    "123.456.789-09",
    "987.654.321-00",
    ...
  ]
}

POST/api/generate

Gera dados via JSON body. Suporta export em CSV e SQL.

Body (JSON)

Campo	Tipo	Descrição
type	string	Tipo de dado
quantity	number	Quantidade (1 a 10.000)
formatted	boolean	Incluir pontuação
format	string	"json" (padrão), "csv", ou "sql"

Exemplos

# Gerar 10 endereços em CSV

curl -X POST /api/generate \

-H "Content-Type: application/json" \

-d '{"type":"address","quantity":10,"format":"csv"}'

# Gerar 100 empresas em SQL

curl -X POST /api/generate \

-H "Content-Type: application/json" \

-d '{"type":"company","quantity":100,"format":"sql"}'

Tipos disponíveis

Documentos

cpf	CPF	Cadastro de Pessoa Física (válido)
cnpj	CNPJ	Cadastro Nacional de Pessoa Jurídica (válido)
cnpjAlfa	CNPJ Alfanumérico	Novo CNPJ com letras (vigência 01/07/2026)
cnh	CNH	Carteira Nacional de Habilitação válida (mod-11 DENATRAN)
cin	CIN	Carteira de Identidade Nacional (substitui o RG)
rg	RG	Registro Geral formato SP (mod-11 com dígito X)
pis	PIS/PASEP	PIS/PASEP/NIT/NIS válido (mod-11 com pesos 3-2)
renavam	RENAVAM	Registro Nacional de Veículos válido (mod-11 DENATRAN)
tituloEleitor	Título de Eleitor	Título com UF e dígitos verificadores TSE
placa	Placa Mercosul	Placa formato LLLNLNN (CONTRAN 729/2018)
placaAntiga	Placa Antiga	Placa formato LLL-NNNN (legado pré-2018)

Pessoa

person	Nome e gênero	Nome, sobrenome e gênero
fullName	Nome Completo	Nome e sobrenome brasileiro
firstName	Primeiro Nome	Nomes populares brasileiros
lastName	Sobrenome	Sobrenomes comuns no Brasil

Contato

email	Email	Email com domínios BR e internacionais
phone	Celular	Número de celular com DDD válido
landline	Telefone Fixo	Número fixo com DDD válido

Endereço

cep	CEP	Código de Endereçamento Postal
address	Endereço Completo	Rua, bairro, cidade, estado e CEP

Financeiro

bankAccount	Conta Bancária	Banco, agência e conta
pixKey	Chave PIX	CPF, email, telefone ou aleatória
creditCard	Cartão de Crédito	Qualquer bandeira (Luhn válido)
creditCardVisa	Cartão Visa	Cartão Visa válido (prefixo 4 + Luhn)
creditCardMastercard	Cartão Mastercard	Cartão Mastercard válido (prefixo 51-55 + Luhn)
creditCardElo	Cartão Elo	Cartão Elo válido (prefixos BR + Luhn)
creditCardHipercard	Cartão Hipercard	Cartão Hipercard válido (prefixo 606282 + Luhn)
creditCardAmex	Cartão Amex	American Express (15 dígitos, prefixo 34/37 + Luhn)

Empresa

company

Empresa

CNPJ, razão social, endereço e contato

Random

random4	Random 4-digit code	OTP / verification code (4 digits)
random6	Random 6-digit code	OTP / verification code (6 digits)
random8	Random 8-digit code	OTP / verification code (8 digits)

NEWSchema Builder & Presets

Gere registros com campos que batem entre si: o email sai do nome da pessoa, o cartão usa o nome do titular e, no preset fintech, as chaves Pix são o CPF, o email e o celular do próprio cliente. Sem chave e no Free, presets e schema devolvem amostra de 3 por chamada; no Dev e no Team, até 2.000 em cada chamada.

Presets prontos

Preset	Campos
fintech	cliente, chaves pix, conta bancária, cartão, score serasa, renda
ecom	cliente, endereços de entrega e cobrança, carrinho, pagamento, totais
customer	nome, cpf, email, telefone, endereço
employee	nome, cpf, email, telefone, endereço, conta bancária, pix
company	razão social, cnpj, telefone, endereço
ecommerce_order	cliente, cpf, email, telefone, endereço, cartão
contact_list	nome, email, celular, fixo

# Usar preset

curl "/api/generate?preset=customer&quantity=3"

# Schema customizado

curl -X POST /api/generate \

-H "Content-Type: application/json" \

-d '{"schema":[{"name":"nome","type":"fullName"},{"name":"doc","type":"cpf"},{"name":"contato","type":"email"}],"quantity":10}'

Integração

Node.js / TypeScript

const res = await fetch("https://fakeforge.com.br/api/generate", {
  method: "POST",
  headers: { "Content-Type": "application/json", "X-API-Key": process.env.FAKEFORGE_API_KEY },
  body: JSON.stringify({ preset: "customer", quantity: 50 }), // preset acima de 3: Dev
});
const { data } = await res.json();
console.log(data[0]); // { nome, cpf, email, telefone, endereco }

Python

import os
import requests

resp = requests.post("https://fakeforge.com.br/api/generate", json={
    "preset": "customer",
    "quantity": 50  # preset acima de 3: Dev
}, headers={"X-API-Key": os.environ["FAKEFORGE_API_KEY"]})
data = resp.json()["data"]
print(data[0])  # {'nome': '...', 'cpf': '...', ...}

CI/CD (GitHub Actions)

# .github/workflows/seed.yml
- name: Seed test database
  run: |
    curl -s -X POST https://fakeforge.com.br/api/generate \
      -H "Content-Type: application/json" \
      -H "X-API-Key: ${{ secrets.FAKEFORGE_API_KEY }}" \
      -d '{"preset":"customer","quantity":100,"format":"sql"}' \
      | psql $DATABASE_URL

Limites

Plano	Requests/dia	Itens por request	Presets e schema	Preço
Sem chave	50 por IP	50	3	Grátis
Free	50	100	3	Grátis
Dev	10.000	10.000	2.000	R29/mês
Team	100.000	10.000	2.000	R79/mês

No site, sem chave de API: até 100 itens por dia sem conta e até 500 com a conta grátis. No passe e nos planos pagos, sem limite por dia.

Headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Precisa de mais chamadas? Compare os planos →