OBM API · Documentação v1
Sandbox ativa. Troque a chave em Autenticação.Baixar collection (Postman, Insomnia, Bruno)
v1.0.0
OpenAPI 3.1.0

API do OBM

Referência da API do OBM para Fundos, ações, BDRs, FIIs, ETFs e índices B3.

Servidor:https://api.obm.com.br
Bibliotecas Cliente

Fundos

​

O identificador é o CNPJ com 14 dígitos, sem pontuação: /v1/funds/08507696000159. O identificador usado no endereço do site não funciona na API. A fonte é a CVM: cadastro de fundos e informes periódicos, incluindo classes da RCVM 175. Cotas vêm do Informe Diário, com referência diária e publicação normalmente em D-1; retificações podem alterar o histórico. Confira reference_date e a fonte de cada resposta antes de comparar períodos.

Comparar dois fundos

Consulte /v1/funds/{cnpj}/nav para cada CNPJ com o mesmo start e end; percorra todas as páginas. Compare apenas as datas presentes nas duas séries. Para uma base 100, divida cada nav_per_share pela primeira cota do período comum e multiplique por 100 na sua análise. Se precisar só de retorno, volatilidade e queda em relação ao pico, /v1/funds/{cnpj}/metrics já entrega esses números prontos.

curl 'https://api.obm.com.br/v1/funds/08507696000159/nav' \
  -H "X-API-Key: ${OBM_API_KEY}"

O segundo fundo exige chave própria. A sandbox libera apenas o CNPJ acima. nav_per_share é a cota do fundo; quota se refere ao consumo da API. Ausência de cota não é retorno zero. A carteira dos fundos fica fora desta versão.

Séries de classes e subclasses

Depois da RCVM 175, um fundo pode ter mais de uma classe, cada uma com CNPJ próprio. /v1/funds/{cnpj}/classes lista as classes cadastradas. O cadastro não garante série dedicada: /v1/funds/{cnpj}/classes/{class_cnpj}/series lê o armazenamento seletivo de fundos multiclasse, classes com CNPJ distinto do fundo ou múltiplas chaves de série no mês. A projeção do fundo continua disponível em /nav, sem ser copiada para uma classe.

Quando points está vazio, missing_reason distingue:

  • series_not_materialized: não há série dedicada armazenada para a classe. Isso inclui fundos fora da coorte acima; consulte /nav para a projeção do fundo.
  • no_observations: há identidade de série, mas nenhuma observação armazenada.
  • no_observations_in_range: há observações, mas nenhuma no intervalo solicitado.

Com pontos, missing_reason é null. reference_date e return_windows usam o histórico completo da série selecionada; start e end filtram apenas points. Sem subclass, a série da classe tem preferência; se ela não existir, seleciona-se a subclasse com maior PL. Classe inexistente ou pertencente a outro fundo retorna 404; subclass sem série nessa classe também retorna 404.

Exemplo com série dedicada, usado na collection (exige chave própria):

curl 'https://api.obm.com.br/v1/funds/18537348000188/classes/18537348000188/series?start=2026-10-01&end=2026-11-06' \
  -H "X-API-Key: ${OBM_API_KEY}"

Em leitura de produção em 09/11/2026, esse par tinha 24 pontos no intervalo, com última cota de 3.716,201868 em 05/11/2026. Os fundos 08507696000159 e 07593972000186 tinham classe única de mesmo CNPJ, sem série dedicada e com 24 cotas cada em /nav no mesmo intervalo. Essa ausência segue a política de armazenamento seletivo; não indica ausência de cotas do fundo.

Listar Fundos

​

Lista Fundos FI, FIDC e FIP pelo cadastro da CVM, com filtros por nome e gestora. Os dados acompanham as publicações cadastrais e os informes diários; o identificador é o CNPJ com 14 dígitos.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Consulta

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/funds
curl 'https://api.obm.com.br/v1/funds?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "administrator": "string",
      "cnpj": "string",
      "fund_class": "string",
      "manager": "string",
      "name": "string",
      "nav_per_share": 1,
      "net_worth": 1,
      "reference_date": "2026-11-18",
      "return_12m": 1,
      "shareholder_count": 1,
      "status": "string",
      "type": "string"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Ranking anual de Fundos

​

Ordena os Fundos FI pelo retorno do ano informado, com base nas cotas da CVM disponíveis no OBM. O ranking acompanha a atualização das séries e identifica cada fundo pelo CNPJ.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Consulta

  • Números inteiros.

  • Only FI ranking is available; FIDC and FIP return 422: ranking not available for this type.

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/funds/ranking
curl 'https://api.obm.com.br/v1/funds/ranking?year=2000&page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "administrator": "string",
      "cnpj": "string",
      "name": "string",
      "rank": 1,
      "reference_date": "2026-11-18",
      "return_ratio": 1,
      "year": 1
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cadastro de um fundo

​

Devolve o cadastro da CVM, prestadores e taxas do fundo identificado pelo CNPJ com 14 dígitos. O conteúdo acompanha as atualizações cadastrais da fonte.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/funds/{cnpj}
curl -i 'https://api.obm.com.br/v1/funds/08507696000159' \
  -H "X-API-Key: ${OBM_API_KEY}"
Exemplo ilustrativo

Valores ilustrativos; não são cotações atuais nem dados verificados do dia.

{
  "data": {
    "cnpj": "08507696000159",
    "name": "FUNDO DE INVESTIMENTO — EXEMPLO ILUSTRATIVO",
    "nav_per_share": 7.382156,
    "net_worth": 2456800000,
    "reference_date": "2026-10-23",
    "status": "EM FUNCIONAMENTO NORMAL",
    "type": "FI"
  },
  "meta": null,
  "reference_date": "2026-10-23",
  "source": {
    "code": "cvm",
    "name": "Comissão de Valores Mobiliários",
    "url": "https://www.gov.br/cvm/pt-br"
  }
}

Classes de um fundo

​

Lista as classes e subclasses RCVM 175 do fundo identificado pelo CNPJ. A estrutura e as taxas acompanham as publicações cadastrais da CVM.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/funds/{cnpj}/classes
curl 'https://api.obm.com.br/v1/funds/{cnpj}/classes' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "admin_fee_ratio": 1,
      "anbima_class": "string",
      "cnpj": "string",
      "custody_fee_max_ratio": 1,
      "entry_fee_ratio": 1,
      "exit_fee_ratio": 1,
      "investment_policy": "string",
      "min_investment_brl": 1,
      "name": "string",
      "nav_per_share": 1,
      "net_worth": 1,
      "performance_fee_ratio": 1,
      "qualified_investor_only": true,
      "redemption_lockin_days": 1,
      "redemption_payment_days": 1,
      "reference_date": "2026-11-18",
      "status": "string",
      "subclasses": [
        {
          "code": "string",
          "condominium_type": "string",
          "exclusive": true,
          "name": "string",
          "start_date": "2026-11-18",
          "status": "string",
          "target_investor": "string"
        }
      ],
      "target_investor": "string",
      "type": "string"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cotas históricas de uma classe

​

Devolve até 5.000 pontos da série dedicada de cotas da CVM por classe ou subclasse, no fundo identificado pelo CNPJ principal. O armazenamento dedicado cobre fundos multiclasse, classes com CNPJ distinto do fundo ou múltiplas chaves de série no mês. Fora dessa coorte pode haver cotas apenas em /v1/funds/{cnpj}/nav. points vazio acompanha missing_reason; não significa retorno zero. Classe fora do fundo ou subclasse sem série retorna 404. Sem subclass, prefere a série da classe; na ausência dela, seleciona a subclasse com maior PL. reference_date e return_windows usam o histórico completo da série selecionada, independentemente de start/end. O exemplo com série preenchida exige chave própria; a sandbox recebe 403.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • data no formato AAAA-MM-DD (RFC 3339)

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/funds/{cnpj}/classes/{class_cnpj}/series
curl 'https://api.obm.com.br/v1/funds/{cnpj}/classes/{class_cnpj}/series' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": {
    "class_cnpj": "string",
    "grain": "string",
    "missing_reason": "series_not_materialized",
    "points": [
      {
        "daily_deposits": 1,
        "date": "2026-11-18",
        "nav_per_share": 1,
        "net_worth": 1,
        "redemptions": 1,
        "shareholder_count": 1
      }
    ],
    "return_windows": [
      {
        "months": 1,
        "pct_cdi": 1,
        "return_ratio": 1
      }
    ],
    "subclass_code": "string"
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Documentos de um fundo

​

Devolve a lâmina e o regulamento, além do perfil do investidor e histórico de prestadores, para o CNPJ indicado. Os documentos acompanham as publicações da CVM, cada um com sua competência.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/funds/{cnpj}/documents
curl 'https://api.obm.com.br/v1/funds/{cnpj}/documents' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": {
    "factsheet": {
      "additional_min_brl": 1,
      "admin_risk_class": 1,
      "available": true,
      "cancellation_conversion_type": "string",
      "classes_available": [
        "string"
      ],
      "distributor_remuneration": "string",
      "grace_conditions": "string",
      "grace_days": 1,
      "grace_status": "no_grace",
      "initial_min_brl": 1,
      "investment_policy": "string",
      "investment_restrictions": "string",
      "latest_competence": "2026-11-18",
      "loss_risk": true,
      "missing_reason": "string",
      "negative_equity_risk": true,
      "objective": "string",
      "payment_day_type": "string",
      "permanence_min_brl": 1,
      "redemption_conversion_days": 1,
      "redemption_min_brl": 1,
      "redemption_payment_days": 1,
      "sale_conflict_text": "string",
      "selected_class_cnpj": "string",
      "single_manager_distribution_text": "string",
      "subscription_conversion_days": 1,
      "subscription_conversion_type": "string"
    },
    "investor_profile": {
      "available": true,
      "classes_available": [
        "string"
      ],
      "competence_lag_days": 1,
      "history": [
        {
          "competence_month": "2026-11-18",
          "expected_daily_nav_change_ratio": 1,
          "groups": [
            {
              "count": 1,
              "group": "individual",
              "net_worth_ratio": 1
            }
          ],
          "holder_types": [
            {
              "count": 1,
              "net_worth_ratio": 1,
              "type": "pf_private"
            }
          ],
          "largest_holder_net_worth_ratio": 1,
          "portfolio_avg_maturity_months": 1,
          "private_credit_net_worth_ratio": 1,
          "related_issuer_net_worth_ratio": 1,
          "retail_net_worth_ratio": 1,
          "stress_daily_nav_change_ratio": 1,
          "stress_equity_change_ratio": 1,
          "stress_fx_change_ratio": 1,
          "stress_other_change_ratio": 1,
          "stress_rate_change_ratio": 1,
          "stress_risk_factor": "string",
          "total_holders": 1,
          "var_21d_95_ratio": 1,
          "var_model": "string"
        }
      ],
      "latest": {
        "competence_month": "2026-11-18",
        "expected_daily_nav_change_ratio": 1,
        "groups": [
          {
            "count": 1,
            "group": "individual",
            "net_worth_ratio": 1
          }
        ],
        "holder_types": [
          {
            "count": 1,
            "net_worth_ratio": 1,
            "type": "pf_private"
          }
        ],
        "largest_holder_net_worth_ratio": 1,
        "portfolio_avg_maturity_months": 1,
        "private_credit_net_worth_ratio": 1,
        "related_issuer_net_worth_ratio": 1,
        "retail_net_worth_ratio": 1,
        "stress_daily_nav_change_ratio": 1,
        "stress_equity_change_ratio": 1,
        "stress_fx_change_ratio": 1,
        "stress_other_change_ratio": 1,
        "stress_rate_change_ratio": 1,
        "stress_risk_factor": "string",
        "total_holders": 1,
        "var_21d_95_ratio": 1,
        "var_model": "string"
      },
      "latest_competence": "2026-11-18",
      "missing_reason": "string",
      "selected_class_cnpj": "string"
    },
    "provider_history": {
      "available": true,
      "history": [
        {
          "current": true,
          "entity_id": 1,
          "provider_document": "string",
          "provider_kind": "pj",
          "provider_name": "string",
          "role": "manager",
          "valid_from": "2026-11-18",
          "valid_to": "2026-11-18"
        }
      ],
      "manager_changes_last_5y": 0,
      "missing_reason": "string",
      "selected_class_cnpj": "string"
    },
    "regulation": {
      "allocation_limits": [
        {
          "bucket": "string",
          "label": "string",
          "max_ratio": 1,
          "min_ratio": 1,
          "prohibited": true
        }
      ],
      "available": true,
      "classes_available": [
        "string"
      ],
      "derivatives_allowed": true,
      "derivatives_purpose": "string",
      "foreign_investment_allowed": true,
      "leverage_beyond_net_worth": true,
      "missing_reason": "string",
      "performance_fee": {
        "benchmark": "string",
        "benchmark_multiple": 1,
        "coupon": 1,
        "description": "string",
        "exists": true,
        "method": "string",
        "notes": "string"
      },
      "performance_fee_last_charge_date": "2026-11-18",
      "private_credit_allowed": true,
      "private_credit_max_ratio": 1,
      "reference_month": "2026-11-18",
      "selected_class_cnpj": "string"
    }
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Métricas de um fundo

​

Devolve os retornos e indicadores de risco calculados pelo OBM sobre as cotas da CVM para o CNPJ indicado. Os cálculos acompanham a atualização da série disponível.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/funds/{cnpj}/metrics
curl 'https://api.obm.com.br/v1/funds/{cnpj}/metrics' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": {
    "current_drawdown": 1,
    "health": {
      "eligible": true,
      "min_quotes": 1,
      "quote_count": 1,
      "reason": "metrics_available",
      "state": "computed"
    },
    "max_drawdown_12m": 1,
    "max_drawdown_36m": 1,
    "max_drawdown_60m": 1,
    "max_drawdown_inception": 1,
    "return_12m": 1,
    "return_1m": 1,
    "return_24m": 1,
    "return_36m": 1,
    "return_3m": 1,
    "return_6m": 1,
    "return_inception": 1,
    "return_ytd": 1,
    "sharpe_12m": 1,
    "volatility_12m": 1
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Retornos mensais de um fundo

​

Devolve o retorno mensal e anual calculado pelo OBM com as cotas da CVM para o CNPJ indicado. Os resultados acompanham a atualização do histórico diário.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/funds/{cnpj}/monthly-returns
curl 'https://api.obm.com.br/v1/funds/{cnpj}/monthly-returns?years=5' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": {
    "annual": [
      {
        "is_partial": true,
        "months_available": 1,
        "months_total": 1,
        "return_ratio": 1,
        "year": 1
      }
    ],
    "monthly": [
      {
        "month": 1,
        "return_ratio": 1,
        "year": 1
      }
    ]
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cotas históricas de um fundo

​

Devolve as cotas diárias e os dados de patrimônio e fluxos informados à CVM para o CNPJ indicado. A série acompanha a publicação do Informe Diário e pode receber retificações.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • Números inteiros.

  • Números inteiros.

  • data no formato AAAA-MM-DD (RFC 3339)

  • data no formato AAAA-MM-DD (RFC 3339)

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/funds/{cnpj}/nav
curl -i 'https://api.obm.com.br/v1/funds/08507696000159/nav' \
  -H "X-API-Key: ${OBM_API_KEY}"
{
  "data": [
    {
      "daily_deposits": 1250000,
      "date": "2026-10-23",
      "nav_per_share": 7.382156,
      "net_worth": 2456800000,
      "redemptions": 850000,
      "shareholder_count": 18450
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 100,
    "total": 1
  },
  "reference_date": "2026-10-23",
  "source": {
    "code": "cvm",
    "name": "Comissão de Valores Mobiliários",
    "url": "https://www.gov.br/cvm/pt-br"
  }
}

Ações

​

Use o código de negociação em maiúsculas: PETR4 em /v1/equities/{ticker} e AAPL34 em /v1/bdrs/{ticker}. A B3 fornece o histórico de negociação; dados societários e demonstrações usam também a CVM. Preços são de fechamento, com atualização diária após a publicação da fonte. Fundamentos seguem a divulgação das demonstrações, não a cadência dos preços.

Série base 100

Leia /v1/equities/PETR4/prices para consultar o histórico de negociação. Para comparar com proventos reinvestidos, use /v1/equities/PETR4/total-return, que traz total_return_rebased e benchmark_rebased em base 100. Confira series_basis: total_return indica proventos reinvestidos; close_adjusted indica que a série caiu para o fechamento ajustado.

curl 'https://api.obm.com.br/v1/equities/PETR4/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"

BDRs têm detalhe e preços em /v1/bdrs/AAPL34 e /v1/bdrs/AAPL34/prices. O preço negociado no Brasil não é a cotação da ação no exterior: moeda e proporção do recibo importam. BDR não tem /fundamentals nem /statements. Dias sem negociação podem produzir lacunas; não preencha uma lacuna com zero.

Bases dos preços e candles

Em /prices, close preserva o fechamento ajustado por desdobramentos, grupamentos e bonificações (close_basis: "close_adjusted"), sem reinvestimento de proventos. open, high e low são preços brutos B3 do pregão, sem esses ajustes. close_unadjusted traz o fechamento bruto na mesma base (ohlc_basis: "unadjusted").

Para montar candles, use open, high, low e close_unadjusted quando todos estiverem disponíveis. A relação low <= close_unadjusted <= high compara preços na mesma base; não a aplique a close. Campos nulos indicam ausência de dados: não substitua close_unadjusted por close nem preencha lacunas com zero. Os campos e valores anteriores de /v1 são preservados.

Listar ações

​

Lista as ações pelo ticker da B3, com filtros e paginação. Preços acompanham os fechamentos diários; os dados cadastrais seguem as publicações da B3 e da CVM.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Consulta

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/equities
curl 'https://api.obm.com.br/v1/equities?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "avg_volume_30d_brl": 1,
      "change_1d_ratio": 1,
      "dy_12m_ratio": 1,
      "instrument_type": "string",
      "latest_close": 1,
      "latest_date": "2026-11-18",
      "market_cap_brl": 1,
      "name": "string",
      "pvp_ratio": 1,
      "sector": "string",
      "segment": "string",
      "ticker": "string"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cadastro de uma ação

​

Devolve os dados da ação identificada pelo ticker em maiúsculas e os indicadores disponíveis. Cadastro e demonstrações vêm da B3 e da CVM; preços acompanham o fechamento diário.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/equities/{ticker}
curl -i 'https://api.obm.com.br/v1/equities/PETR4' \
  -H "X-API-Key: ${OBM_API_KEY}"
{
  "data": {
    "administrator": "string",
    "avg_volume_30d_brl": 1,
    "b3_segment": "string",
    "change_1d_ratio": 1,
    "cnpj": "string",
    "company_cnpj": "string",
    "company_name": "string",
    "currency_code": "string",
    "dy_12m_ratio": 1,
    "ev_ebitda": 1,
    "global_fee_ratio": 1,
    "instrument_type": "string",
    "isin": "string",
    "latest_close": 1,
    "latest_date": "2026-11-18",
    "listing_segment": "string",
    "manager": "string",
    "market_cap_brl": 1,
    "name": "string",
    "pl_ratio": 1,
    "pvp_ratio": 1,
    "sector": "string",
    "segment": "string",
    "subsector": "string",
    "ticker": "string"
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Proventos e eventos de uma ação

​

Lista os proventos e eventos societários publicados pela B3 para o ticker indicado. O histórico acompanha as divulgações dos eventos, com data ex e pagamento quando disponíveis.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • data no formato AAAA-MM-DD (RFC 3339)

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/equities/{ticker}/corporate-events
curl 'https://api.obm.com.br/v1/equities/{ticker}/corporate-events?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "event_type": "string",
      "ex_date": "2026-11-18",
      "payment_date": "2026-11-18",
      "ratio_from": 1,
      "ratio_to": 1,
      "value_per_share": 1
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Indicadores fundamentalistas de uma ação

​

Devolve os indicadores e suas séries calculados pelo OBM a partir das demonstrações da CVM para o ticker indicado. Os dados acompanham os períodos de divulgação das demonstrações, não os fechamentos diários.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/equities/{ticker}/fundamentals
curl 'https://api.obm.com.br/v1/equities/{ticker}/fundamentals?periods=12' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": {
    "items": [
      {
        "fiscal_period": "2026-11-18",
        "metric_code": "string",
        "value": 1
      }
    ],
    "series": [
      {
        "metric_code": "string",
        "points": [
          {
            "fiscal_period": "2026-11-18",
            "metric_code": "string",
            "value": 1
          }
        ]
      }
    ]
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cotações históricas de uma ação

​

Devolve o histórico diário de preços e volume da B3 para o ticker em maiúsculas. A série acompanha a publicação dos fechamentos e pode ser filtrada por período. close é o fechamento ajustado por desdobramentos, grupamentos e bonificações (close_basis=close_adjusted), sem reinvestimento de proventos. open, high, low e close_unadjusted são preços brutos B3 (ohlc_basis=unadjusted). Para candles, use close_unadjusted com open/high/low, quando disponíveis; não combine esses campos com close.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • data no formato AAAA-MM-DD (RFC 3339)

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/equities/{ticker}/prices
curl -i 'https://api.obm.com.br/v1/equities/PETR4/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"
{
  "data": [
    {
      "close": 38.45,
      "close_basis": "close_adjusted",
      "close_unadjusted": 38.45,
      "date": "2026-10-23",
      "high": 38.83,
      "low": 37.68,
      "ohlc_basis": "unadjusted",
      "open": 38.07,
      "volume_financial": 1082367500,
      "volume_shares": 28150000
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 100,
    "total": 1
  },
  "reference_date": "2026-10-23",
  "source": {
    "code": "b3",
    "name": "B3 S.A. — Brasil, Bolsa, Balcão",
    "url": "https://www.b3.com.br/pt_br/market-data-e-indices.htm"
  }
}

Demonstrações financeiras de uma ação

​

Devolve as demonstrações financeiras da CVM para a companhia vinculada ao ticker indicado. Os dados seguem as divulgações trimestrais e anuais e aceitam filtros por tipo e período.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/equities/{ticker}/statements
curl 'https://api.obm.com.br/v1/equities/{ticker}/statements?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "fiscal_quarter": 1,
      "fiscal_year": 1,
      "lines": [
        {
          "account_code": "string",
          "account_name": "string",
          "value": 1,
          "value_prev": 1
        }
      ],
      "reference_date": "2026-11-18",
      "report_type": "string",
      "source_url": "string",
      "value_scope": "string"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Retorno de uma ação em base 100

​

Devolve a série calculada pelo OBM para o ticker indicado, com benchmark quando disponível, a partir dos preços diários e eventos da B3. Leia series_basis: total_return indica proventos reinvestidos e close_adjusted indica o fechamento ajustado como alternativa.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • valores
    1y3y5ymax

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/equities/{ticker}/total-return
curl 'https://api.obm.com.br/v1/equities/{ticker}/total-return?period=1y' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": {
    "benchmark_code": "string",
    "change_window_ratio": 1,
    "points": [
      {
        "benchmark_rebased": 1,
        "close": 1,
        "date": "2026-11-18",
        "total_return_rebased": 1,
        "total_return_value": 1
      }
    ],
    "series_basis": "string",
    "ticker": "string"
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

BDRs

​

Use o código de negociação em maiúsculas, como AAPL34. Preços e dados de listagem vêm da B3; o histórico acompanha o fechamento diário do recibo negociado no Brasil. O preço não corresponde à cotação da ação no exterior: a moeda e a proporção do recibo afetam a comparação.

Consultar o histórico de um BDR

Leia o detalhe em /v1/bdrs/AAPL34 e consulte /v1/bdrs/AAPL34/prices para o histórico. Use start e end para limitar o período e percorra as páginas para obter a série inteira. AAPL34 está liberado na sandbox.

curl 'https://api.obm.com.br/v1/bdrs/AAPL34/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"

BDR não tem /fundamentals nem /statements. Dias sem negociação podem deixar lacunas no histórico.

Bases dos preços e candles

Em /prices, close preserva o fechamento ajustado por desdobramentos, grupamentos e bonificações (close_basis: "close_adjusted"), sem reinvestimento de proventos. open, high e low são preços brutos B3 do pregão, sem esses ajustes. close_unadjusted traz o fechamento bruto na mesma base (ohlc_basis: "unadjusted").

Para montar candles, use open, high, low e close_unadjusted quando todos estiverem disponíveis. A relação low <= close_unadjusted <= high compara preços na mesma base; não a aplique a close. Campos nulos indicam ausência de dados: não substitua close_unadjusted por close nem preencha lacunas com zero. Os campos e valores anteriores de /v1 são preservados.

Listar BDRs

​

Lista os BDRs pelo ticker da B3, com filtros e paginação. O cadastro acompanha as publicações da B3 e os preços seguem os fechamentos diários no Brasil.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Consulta

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/bdrs
curl 'https://api.obm.com.br/v1/bdrs?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "avg_volume_30d_brl": 1,
      "bdr_program_code": "string",
      "change_1d_ratio": 1,
      "dy_12m_ratio": 1,
      "instrument_type": "string",
      "latest_close": 1,
      "latest_date": "2026-11-18",
      "market_cap_brl": 1,
      "name": "string",
      "pvp_ratio": 1,
      "sector": "string",
      "segment": "string",
      "ticker": "string"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cadastro de um BDR

​

Devolve o cadastro e os indicadores disponíveis do BDR identificado pelo ticker em maiúsculas. A fonte é a B3 e os preços acompanham os fechamentos diários do recibo no Brasil.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/bdrs/{ticker}
curl -i 'https://api.obm.com.br/v1/bdrs/AAPL34' \
  -H "X-API-Key: ${OBM_API_KEY}"
{
  "data": {
    "administrator": "string",
    "avg_volume_30d_brl": 1,
    "bdr_ratio": 1,
    "change_1d_ratio": 1,
    "cnpj": "string",
    "currency_code": "string",
    "dy_12m_ratio": 1,
    "dy_basis": "string",
    "ev_ebitda": 1,
    "global_fee_ratio": 1,
    "instrument_type": "string",
    "isin": "string",
    "latest_close": 1,
    "latest_date": "2026-11-18",
    "manager": "string",
    "market_cap_brl": 1,
    "name": "string",
    "pl_ratio": 1,
    "pvp_ratio": 1,
    "sector": "string",
    "segment": "string",
    "ticker": "string",
    "underlying_ticker": "string"
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cotações históricas de um BDR

​

Devolve o histórico diário de preços e volume da B3 para o ticker do BDR em maiúsculas. Os valores correspondem ao recibo negociado no Brasil e acompanham a publicação dos fechamentos. close é o fechamento ajustado por desdobramentos, grupamentos e bonificações (close_basis=close_adjusted), sem reinvestimento de proventos. open, high, low e close_unadjusted são preços brutos B3 (ohlc_basis=unadjusted). Para candles, use close_unadjusted com open/high/low, quando disponíveis; não combine esses campos com close.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • data no formato AAAA-MM-DD (RFC 3339)

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/bdrs/{ticker}/prices
curl -i 'https://api.obm.com.br/v1/bdrs/AAPL34/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"
{
  "data": [
    {
      "close": 38.45,
      "close_basis": "close_adjusted",
      "close_unadjusted": 38.45,
      "date": "2026-10-23",
      "high": 38.83,
      "low": 37.68,
      "ohlc_basis": "unadjusted",
      "open": 38.07,
      "volume_financial": 1082367500,
      "volume_shares": 28150000
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 100,
    "total": 1
  },
  "reference_date": "2026-10-23",
  "source": {
    "code": "b3",
    "name": "B3 S.A. — Brasil, Bolsa, Balcão",
    "url": "https://www.b3.com.br/pt_br/market-data-e-indices.htm"
  }
}

FIIs

​

O código de negociação em maiúsculas identifica o fundo, como HGLG11. Preços vêm da B3 e são atualizados diariamente após a publicação do fechamento. Informes e dados dos imóveis usam documentos da CVM e têm a competência do informe, com cadência mensal ou trimestral conforme o conjunto. A data de referência de um informe pode diferir da última negociação.

Comparar rendimentos de FIIs

Liste /v1/fiis e leia dy_12m_ratio, o rendimento percentual de 12 meses calculado pelo OBM. Antes de comparar fundos, confira a referência do preço e os pagamentos em /v1/fiis/{ticker}/distributions. O detalhe de HGLG11 fica em /v1/fiis/HGLG11.

curl 'https://api.obm.com.br/v1/fiis/HGLG11/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"

ex_date é a data ex: quem tem a cota no pregão anterior recebe o rendimento. payment_date é quando o dinheiro cai. Um preço antigo pode distorcer o rendimento percentual de um fundo sem negociação recente; não trate imóvel ou vacância sem dado como zero. Para comparar outros códigos de negociação, use chave própria.

Bases dos preços e candles

Em /prices, close preserva o fechamento ajustado por desdobramentos, grupamentos e bonificações (close_basis: "close_adjusted"), sem reinvestimento de proventos. open, high e low são preços brutos B3 do pregão, sem esses ajustes. close_unadjusted traz o fechamento bruto na mesma base (ohlc_basis: "unadjusted").

Para montar candles, use open, high, low e close_unadjusted quando todos estiverem disponíveis. A relação low <= close_unadjusted <= high compara preços na mesma base; não a aplique a close. Campos nulos indicam ausência de dados: não substitua close_unadjusted por close nem preencha lacunas com zero. Os campos e valores anteriores de /v1 são preservados.

Listar FIIs

​

Lista os FIIs pelo ticker da B3, com preços e indicadores disponíveis. Preços acompanham o fechamento diário; os informes da CVM seguem suas competências de publicação.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Consulta

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/fiis
curl 'https://api.obm.com.br/v1/fiis?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "avg_volume_30d_brl": 1,
      "change_1d_ratio": 1,
      "dy_12m_ratio": 1,
      "instrument_type": "string",
      "latest_close": 1,
      "latest_date": "2026-11-18",
      "market_cap_brl": 1,
      "name": "string",
      "priced_count": 1,
      "pvp_ratio": 1,
      "sector": "string",
      "segment": "string",
      "ticker": "string",
      "traded_recently_count": 1
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cadastro de um FII

​

Devolve o cadastro e os indicadores disponíveis do FII identificado pelo ticker em maiúsculas. Preços vêm dos fechamentos diários da B3; dados patrimoniais acompanham os informes da CVM.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/fiis/{ticker}
curl -i 'https://api.obm.com.br/v1/fiis/HGLG11' \
  -H "X-API-Key: ${OBM_API_KEY}"
Exemplo ilustrativo

Valores ilustrativos; não são cotações atuais nem dados verificados do dia.

{
  "data": {
    "currency_code": "BRL",
    "dy_12m_ratio": 0.083,
    "latest_close": 158.75,
    "latest_date": "2026-10-23",
    "name": "PATRIA LOG FII",
    "net_worth_brl": 5300000000,
    "properties_count": 26,
    "ticker": "HGLG11"
  },
  "meta": null,
  "reference_date": "2026-10-23",
  "source": {
    "code": "b3",
    "name": "B3 S.A. — Brasil, Bolsa, Balcão",
    "url": "https://www.b3.com.br/pt_br/market-data-e-indices.htm"
  }
}

Rendimentos de um FII

​

Lista os rendimentos divulgados pela B3 para o ticker do FII, com ex_date e payment_date quando disponíveis. O histórico acompanha as divulgações de cada distribuição.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • Números inteiros.

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/fiis/{ticker}/distributions
curl 'https://api.obm.com.br/v1/fiis/{ticker}/distributions?months=12&page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "events_count": 1,
      "ex_date": "2026-11-18",
      "month": "2026-11-18",
      "payment_date": "2026-11-18",
      "value_per_share": 1
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cotações históricas de um FII

​

Devolve o histórico diário de preços e volume da B3 para o ticker do FII em maiúsculas. A série acompanha a publicação dos fechamentos e aceita filtros de período. close é o fechamento ajustado por desdobramentos, grupamentos e bonificações (close_basis=close_adjusted), sem reinvestimento de proventos. open, high, low e close_unadjusted são preços brutos B3 (ohlc_basis=unadjusted). Para candles, use close_unadjusted com open/high/low, quando disponíveis; não combine esses campos com close.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • data no formato AAAA-MM-DD (RFC 3339)

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/fiis/{ticker}/prices
curl -i 'https://api.obm.com.br/v1/fiis/HGLG11/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"
Exemplo ilustrativo

Valores ilustrativos; não são cotações atuais nem dados verificados do dia.

{
  "data": [
    {
      "close": 158.75,
      "close_basis": "close_adjusted",
      "close_unadjusted": 158.75,
      "date": "2026-10-23",
      "high": 160.34,
      "low": 155.57,
      "ohlc_basis": "unadjusted",
      "open": 157.16,
      "volume_financial": 13096875,
      "volume_shares": 82500
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 100,
    "total": 1
  },
  "reference_date": "2026-10-23",
  "source": {
    "code": "b3",
    "name": "B3 S.A. — Brasil, Bolsa, Balcão",
    "url": "https://www.b3.com.br/pt_br/market-data-e-indices.htm"
  }
}

Imóveis e inquilinos de um FII

​

Devolve os imóveis e inquilinos informados à CVM para o FII identificado pelo ticker em maiúsculas. Os dados seguem a competência dos informes trimestrais disponíveis.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/fiis/{ticker}/properties
curl 'https://api.obm.com.br/v1/fiis/{ticker}/properties' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": {
    "properties": [
      {
        "address": "string",
        "area_m2": 1,
        "name": "string",
        "property_class": "string",
        "revenue_share_ratio": 1,
        "units": 1,
        "vacancy_ratio": 1
      }
    ],
    "tenants": [
      {
        "revenue_share_ratio": 1,
        "sector": "string"
      }
    ]
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Informes mensais de um FII

​

Lista os informes mensais da CVM para o FII identificado pelo ticker em maiúsculas. Cada registro traz a competência do informe e acompanha sua publicação na fonte.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • data no formato AAAA-MM-DD (RFC 3339)

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/fiis/{ticker}/reports
curl 'https://api.obm.com.br/v1/fiis/{ticker}/reports?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "distribution_payment_date": "2026-11-18",
      "distribution_per_share": 1,
      "dy_month_ratio": 1,
      "net_worth_brl": 1,
      "reference_month": "2026-11-18",
      "shareholder_count": 1,
      "shares_outstanding": 1
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

ETFs

​

Use o código de negociação da B3 em maiúsculas, como BOVA11. Preços e listagem vêm da B3, com fechamento diário. A carteira vem da CVM e tem a data da última publicação, que costuma ser anterior ao último preço.

Comparar o ETF com o índice

Consulte /v1/etfs/BOVA11 para identificar o índice de referência e /v1/etfs/BOVA11/prices para a série. Com chave própria, leia também /v1/indices/IBOV/prices no mesmo intervalo. Use só as datas presentes nas duas séries. O detalhe traz reference_index e tracking_error_12m_ratio, calculado pelo OBM.

curl 'https://api.obm.com.br/v1/etfs/BOVA11/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"

Preço da cota em bolsa difere do valor patrimonial. Taxas e dividendos afetam a comparação com o índice; não conclua erro de aderência a partir de dois fechamentos isolados. /v1/etfs/BOVA11/portfolio mostra a última carteira publicada. Campo nulo é dado ausente, não zero.

Bases dos preços e candles

Em /prices, close preserva o fechamento ajustado por desdobramentos, grupamentos e bonificações (close_basis: "close_adjusted"), sem reinvestimento de proventos. open, high e low são preços brutos B3 do pregão, sem esses ajustes. close_unadjusted traz o fechamento bruto na mesma base (ohlc_basis: "unadjusted").

Para montar candles, use open, high, low e close_unadjusted quando todos estiverem disponíveis. A relação low <= close_unadjusted <= high compara preços na mesma base; não a aplique a close. Campos nulos indicam ausência de dados: não substitua close_unadjusted por close nem preencha lacunas com zero. Os campos e valores anteriores de /v1 são preservados.

Listar ETFs

​

Lista os ETFs pelo ticker da B3, com o índice de referência disponível. O cadastro acompanha as publicações da B3 e os preços seguem os fechamentos diários.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Consulta

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/etfs
curl 'https://api.obm.com.br/v1/etfs?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "avg_volume_30d_brl": 1,
      "change_1d_ratio": 1,
      "dy_12m_ratio": 1,
      "etf_class_code": "string",
      "etf_class_label": "string",
      "instrument_type": "string",
      "latest_close": 1,
      "latest_date": "2026-11-18",
      "market_cap_brl": 1,
      "name": "string",
      "pvp_ratio": 1,
      "reference_index": "string",
      "sector": "string",
      "segment": "string",
      "ticker": "string"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cadastro de um ETF

​

Devolve o cadastro do ETF identificado pelo ticker em maiúsculas e os indicadores disponíveis no OBM. Os dados de listagem vêm da B3 e os indicadores de preço acompanham os fechamentos diários.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/etfs/{ticker}
curl -i 'https://api.obm.com.br/v1/etfs/BOVA11' \
  -H "X-API-Key: ${OBM_API_KEY}"
Exemplo ilustrativo

Valores ilustrativos; não são cotações atuais nem dados verificados do dia.

{
  "data": {
    "currency_code": "BRL",
    "latest_close": 128.4,
    "latest_date": "2026-10-23",
    "name": "ISHARES IBOVESPA FUNDO DE ÍNDICE",
    "reference_index": "IBOV",
    "ticker": "BOVA11",
    "tracking_error_12m_ratio": 0.0025
  },
  "meta": null,
  "reference_date": "2026-10-23",
  "source": {
    "code": "b3",
    "name": "B3 S.A. — Brasil, Bolsa, Balcão",
    "url": "https://www.b3.com.br/pt_br/market-data-e-indices.htm"
  }
}

Carteira de um ETF

​

Devolve a última carteira disponível na CVM para o ETF identificado pelo ticker em maiúsculas. A referência é a data da publicação da carteira, que pode ser anterior ao último fechamento.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/etfs/{ticker}/portfolio
curl 'https://api.obm.com.br/v1/etfs/{ticker}/portfolio?top_n=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": {
    "net_worth_brl": 1,
    "positions": [
      {
        "asset_class": "string",
        "name": "string",
        "ticker": "string",
        "value_brl": 1,
        "weight_ratio": 1
      }
    ],
    "positions_count": 1,
    "reference_date": "2026-11-18"
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cotações históricas de um ETF

​

Devolve o histórico diário de preços e volume da B3 para o ticker do ETF em maiúsculas. A série acompanha a publicação dos fechamentos e aceita filtros de período. close é o fechamento ajustado por desdobramentos, grupamentos e bonificações (close_basis=close_adjusted), sem reinvestimento de proventos. open, high, low e close_unadjusted são preços brutos B3 (ohlc_basis=unadjusted). Para candles, use close_unadjusted com open/high/low, quando disponíveis; não combine esses campos com close.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • data no formato AAAA-MM-DD (RFC 3339)

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/etfs/{ticker}/prices
curl -i 'https://api.obm.com.br/v1/etfs/BOVA11/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"
Exemplo ilustrativo

Valores ilustrativos; não são cotações atuais nem dados verificados do dia.

{
  "data": [
    {
      "close": 128.4,
      "close_basis": "close_adjusted",
      "close_unadjusted": 128.4,
      "date": "2026-10-23",
      "high": 129.68,
      "low": 125.83,
      "ohlc_basis": "unadjusted",
      "open": 127.12,
      "volume_financial": 668964000,
      "volume_shares": 5210000
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 100,
    "total": 1
  },
  "reference_date": "2026-10-23",
  "source": {
    "code": "b3",
    "name": "B3 S.A. — Brasil, Bolsa, Balcão",
    "url": "https://www.b3.com.br/pt_br/market-data-e-indices.htm"
  }
}

Índices

​

O identificador é o código B3 em maiúsculas, como IBOV. A B3 é a fonte de pontos e composição. Pontos acompanham os fechamentos diários; a composição muda nos rebalanceamentos publicados pela B3. A data da carteira não precisa ser a data do último ponto.

Composição do IBOV

Com uma chave própria, consulte o detalhe em /v1/indices/IBOV e os componentes em /v1/indices/IBOV/components. Para reconstruir uma carteira histórica, passe as_of=AAAA-MM-DD e leia effective_from e effective_to de cada componente. Compare com /v1/indices/IBOV/prices para obter os pontos do período.

curl 'https://api.obm.com.br/v1/indices/IBOV/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"

A sandbox não libera índices: detalhe, preços e componentes retornam 403, e /v1/indices volta vazia com código 200. Pesos são frações canônicas, não percentuais inteiros. Não aplique a composição atual a toda a série histórica; isso introduz viés de sobrevivência. Se não vier carteira para a data pedida, a base não cobre essa data; o índice não estava vazio.

Listar índices

​

Lista os índices da B3 por código, como IBOV, com o último fechamento disponível. Os pontos acompanham a publicação dos fechamentos diários.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Consulta

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/indices
curl 'https://api.obm.com.br/v1/indices?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "change_1d_ratio": 1,
      "code": "string",
      "family": "string",
      "latest_close": 1,
      "latest_date": "2026-11-18",
      "name": "string"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Detalhes de um índice

​

Devolve os dados do índice da B3 identificado pelo código em maiúsculas, como IBOV. Os valores acompanham os fechamentos diários disponíveis.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

O formulário de teste com a chave sandbox devolve 403 aqui; use a sua chave.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/indices/{code}
curl -i 'https://api.obm.com.br/v1/indices/IBOV' \
  -H "X-API-Key: ${OBM_API_KEY}"
Exemplo ilustrativo

Valores ilustrativos; não são cotações atuais nem dados verificados do dia.

{
  "data": {
    "change_1d_ratio": 0.0085,
    "code": "IBOV",
    "components_count": 85,
    "family": "B3",
    "latest_close": 135200.45,
    "latest_date": "2026-10-23",
    "name": "IBOVESPA"
  },
  "meta": null,
  "reference_date": "2026-10-23",
  "source": {
    "code": "b3",
    "name": "B3 S.A. — Brasil, Bolsa, Balcão",
    "url": "https://www.b3.com.br/pt_br/market-data-e-indices.htm"
  }
}

Composição de um índice

​

Lista os componentes e pesos do índice da B3 identificado pelo código em maiúsculas. A carteira acompanha os rebalanceamentos publicados; as_of permite consultar a composição disponível em uma data.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/indices/{code}/components
curl 'https://api.obm.com.br/v1/indices/{code}/components?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "change_1d_ratio": 1,
      "effective_from": "2026-11-18",
      "effective_to": "2026-11-18",
      "name": "string",
      "ticker": "string",
      "weight_ratio": 1
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Altas e baixas de um índice

​

Devolve as maiores altas e baixas dos componentes do índice da B3 identificado pelo código em maiúsculas. Os movimentos usam os preços diários disponíveis, sem cotação em tempo real.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Caminho

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/indices/{code}/movers
curl 'https://api.obm.com.br/v1/indices/{code}/movers' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": {
    "as_of": "2026-11-18",
    "gainers": [
      {
        "change_1d_ratio": 1,
        "effective_from": "2026-11-18",
        "effective_to": "2026-11-18",
        "name": "string",
        "ticker": "string",
        "weight_ratio": 1
      }
    ],
    "losers": [
      {
        "change_1d_ratio": 1,
        "effective_from": "2026-11-18",
        "effective_to": "2026-11-18",
        "name": "string",
        "ticker": "string",
        "weight_ratio": 1
      }
    ]
  },
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Cotações históricas de um índice

​

Devolve o histórico diário de pontos da B3 para o código do índice em maiúsculas. A série acompanha os fechamentos publicados e aceita filtros de período.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

O formulário de teste com a chave sandbox devolve 403 aqui; use a sua chave.

Parâmetros de Caminho

Parâmetros de Consulta

  • data no formato AAAA-MM-DD (RFC 3339)

  • data no formato AAAA-MM-DD (RFC 3339)

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/indices/{code}/prices
curl -i 'https://api.obm.com.br/v1/indices/IBOV/prices' \
  -H "X-API-Key: ${OBM_API_KEY}"
{
  "data": [
    {
      "date": "2026-10-23",
      "is_projected": false,
      "value": 135200.45
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 100,
    "total": 1
  },
  "reference_date": "2026-10-23",
  "source": {
    "code": "b3",
    "name": "B3 S.A. — Brasil, Bolsa, Balcão",
    "url": "https://www.b3.com.br/pt_br/market-data-e-indices.htm"
  }
}

Busca

​

Busque por nome, ticker ou CNPJ com q. A busca respeita o plano da chave.

Busca Operações

Fontes

​

Consulte a origem dos dados e a cadência de publicação em /v1/sources.

Fontes Operações

Situação da API e dos dados

​

Devolve a situação da API e as últimas datas de referência por classe no OBM. As datas acompanham os dados da CVM e da B3 incorporados à base; esta consulta não exige chave.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/status
curl https://api.obm.com.br/status \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "datasets": [
    {
      "business_days_late": 0,
      "dataset": "string",
      "expected_cadence": {
        "code": "string",
        "label": "string"
      },
      "label": "string",
      "reference_date": "2026-11-18",
      "source": {
        "code": "string",
        "name": "string",
        "url": "string"
      },
      "state": "on_time",
      "state_reason": "string"
    }
  ],
  "reference_dates": {
    "additionalProperty": "2026-11-18"
  },
  "status": "string"
}

Fontes dos dados

​

Lista as fontes do catálogo do OBM, identificadas por código, com atribuição e condições de uso. O catálogo acompanha as atualizações da documentação de cada fonte.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Parâmetros de Consulta

  • Números inteiros.

  • Números inteiros.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/sources
curl 'https://api.obm.com.br/v1/sources?page=1&page_size=100' \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "data": [
    {
      "cadence": "string",
      "code": "string",
      "credit": "string",
      "license": "string",
      "name": "string",
      "publication": "string",
      "url": "string"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 1,
    "total": 0
  },
  "reference_date": "2026-11-18",
  "source": {
    "code": "string",
    "name": "string",
    "url": "string"
  }
}

Conta

​

Consulte o plano e o uso agregado da sua chave em /v1/me.

Conta Operações

Plano e uso da sua conta

​

Devolve o plano da chave autenticada no OBM e o uso agregado de todas as chaves e clientes da conta no mês civil UTC. O prefixo identifica a chave usada nesta chamada. O contador é gravado em lotes e pode chegar alguns instantes atrasado.

Cabeçalhos nas respostas autenticadas:

  • X-RateLimit-Limit: Limite por minuto; unlimited indica ausência de limite.
  • X-RateLimit-Remaining: Saldo por minuto; unlimited indica ausência de limite.
  • X-Quota-Limit: Cota mensal; plano sem limite: o cabeçalho X-Quota-* não é enviado.
  • X-Quota-Remaining: Saldo mensal; só em planos com cota.
  • X-Quota-Reset: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.

Em 429, Retry-After informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.

Respostas

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
Request Example for get/v1/me
curl https://api.obm.com.br/v1/me \
  --header 'X-API-Key: obm_sandbox_DhGmljxJPyBnNQRQzXnmsZw4RalGFDvV'
{
  "client_id": "123e4567-e89b-12d3-a456-426614174000",
  "key_id": "123e4567-e89b-12d3-a456-426614174000",
  "key_prefix": "string",
  "month": "2026-11-18",
  "monthly_quota": 1,
  "plan": "string",
  "rate_per_minute": 1,
  "usage": [
    {
      "error_count": 1,
      "request_count": 1,
      "route_group": "string"
    }
  ]
}