Documentação

API Metaport

Referência dos endpoints disponíveis para índices, ativos e assinatura. Todas as rotas de dados exigem autenticação por token e o recurso correspondente no plano.

Autenticação

O token de API é gerado e gerenciado apenas no painel autenticado — não há endpoint público para criar ou revogar token. Depois de obter o token no painel, envie-o no cabeçalho Authorization em todas as requisições à API.

Cabeçalho de autenticação

Authorization: Token SEU_TOKEN_AQUI
GET

Selic

GET /indexes/selic

Resumo anual da Selic com totais mensais e série diária. Exige o recurso selic no plano. O atraso de dados do plano, quando houver, limita a data máxima retornada.

Parâmetro Tipo Descrição
year obrigatório integer Ano civil a consultar. Mínimo: 1986.
ordering opcional string Ordenação da série diária. Valores: -date (padrão) ou date.

Selic de 2024

curl 'https://metaport.com.br/indexes/selic?year=2024&ordering=-date' \
  -H 'Authorization: Token SEU_TOKEN_AQUI'

Exemplo de resposta

{
  "from": "2024-01-02",
  "to": "2024-12-31",
  "total": "10.123456",
  "monthly": {
    "january": "0.800000",
    "february": "0.750000"
  },
  "values": [
    { "date": "2024-12-31", "value": "0.041234" }
  ]
}
Campo Tipo Descrição
from date Primeira data disponível no ano (após aplicar delay do plano).
to date Última data disponível no ano.
total decimal Soma dos valores diários no período.
monthly object Totais agregados por mês (january … december).
values array Série diária com date e value.
GET

Focus

GET /indexes/focus

Relatório Focus com tabelas anuais e mensais de expectativas de mercado. Exige o recurso focus no plano. Sem date, usa a data de cálculo mais recente.

Parâmetro Tipo Descrição
date opcional date Data de cálculo no formato YYYY-MM-DD. Se omitida, usa a mais recente.

Focus mais recente

curl 'https://metaport.com.br/indexes/focus' \
  -H 'Authorization: Token SEU_TOKEN_AQUI'

Focus em data específica

curl 'https://metaport.com.br/indexes/focus?date=2024-06-14' \
  -H 'Authorization: Token SEU_TOKEN_AQUI'
Campo Tipo Descrição
meta.publication_date date Data de publicação associada ao cálculo.
meta.calculation_date date Data de cálculo do relatório.
annual_table array Indicadores anuais com janelas e comparações semanais.
monthly_five_business_days_table array Indicadores mensais na janela de cinco dias úteis.
GET

Dividendos

GET /assets/dividends

Lista proventos ativos a partir de uma data de corte, filtrados por tickers. Exige o recurso dividends no plano. Planos diferentes de unlimited aceitam no máximo 50 tickers por requisição.

Parâmetro Tipo Descrição
tickers obrigatório string Tickers separados por vírgula, por exemplo XPML11,PETR4.
record_date obrigatório date Data mínima de record date (YYYY-MM-DD).

Proventos de PETR4 e XPML11

curl 'https://metaport.com.br/assets/dividends?tickers=PETR4,XPML11&record_date=2024-01-01' \
  -H 'Authorization: Token SEU_TOKEN_AQUI'

Exemplo de item

{
  "ticker": "PETR4",
  "record_date": "2024-05-20",
  "payment_date": "2024-06-20",
  "type": "dividendos",
  "value": "1.25000000",
  "net_value": "1.06250000",
  "paid": true
}
Campo Tipo Descrição
ticker string Código do ativo.
record_date date Data de corte / record date.
payment_date date|null Data de pagamento, quando conhecida.
type string Tipo do evento: dividendos, jcp, rendimento_tributado, reducao_de_capital ou provisionado.
value decimal Valor bruto por cota/ação.
net_value decimal Valor líquido por cota/ação.
paid boolean Indica se o pagamento já ocorreu.
GET

Meu plano

GET /subscriptions/me

Retorna o plano atual, limites de taxa, atrasos por recurso, features liberadas e, se houver, a assinatura ativa.

Consultar entitlements

curl 'https://metaport.com.br/subscriptions/me' \
  -H 'Authorization: Token SEU_TOKEN_AQUI'

Exemplo de resposta

{
  "plan_code": "starter",
  "rate_limit": 60,
  "delays": {
    "selic": 1
  },
  "features": {
    "selic": true,
    "focus": true,
    "dividends": true
  },
  "subscription": {
    "id": 12,
    "plan_code": "starter",
    "status": "active",
    "starts_at": "2024-01-01T00:00:00Z",
    "ends_at": null
  }
}
Campo Tipo Descrição
plan_code string Código do plano vigente.
rate_limit integer Limite de requisições do plano.
delays object Atraso em dias por recurso, quando aplicável.
features object Mapa de recursos liberados para a conta.
subscription object|null Detalhes da assinatura ativa, ou null.