Como começar?

Comece a usar a Partnr API em minutos. Você pode integrar via cURL (universal) ou via SDK oficial (recomendado para produção).

Qual caminho escolher?

• cURL — Melhor para testar rápido e depurar requisições.
• SDKs (Python / JS/TS) — Melhor para produção: cliente tipado, ergonomia e padrões consistentes.
• MCP — Para integrar com agentes de IA via Model Context Protocol.

Básico

A Partnr API é organizada em torno de REST e usa URLs previsíveis orientadas a recursos. As requisições e respostas são JSON, com códigos HTTP padrão e autenticação via Bearer token (API Key).

Base URL

https://data.partnr.ai/v2/

Padrões

• HTTPS obrigatório — Todas as requisições devem ser feitas via HTTPS. Chamadas via HTTP falham.
• Datas — Formato YYYY-MM-DD (ex: 2025-01-31)
• Booleans — true / false em query strings

Autenticação

A Partnr API usa API keys para autenticar requisições.

Obter chave de API

Em toda requisição, inclua o header com sua chave:

Authorization: Bearer <SUA_API_KEY>

Requisições sem autenticação falham.

Segurança de credenciais

Não exponha API keys em repositórios públicos, código client-side (browser) ou logs. Use variáveis de ambiente e segredos do seu provedor (Vault/Secrets Manager).

Primeira chamada

Escolha o jeito que você prefere integrar: cURL, SDK JavaScript/TypeScript ou SDK Python.

Opção A — cURL (universal)

1) Defina sua API key

export PARTNR_API_KEY="SEU_TOKEN_AQUI"

2) Faça sua primeira chamada

curl -sS \
  -H "Authorization: Bearer $PARTNR_API_KEY" \
  "https://data.partnr.ai/v2/companies/PETR3"

Opção B — JavaScript/TypeScript (backend)

SDKs apenas server-side

Use a SDK apenas em ambientes server-side. Não utilize no browser.

1) Instale o SDK

npm install partnr

yarn add partnr

pnpm add partnr

2) Configure e faça a chamada:

import { PartnrClient } from "partnr";

const client = new PartnrClient({
  apiKey: "SUA_API_KEY",
});

Opção C — Python (backend)

SDKs apenas server-side

Use a SDK apenas em ambientes server-side. Não utilize no browser.

1) Instale o SDK

pip install partnr-api

poetry add partnr-api

uv add partnr-api

2) Configure e faça a chamada:

from partnr import PartnrClient
import os

client = PartnrClient(api_key=os.environ["PARTNR_API_KEY"])

company = client.companies.get("PETR3")
print(company.name)

Erros

A Partnr usa códigos HTTP convencionais para indicar sucesso ou falha.

• 2xx: sucesso
• 4xx: erro do cliente (parâmetro ausente/malformado, recurso não encontrado, etc.)
• 5xx: erro interno (raro)

Formato do erro

Todas as respostas de erro retornam um objeto JSON:

Campo	Descrição	Tipo
error	Objeto com detalhes do erro	object
error.code	Código HTTP	integer
error.message	Mensagem descritiva em inglês	string

Exemplo de erro

{
  "error": {
    "code": 404,
    "message": "Company not found."
  }
}

Request IDs

Cada requisição possui um identificador único. Você encontra esse valor nos headers de resposta em Request-Id.

Exemplo

Request-Id: 60a2b72b4a4110001cb9da09

Se precisar falar com a Partnr sobre uma requisição específica, informe o Request-Id para acelerar a investigação.

Próximos passos

Dica

Prefira integrar via SDK para produção → SDKs

• Quero buscar dados de empresas → Empresas
• Quero consultar fundos listados → Fundos Listados
• Quero ver cotações históricas → Cotações
• Quero consumir notícias por ativo → Notícias
• Quero consultar indicadores macro e séries temporais → Macroeconomia
• Quero fazer triagem e ranking de ativos → Screener