Referência da API
Visão Geral
O MiniValuator oferece uma API REST que permite obter dados fundamentalistas de ações de forma programática. As mesmas regras de cobrança de créditos se aplicam — 10 créditos para um novo ticker, novas consultas gratuitas dentro de 7 dias.
URL Base: https://minivaluator.com
Autenticação: Chave de API via cabeçalho Authorization: Bearer sk-...
Obtendo uma Chave de API
- Faça login na sua conta do MiniValuator
- Acesse Configurações → Chaves de API
- Clique em Adicionar Chave de API, dê um nome a ela e copie a chave gerada (
sk-...)
Mantenha sua chave de API em segredo. Qualquer pessoa com a chave pode consumir seus créditos.
Endpoint
GET /api/stock/fundamentals
Retorna dados fundamentalistas para um determinado ticker de ação.
Requisição
curl "https://minivaluator.com/api/stock/fundamentals?symbol=AAPL" \
-H "Authorization: Bearer sk-your-api-key-here"Parâmetros de Consulta
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
symbol | string | Sim | Símbolo do ticker da ação (ex.: AAPL, MSFT, GOOGL) |
Resposta
{
"data": {
"symbol": "AAPL",
"name": "Apple Inc.",
"fcfPerShare": 7.43,
"currentPrice": 211.45,
"currentPFCF": 28,
"eps": 6.42,
"currentPE": 33,
"growthEstimate": {
"rates": [0.062, 0.091, 0.08, 0.08, 0.08],
"cagr": 0.082,
"quality": "ok",
"flags": []
},
"earningsGrowthEstimate": {
"rates": [0.11, 0.13, 0.12, 0.12, 0.12],
"cagr": 0.12,
"quality": "ok",
"flags": []
},
"dataSource": "Financial Modeling Prep"
}
}Campos da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
symbol | string | Símbolo do ticker em maiúsculas |
name | string | Nome da empresa |
fcfPerShare | number | Fluxo de caixa livre por ação (TTM, USD) |
currentPrice | number | Preço atual da ação (USD) |
currentPFCF | number | Múltiplo de preço sobre FCF (TTM) |
eps | number | Lucro por ação (TTM, USD) |
currentPE | number | Índice preço/lucro (TTM) |
growthEstimate | object | null | Estimativa de crescimento de 5 anos baseada na receita |
earningsGrowthEstimate | object | null | Estimativa de crescimento de 5 anos baseada no LPA |
dataSource | string | Nome do provedor de dados |
Campos de growthEstimate
| Campo | Tipo | Descrição |
|---|---|---|
rates | number[] | Cinco taxas de crescimento ano a ano (decimais, ex.: 0.08 = 8%) |
cagr | number | Taxa de crescimento anual composta ao longo de todo o período |
quality | "ok" | "partial" | "insufficient" | Nível de confiança dos dados |
flags | string[] | Observações sobre valores preenchidos ou limitados |
Respostas de Erro
| Status HTTP | Mensagem | Causa |
|---|---|---|
400 | "Symbol required" | Parâmetro symbol ausente |
400 | "Invalid symbol format" | O símbolo contém caracteres inválidos |
400 | "Insufficient credits" | A conta tem menos de 10 créditos |
400 | "Rate limit exceeded" | Requisições em excesso a partir deste IP |
400 | "Stock not found" | Ticker não reconhecido pelo provedor de dados |
Todos os erros seguem o formato:
{ "error": "Insufficient credits" }Consumo de Créditos
| Cenário | Créditos cobrados |
|---|---|
| Primeira consulta de um novo ticker | 10 créditos |
| Nova consulta dentro de 7 dias | Gratuita (servida do cache) |
| Nova consulta após 7 dias | 10 créditos |
Exemplos de Código
Python
import requests
API_KEY = "sk-your-api-key-here"
response = requests.get(
"https://minivaluator.com/api/stock/fundamentals",
params={"symbol": "AAPL"},
headers={"Authorization": f"Bearer {API_KEY}"},
)
data = response.json()
print(data["data"]["fcfPerShare"]) # 7.43JavaScript / Node.js
const API_KEY = "sk-your-api-key-here";
const res = await fetch(
"https://minivaluator.com/api/stock/fundamentals?symbol=AAPL",
{ headers: { Authorization: `Bearer ${API_KEY}` } }
);
const { data } = await res.json();
console.log(data.fcfPerShare); // 7.43