{
  "info": {
    "name": "OBM API",
    "description": "# Primeira chamada\n\nA API do OBM responde em `https://api.obm.com.br`. Para testar, copie a chave `sandbox` preenchida no campo de autenticação da documentação e defina `OBM_API_KEY` no seu terminal. A chave pública só abre os ativos de exemplo. Para usar a API no seu produto, peça uma chave própria.\n\n```sh\ncurl -i 'https://api.obm.com.br/v1/equities/PETR4/prices' \\\n  -H \"X-API-Key: ${OBM_API_KEY}\"\n```\n\nO corpo da resposta tem esta estrutura:\n\n```json\n{\n  \"data\": [],\n  \"reference_date\": null,\n  \"source\": {\"code\": \"b3\", \"name\": \"B3 S.A. — Brasil, Bolsa, Balcão\", \"url\": \"https://www.b3.com.br/pt_br/market-data-e-indices.htm\"},\n  \"meta\": {\"page\": 1, \"page_size\": 100, \"total\": 0}\n}\n```\n\nOs quatro campos da resposta:\n\n- `data`: o objeto ou a lista pedida.\n- `reference_date`: a data do dado, não a hora da chamada. Vem nula quando não há observação.\n- `source`: de onde o dado veio.\n- `meta`: paginação, só nas listas.\n\nUse `page` e `page_size` para percorrer a série; o máximo por página é 200. Preços são números, datas seguem ISO 8601 e campos desconhecidos devem ser ignorados pelo cliente.\n\nNa `sandbox`, acompanhe `X-RateLimit-Remaining` nos cabeçalhos; as respostas não incluem `X-Quota-*`. Com uma chave própria, `X-Quota-Remaining` também informa quanto resta da cota mensal da conta, em mês civil UTC; a free tem ainda teto de 200 chamadas por dia UTC. 401 quer dizer chave ausente ou inválida. 403 quer dizer que a chave é válida mas não tem acesso, o que inclui ativo fora da `sandbox`. Em 429, aguarde o intervalo de `Retry-After` antes de repetir.\n\nA `sandbox` permite 10 chamadas por minuto por IP do visitante. Exemplos liberados: PETR4, HGLG11, BOVA11, AAPL34 e o CNPJ 08507696000159. Índices ficam disponíveis com chave própria. Consulte `/v1/sources` para as fontes e `/status` para as datas de referência disponíveis.\n\n## Postman, Insomnia e Bruno\n\nBaixe a collection em `https://api.obm.com.br/postman.json` e importe o arquivo no Postman, Insomnia ou Bruno. O formato é o Postman v2.1, que os três leem.\n\nDepois de importar, preencha a variável `apiKey` da collection com a sua chave. A `sandbox` já vem pronta na documentação. A variável `baseUrl` aponta para `https://api.obm.com.br`. Cada pasta reúne as operações de uma classe de ativo. Os exemplos usam identificadores liberados na `sandbox`, exceto Índices e a série dedicada de classe de fundo, que exigem chave própria. As respostas autenticadas devolvem `X-RateLimit-Limit` e `X-RateLimit-Remaining`; o teste da collection confere o status 2xx e o cabeçalho de limite. Nos exemplos restritos, a `sandbox` valida o 403 esperado; com chave própria, o exemplo de classe também exige observações em `points`.\n\nSe a verificação de consumo estiver indisponível, a API devolve 503 com `Retry-After`, sem liberar chamadas ilimitadas.\n\n# Autenticação\n\nEnvie a chave em um dos cabeçalhos:\n\n```http\nAuthorization: Bearer <sua-chave>\n```\n\n```http\nX-API-Key: <sua-chave>\n```\n\nSe enviar os dois, `Authorization` prevalece. Não coloque a chave na URL. As rotas de dados exigem autenticação; `/status`, `/openapi.json`, `/llms.txt` e `/llms-full.txt` são públicos. A documentação fica em `/docs`.\n\nChaves de uso próprio têm prefixo `obm_live_`, seguido de 32 caracteres `base62` (letras e dígitos). A `sandbox` usa `obm_sandbox_` com o mesmo comprimento de sufixo. `obm_test_` está reservado. O OBM armazena apenas o resumo criptográfico SHA-256; a chave completa aparece uma vez na emissão. `/v1/me` informa o prefixo, o plano e o uso agregado.\n\nQuem emite e rotaciona chaves é a equipe do OBM. Na rotação, a chave nova sai e a anterior para de funcionar no mesmo instante, sem período em que as duas valem. Troque a credencial da integração assim que receber a nova. Chave revogada retorna 403. A chave `sandbox` preenchida no formulário de teste é pública e restrita aos exemplos; use uma chave própria fora da documentação.\n\n# Limites e erros\n\nA `sandbox` permite 10 chamadas por minuto por IP do visitante. Nos demais planos, os limites são por conta vinculada; clientes sem conta usam seu identificador de cliente. Chaves em rotação e troca de cliente da mesma conta compartilham o orçamento.\n\n| Plano | Chamadas por minuto | Chamadas por dia | Chamadas por mês |\n| --- | ---: | ---: | ---: |\n| `sandbox` | 10 por IP | Sem limite | Sem limite |\n| `free` | 10 por conta | 200 | 3.000 |\n| `beta` | 60 por conta | Sem limite | 20.000 |\n\nO plano `beta` é gratuito até 31/12/2026. A partir de 2027 o plano muda, com aviso por e-mail de 30 dias de antecedência. A reivindicação da beta substitui a free e preserva o consumo anterior da conta.\n\nO plano `sandbox` aceita apenas PETR4, HGLG11, BOVA11, AAPL34 e o fundo 08507696000159. Listagens e busca respeitam essa restrição; a consulta direta a outro ativo retorna 403.\n\nRespostas autenticadas trazem `X-RateLimit-Limit` e `X-RateLimit-Remaining` para a janela por minuto. Na `sandbox`, essa janela é por IP e as respostas não incluem cabeçalhos `X-Quota-*`.\n\n`X-Quota-Limit` e `X-Quota-Remaining` descrevem a cota mensal; `X-Quota-Reset` informa seu reinício em ISO 8601 UTC. Dia e mês são civis em UTC. O teto diário também é verificado antes de executar a chamada. Uma unidade é consumida por resposta autenticada admitida menor que 500 e diferente de 429; os outros 4xx contam. O uso agregado de todas as chaves e clientes da conta fica em `/v1/me`, inclusive o histórico de clientes substituídos. O contador é gravado em lotes, então esse número pode chegar alguns instantes atrasado.\n\nErros usam `Content-Type: application/problem+json`, conforme RFC 9457. Leia `status` e `detail`; `instance` identifica o caminho da chamada. `X-Request-Id` correlaciona a resposta com o log da API.\n\n| Código HTTP | Causa | Ação |\n| --- | --- | --- |\n| 401 | Chave ausente ou inválida | Confira o cabeçalho e a credencial. |\n| 403 | Chave revogada, expirada, cliente bloqueado, plano inativo ou conjunto de dados ou ativo não permitido | Confira o plano; na `sandbox`, use um dos exemplos. |\n| 404 | Identificador ou recurso não encontrado | Confirme o código de negociação, código ou CNPJ. |\n| 422 | Parâmetro inválido | Corrija o formato ou intervalo indicado no erro. |\n| 429 | Limite por minuto ou cota diária/mensal esgotada | Aguarde `Retry-After`, em segundos. |\n| 503 | Serviço de verificação de consumo indisponível | Aguarde `Retry-After` antes de tentar novamente; a chamada não é liberada sem verificação. |\n\nEm 429 por cota diária, `Retry-After` aponta a espera até o próximo dia UTC. Por cota mensal, `X-Quota-Remaining` é zero e a espera termina no próximo mês UTC. Por frequência, o intervalo corresponde à janela por minuto: por IP na `sandbox` e por conta nos demais planos. Não repita a chamada na hora. Enquanto o `Cache-Control` da resposta valer, use o que já recebeu.\n\n# Versionamento e deprecação\n\nA versão principal vai na URL: `/v1`. Não há versão por data nem cabeçalho de versão.\n\nAdicionar rota, campo opcional de resposta ou parâmetro opcional é compatível. Uma enumeração explicitamente aberta pode receber valores novos. Ignore campos desconhecidos ao desserializar e trate os valores abertos sem presumir uma lista fechada.\n\nRemover ou renomear campo ou rota, mudar tipo ou semântica, exigir parâmetro antes opcional ou restringir uma enumeração quebra o contrato. Mudança desse tipo só sai em `/v2`.\n\nUma rota depreciada vai receber os cabeçalhos `Deprecation` (data no formato estruturado da RFC 9745) e `Sunset` (data HTTP da RFC 8594). A mudança entra nas [Novidades da API](https://obm.com.br/novidades). A janela de migração tem no mínimo seis meses com as duas versões servidas. A rota antiga só é desligada depois da data de `Sunset`, que é o seu prazo para migrar.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "_postman_id": "617a3054-cf1b-4015-ad1d-5067e323e4e0"
  },
  "item": [
    {
      "id": "ee3cb94a-339d-496b-856d-1655719d4256",
      "name": "Fundos",
      "description": "# Fundos\n\nO 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.\n\n## Comparar dois fundos\n\nConsulte `/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.\n\n```sh\ncurl 'https://api.obm.com.br/v1/funds/08507696000159/nav' \\\n  -H \"X-API-Key: ${OBM_API_KEY}\"\n```\n\nO 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.\n\n## Séries de classes e subclasses\n\nDepois 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.\n\nQuando `points` está vazio, `missing_reason` distingue:\n\n- `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.\n- `no_observations`: há identidade de série, mas nenhuma observação armazenada.\n- `no_observations_in_range`: há observações, mas nenhuma no intervalo solicitado.\n\nCom 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.\n\nExemplo com série dedicada, usado na collection (exige chave própria):\n\n```sh\ncurl 'https://api.obm.com.br/v1/funds/18537348000188/classes/18537348000188/series?start=2026-10-01&end=2026-11-06' \\\n  -H \"X-API-Key: ${OBM_API_KEY}\"\n```\n\nEm 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.",
      "item": [
        {
          "id": "78ac3ed9-2ae0-40c3-af53-811c67442e00",
          "name": "Listar Fundos",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/funds",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "funds"
              ],
              "query": [
                {
                  "key": "type",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "class",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "manager",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "q",
                  "value": "PETR4",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "7ac4279d-e062-4d0c-bfc4-3c2c6163c766",
          "name": "Ranking anual de Fundos",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/funds/ranking",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "funds",
                "ranking"
              ],
              "query": [
                {
                  "key": "year",
                  "value": "2026",
                  "description": "",
                  "disabled": false
                },
                {
                  "key": "type",
                  "value": "",
                  "description": "Only FI ranking is available; FIDC and FIP return 422: ranking not available for this type.",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "625ff2a9-30de-43be-aad3-e919e37af486",
          "name": "Cadastro de um fundo",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/funds/:cnpj",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "funds",
                ":cnpj"
              ],
              "variable": [
                {
                  "key": "cnpj",
                  "value": "08507696000159",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "865cd2fd-e98c-43d2-99e5-ba3a4cd7ec82",
          "name": "Cotas históricas de um fundo",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/funds/:cnpj/nav",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "funds",
                ":cnpj",
                "nav"
              ],
              "variable": [
                {
                  "key": "cnpj",
                  "value": "08507696000159",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "start",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "end",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "195a1a0c-140f-4628-9d25-f4b99d7a6895",
          "name": "Métricas de um fundo",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/funds/:cnpj/metrics",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "funds",
                ":cnpj",
                "metrics"
              ],
              "variable": [
                {
                  "key": "cnpj",
                  "value": "08507696000159",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "7ec4bfa3-7650-47c2-8f10-6bc8671c8274",
          "name": "Retornos mensais de um fundo",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/funds/:cnpj/monthly-returns",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "funds",
                ":cnpj",
                "monthly-returns"
              ],
              "variable": [
                {
                  "key": "cnpj",
                  "value": "08507696000159",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "years",
                  "value": "5",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "7720dd29-03dd-4dfb-81e6-a24651c6df3e",
          "name": "Classes de um fundo",
          "description": "Lista as classes e subclasses RCVM 175 do fundo identificado pelo CNPJ. A estrutura e as taxas acompanham as publicações cadastrais da CVM.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/funds/:cnpj/classes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "funds",
                ":cnpj",
                "classes"
              ],
              "variable": [
                {
                  "key": "cnpj",
                  "value": "08507696000159",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "0a641356-8bbd-4cc1-a922-d1d46c75caf2",
          "name": "Cotas históricas de uma classe",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.\n\nExige chave própria; a chave sandbox recebe 403.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/funds/:cnpj/classes/:class_cnpj/series",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "funds",
                ":cnpj",
                "classes",
                ":class_cnpj",
                "series"
              ],
              "variable": [
                {
                  "key": "class_cnpj",
                  "value": "18537348000188",
                  "description": ""
                },
                {
                  "key": "cnpj",
                  "value": "18537348000188",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "subclass",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "start",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "end",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": [],
          "event": [
            {
              "listen": "test",
              "script": {
                "type": "text/javascript",
                "exec": [
                  "const sandbox = (pm.variables.get(\"apiKey\") || \"\").startsWith(\"obm_sandbox_\");",
                  "const ownKeyPath = pm.request.url.getPath().startsWith(\"/v1/indices/\") || pm.request.url.getPath().startsWith(\"/v1/funds/18537348000188/\");",
                  "if (sandbox && ownKeyPath) {",
                  "  pm.test(\"403 sem chave própria\", function () {",
                  "    pm.expect(pm.response.code).to.eql(403);",
                  "  });",
                  "}",
                  "if (!sandbox && pm.response.code === 200) {",
                  "  pm.test(\"Série com observações\", function () {",
                  "    pm.expect(pm.response.json().data.points.length).to.be.above(0);",
                  "  });",
                  "}"
                ]
              }
            }
          ]
        },
        {
          "id": "45e8cfe7-ecde-4251-9075-72f1c4b3255f",
          "name": "Documentos de um fundo",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/funds/:cnpj/documents",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "funds",
                ":cnpj",
                "documents"
              ],
              "variable": [
                {
                  "key": "cnpj",
                  "value": "08507696000159",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        }
      ]
    },
    {
      "id": "ba48aa4e-a281-4dbc-b936-be08764a1c92",
      "name": "Ações",
      "description": "# Ações e BDRs\n\nUse 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.\n\n## Série base 100\n\nLeia `/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.\n\n```sh\ncurl 'https://api.obm.com.br/v1/equities/PETR4/prices' \\\n  -H \"X-API-Key: ${OBM_API_KEY}\"\n```\n\nBDRs 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.\n\n## Bases dos preços e candles\n\nEm `/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\"`).\n\nPara 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.",
      "item": [
        {
          "id": "842030e7-758f-4bee-89d7-7cb5c87e8988",
          "name": "Listar ações",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/equities",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "equities"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "PETR4",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "sector",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "type",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "61e25ff4-67b8-4b95-ab3f-6174440a4d35",
          "name": "Cadastro de uma ação",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/equities/:ticker",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "equities",
                ":ticker"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "PETR4",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "f571314d-a91a-4fc6-b883-74af61ee725a",
          "name": "Cotações históricas de uma ação",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/equities/:ticker/prices",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "equities",
                ":ticker",
                "prices"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "PETR4",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "start",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "end",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "cab5e9f2-41ac-4134-99ae-6ce8f39397fc",
          "name": "Retorno de uma ação em base 100",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/equities/:ticker/total-return",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "equities",
                ":ticker",
                "total-return"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "PETR4",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "period",
                  "value": "1y",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "a7c94d5c-0edb-455e-8bc2-a626fa19a4b6",
          "name": "Indicadores fundamentalistas de uma ação",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/equities/:ticker/fundamentals",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "equities",
                ":ticker",
                "fundamentals"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "PETR4",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "periods",
                  "value": "12",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "92a06119-7f72-412b-ab83-0b213cac794f",
          "name": "Proventos e eventos de uma ação",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/equities/:ticker/corporate-events",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "equities",
                ":ticker",
                "corporate-events"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "PETR4",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "start",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "end",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "86f9b3c9-dfd5-42ac-85c3-a7f0cb4fd830",
          "name": "Demonstrações financeiras de uma ação",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/equities/:ticker/statements",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "equities",
                ":ticker",
                "statements"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "PETR4",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "type",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "period",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        }
      ]
    },
    {
      "id": "c4aea1d5-44e0-4260-b2d8-bd84fc248d80",
      "name": "BDRs",
      "description": "# BDRs\n\nUse 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.\n\n## Consultar o histórico de um BDR\n\nLeia 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`.\n\n```sh\ncurl 'https://api.obm.com.br/v1/bdrs/AAPL34/prices' \\\n  -H \"X-API-Key: ${OBM_API_KEY}\"\n```\n\nBDR não tem `/fundamentals` nem `/statements`. Dias sem negociação podem deixar lacunas no histórico.\n\n## Bases dos preços e candles\n\nEm `/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\"`).\n\nPara 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.",
      "item": [
        {
          "id": "12754e62-25e5-48f6-bfff-73945ee0121b",
          "name": "Listar BDRs",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/bdrs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "bdrs"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "PETR4",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "program",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "0d620da8-e6d5-417a-8571-99aff45210db",
          "name": "Cadastro de um BDR",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/bdrs/:ticker",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "bdrs",
                ":ticker"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "AAPL34",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "c1f2e1fc-8ea5-456b-bb43-c0b5ef6873d7",
          "name": "Cotações históricas de um BDR",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/bdrs/:ticker/prices",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "bdrs",
                ":ticker",
                "prices"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "AAPL34",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "start",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "end",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        }
      ]
    },
    {
      "id": "4b0cf45b-8688-4f93-8d0b-e86cb9bce425",
      "name": "FIIs",
      "description": "# FIIs\n\nO 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.\n\n## Comparar rendimentos de FIIs\n\nListe `/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`.\n\n```sh\ncurl 'https://api.obm.com.br/v1/fiis/HGLG11/prices' \\\n  -H \"X-API-Key: ${OBM_API_KEY}\"\n```\n\n`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.\n\n## Bases dos preços e candles\n\nEm `/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\"`).\n\nPara 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.",
      "item": [
        {
          "id": "ba271757-12a3-4163-bda8-050626b3afd5",
          "name": "Listar FIIs",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/fiis",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "fiis"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "PETR4",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "segment",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "type",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "1f264ab8-ab61-4e21-87d6-ec8eb57a8c20",
          "name": "Cadastro de um FII",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/fiis/:ticker",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "fiis",
                ":ticker"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "HGLG11",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "21d4e010-4402-4f7d-b44a-c84d99a2a4b3",
          "name": "Cotações históricas de um FII",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/fiis/:ticker/prices",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "fiis",
                ":ticker",
                "prices"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "HGLG11",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "start",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "end",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "52085333-a83f-4e47-9d11-c33f92ad2ca2",
          "name": "Rendimentos de um FII",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/fiis/:ticker/distributions",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "fiis",
                ":ticker",
                "distributions"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "HGLG11",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "months",
                  "value": "12",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "7fcf1260-52c2-47a0-a917-46bf303944f2",
          "name": "Imóveis e inquilinos de um FII",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/fiis/:ticker/properties",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "fiis",
                ":ticker",
                "properties"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "HGLG11",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "286e725a-3bf2-490b-8f6d-a713765360b2",
          "name": "Informes mensais de um FII",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/fiis/:ticker/reports",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "fiis",
                ":ticker",
                "reports"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "HGLG11",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "start",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "end",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        }
      ]
    },
    {
      "id": "6beed93b-4b05-4e88-9996-89085d6bb45b",
      "name": "ETFs",
      "description": "# ETFs\n\nUse 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.\n\n## Comparar o ETF com o índice\n\nConsulte `/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.\n\n```sh\ncurl 'https://api.obm.com.br/v1/etfs/BOVA11/prices' \\\n  -H \"X-API-Key: ${OBM_API_KEY}\"\n```\n\nPreç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.\n\n## Bases dos preços e candles\n\nEm `/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\"`).\n\nPara 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.",
      "item": [
        {
          "id": "f39b9c69-2b6e-4ad1-963a-7ae5f760d74d",
          "name": "Listar ETFs",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/etfs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "etfs"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "PETR4",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "class",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "75e04223-293c-4fa9-bcf3-5f7fa7ec7431",
          "name": "Cadastro de um ETF",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/etfs/:ticker",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "etfs",
                ":ticker"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "BOVA11",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "c6f034e8-869b-4662-96b9-8a169e8aad92",
          "name": "Cotações históricas de um ETF",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/etfs/:ticker/prices",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "etfs",
                ":ticker",
                "prices"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "BOVA11",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "start",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "end",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "1dd9f99a-0bb8-45e2-a375-f9c9be20a18c",
          "name": "Carteira de um ETF",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/etfs/:ticker/portfolio",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "etfs",
                ":ticker",
                "portfolio"
              ],
              "variable": [
                {
                  "key": "ticker",
                  "value": "BOVA11",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "top_n",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        }
      ]
    },
    {
      "id": "4a500938-8edb-4940-9c77-35ee9db0cfed",
      "name": "Índices",
      "description": "# Índices\n\nO 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.\n\n## Composição do IBOV\n\nCom 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.\n\n```sh\ncurl 'https://api.obm.com.br/v1/indices/IBOV/prices' \\\n  -H \"X-API-Key: ${OBM_API_KEY}\"\n```\n\nA `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.\n\nExige chave própria; a chave sandbox recebe 403.",
      "item": [
        {
          "id": "1ba280e7-77a1-4016-a083-104b50b98af4",
          "name": "Listar índices",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/indices",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "indices"
              ],
              "query": [
                {
                  "key": "family",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "490c4486-e0c3-46fc-9609-9914d1a7f41e",
          "name": "Detalhes de um índice",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.\n\nO formulário de teste com a chave `sandbox` devolve 403 aqui; use a sua chave.\n\nExige chave própria; a chave sandbox recebe 403.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/indices/:code",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "indices",
                ":code"
              ],
              "variable": [
                {
                  "key": "code",
                  "value": "IBOV",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "0803f5c0-7b76-4372-85cd-45a238c5ca56",
          "name": "Cotações históricas de um índice",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.\n\nO formulário de teste com a chave `sandbox` devolve 403 aqui; use a sua chave.\n\nExige chave própria; a chave sandbox recebe 403.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/indices/:code/prices",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "indices",
                ":code",
                "prices"
              ],
              "variable": [
                {
                  "key": "code",
                  "value": "IBOV",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "start",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "end",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "3dfb1ddc-05d5-4b1b-9e90-48a339f27ede",
          "name": "Composição de um índice",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.\n\nExige chave própria; a chave sandbox recebe 403.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/indices/:code/components",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "indices",
                ":code",
                "components"
              ],
              "variable": [
                {
                  "key": "code",
                  "value": "IBOV",
                  "description": ""
                }
              ],
              "query": [
                {
                  "key": "as_of",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        },
        {
          "id": "c0f9f9a6-f963-45af-aab8-d4b3d416d89f",
          "name": "Altas e baixas de um índice",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.\n\nExige chave própria; a chave sandbox recebe 403.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/indices/:code/movers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "indices",
                ":code",
                "movers"
              ],
              "variable": [
                {
                  "key": "code",
                  "value": "IBOV",
                  "description": ""
                }
              ]
            }
          },
          "response": []
        }
      ],
      "event": [
        {
          "listen": "test",
          "script": {
            "type": "text/javascript",
            "exec": [
              "const sandbox = (pm.variables.get(\"apiKey\") || \"\").startsWith(\"obm_sandbox_\");",
              "const ownKeyPath = pm.request.url.getPath().startsWith(\"/v1/indices/\") || pm.request.url.getPath().startsWith(\"/v1/funds/18537348000188/\");",
              "if (sandbox && ownKeyPath) {",
              "  pm.test(\"403 sem chave própria\", function () {",
              "    pm.expect(pm.response.code).to.eql(403);",
              "  });",
              "}"
            ]
          }
        }
      ]
    },
    {
      "id": "fc0e10a3-abf4-4d08-ac6b-3cfa7214a6f8",
      "name": "Busca",
      "description": "Busque por nome, ticker ou CNPJ com `q`. A busca respeita o plano da chave.",
      "item": [
        {
          "id": "83118f1d-82ea-43c5-8b58-bc2424924faa",
          "name": "Buscar ativos",
          "description": "Busca no catálogo do OBM por nome, ticker ou CNPJ, respeitando as classes e os ativos permitidos pela chave. Os resultados acompanham os cadastros da CVM e da B3 incorporados ao catálogo.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/search",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "search"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "PETR4",
                  "description": "",
                  "disabled": false
                },
                {
                  "key": "types",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        }
      ]
    },
    {
      "id": "2c8febd6-f13a-4e41-944f-2ecd422743f5",
      "name": "Fontes",
      "description": "Consulte a origem dos dados e a cadência de publicação em `/v1/sources`.",
      "item": [
        {
          "id": "11bda650-7ad2-469c-af82-2de13cb1bc35",
          "name": "Situação da API e dos dados",
          "description": "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.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/status",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "status"
              ]
            }
          },
          "response": []
        },
        {
          "id": "692822fc-4845-4e87-9688-a45ccd303d6d",
          "name": "Fontes dos dados",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/sources",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "sources"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "100",
                  "description": "",
                  "disabled": true
                }
              ]
            }
          },
          "response": []
        }
      ]
    },
    {
      "id": "16d9358f-2e11-4dbb-98c6-bf637452a856",
      "name": "Conta",
      "description": "Consulte o plano e o uso agregado da sua chave em `/v1/me`.",
      "item": [
        {
          "id": "cee3cb4c-a64e-43f2-a32e-ac897b9ed9c0",
          "name": "Plano e uso da sua conta",
          "description": "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.\n\nCabeçalhos nas respostas autenticadas:\n- `X-RateLimit-Limit`: Limite por minuto; `unlimited` indica ausência de limite.\n- `X-RateLimit-Remaining`: Saldo por minuto; `unlimited` indica ausência de limite.\n- `X-Quota-Limit`: Cota mensal; plano sem limite: o cabeçalho `X-Quota-*` não é enviado.\n- `X-Quota-Remaining`: Saldo mensal; só em planos com cota.\n- `X-Quota-Reset`: Reinício mensal em ISO 8601, no fuso de São Paulo; só em planos com cota.\n\nEm 429, `Retry-After` informa os segundos de espera. Falhas de autenticação ocorrem antes da medição de limites.",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/me",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "me"
              ]
            }
          },
          "response": []
        }
      ]
    }
  ],
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "X-API-Key",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.obm.com.br"
    },
    {
      "key": "apiKey",
      "value": ""
    }
  ],
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "const sandbox = (pm.variables.get(\"apiKey\") || \"\").startsWith(\"obm_sandbox_\");",
          "const ownKeyPath = pm.request.url.getPath().startsWith(\"/v1/indices/\") || pm.request.url.getPath().startsWith(\"/v1/funds/18537348000188/\");",
          "if (!(sandbox && ownKeyPath)) {",
          "  pm.test(\"Resposta 2xx\", function () {",
          "    pm.expect(pm.response.code).to.be.within(200, 299);",
          "  });",
          "}",
          "if (!pm.request.url.getPath().endsWith(\"/status\")) {",
          "  pm.test(\"Cabeçalho X-RateLimit-Limit presente\", function () {",
          "    pm.expect(pm.response.headers.has(\"X-RateLimit-Limit\")).to.be.true;",
          "  });",
          "}"
        ]
      }
    }
  ]
}
