FAQ

O que é o B3 for Developers?

O B3 for Developers é uma plataforma na qual disponibilizamos todas as APIs da B3.

Nela, é possível encontrar informações sobre os produtos e documentações técnicas – incluindo os métodos das APIs, a taxonomia, exemplos de utilização, cenários de uso etc. Além disso, montamos um Sandbox para que os usuários possam experimentar as APIs sem precisar contratar o serviço.

Quais as APIs disponíveis?

No momento, as APIs disponíveis no B3 for Developers são:

Market Data > Ofertas

Market Data > Negócios

Quais são os conjuntos de dados?

Os conjuntos de dados disponíveis hoje nas APIS são:

Market Data > Ofertas – Dados históricos a partir de D-1 com todas as ofertas de compra ou de venda que aconteceram no pregão. Esses dados são compostos de mais de 17 campos, incluindo desde a data de referência do pregão até a corretora que inseriu a oferta. Para saber mais detalhes, acesse a nossa documentação técnica, o menu “Métodos” ou a taxonomia.

Market Data > Negócios – Dados históricos a partir de D-1 com todos os negócios realizados no pregão. Esses dados são compostos de mais 17 campos, incluindo desde a data de referência do pregão até a corretora que inseriu a oferta. Para saber mais detalhes, acesse a nossa documentação técnica, o menu “Métodos” ou a taxonomia.

Qual o volume de dados disponíveis?

Os dados de ofertas e negócios estão disponíveis a partir de 07/2018, e o volume diário é de aproximadamente 157 milhões de linhas para os dados de ofertas e 4 milhões de linhas para os dados de negócios.

Qual o período disponível das bases históricas?

Os dados históricos das APIs de Ofertas e Negócios estão disponíveis a partir do dia 02/07/2018; porém, os dados de mudança de estado das ofertas estão disponíveis a partir de 08/2019.

Existe algum requisito mínimo para acessar as APIs da B3?

Para garantir a performance das APIS, a B3 recomenda que o usuário tenha no mínimo um equipamento com os itens abaixo:

CPU = 8vCPU (equivalente a 4CPU)

memória RAM = 16 GB

placa de rede = 4 Gbit ou superior

banda de rede = 50 MB ou superior

Qual é o browser recomendado para abrir o portal das apis?

Para ter uma melhor navegação, recomendamos a utilização do navegador browser Google Chrome.

O que são métodos?

Métodos são as ações permitidas dentro de uma API.

As APIs de Ofertas e Negócios possuem um método GET, quando utilizado traz os dados das APIs. Para saber quais os métodos que temos acesse a documentação técnica de cada API.

Qual o SLA de resposta dos métodos?

As APIs de Ofertas e Negócios tem um SLA de 2 segundos para retornar até 100.000 linhas, desde que os requisitos mínimos sejam atendidos.

Quais sãos os atributos obrigatórios?

Cada API possui atributos obrigatórios. Para consultá-los, acesse a "Documentação Técnica" e vá até a opção "Taxonomia".

Como eu encontro o significado de um determinado campo?

Na "Documentação Técnica" de cada API, os significados e domínios dos campos estão disponíveis na opção "Taxonomia".

Como eu acesso as APIs da B3?

1. Certifique-se de que você tem o pacote de acesso B3. 
2. Consulte o menu "Métodos" na documentação e escolha os endpoints que deseja acessar.
3. Escolha um API Client (Excel, Postman, SoapUI, entre outros), siga os passos de autenticação e consuma as APIs.

Como eu contrato?

Entre em contato com a gente pelo telefone 11 2565-7908 ou mande um e-mail para produtosdedados@b3.com.br

Existe cobrança?

Como estamos em uma fase inicial de testes, a nossa Política Comercial será isenta até o término dessa fase.

Para maiores esclarecimentos, entre em contato com a gente pelo telefone 11 2565-7908 ou mande um e-mail para produtosdedados@b3.com.br

Como faço para reconstruir o Book utilizando as APIs de Oferta da B3?

O passo a passo de como reconstruir o Book está disponível na "Documentação Técnica" da API de Ofertas no menu lateral "Cenários de uso".

 

Como fazer a autenticação das APIs?

Produção: Se quiser acessar as APIs em produção, é necessário implementar o Mutual SSL (para se conectar aos endereços das APIs) e o padrão OAuth 2.0 (para obtenção de tokens JWT). Mais detalhes sobre a implementação podem ser consultados no menu "Autenticação" disponível na "Documentação Técnica" de cada API.

Sandbox: Para acessar as APIs do Sandbox, é necessário informar o API Key. Se quiser saber mais detalhes sobre a implementação, consulte a "Documentação Técnica" do Sandbox.

O que é o pacote de acesso?

O pacote é um arquivo zip composto dos arquivos do certificado digital que deverão ser utilizados para implementar o Mutual SSL (*.cer, *.crt, *.csr, *.key e *.p12) e de um arquivo-texto que contém as chaves para a solicitação do token no padrão OAuth 2.0 – Client ID e Secret e a senha do arquivo *.p12  . Você receberá o pacote após a contratação das APIs..

Tenho que comprar um certificado?

Não. O certificado será gerado pela B3 e enviado no pacote de acesso.

Preciso instalar o certificado?

Depende. O certificado é utilizado para implementar o Mutual SSL e dependendo da sua implementação, pode ser necessária a instalação ou não.

Como faço para recuperar o meu client id e client secret?

Entre em contato com a B3 para que sejam gerados novos client id e client secret.

Como realizar a chamada do token de produção?

Para saber mais detalhes sobre a implementação da chamada de token, consulte a "Documentação Técnica" de cada API no menu "Autenticação".

O que é mutual SSL?

A B3 utiliza esse padrão para identificar a origem das chamadas das APIs. Se quiser mais informações sobre o que é o Mutual SSL e como ele funciona, consulte a "Documentação Técnica" de cada API no menu "Autenticação".

 

Existe alguma restrição de linguagem para se integrar com a APIs B3?

Não. Qualquer linguagem que possibilite a implementação de chamadas a APIs REST pode ser utilizada.

Consigo abrir as APIs no Excel?

Sim. Siga o passo a passo disponível na "Documentação Técnica", na opção "Cenários de Uso".

Preciso instalar algum programa / software?

Não. Para o consumo das APIs será necessário apenas um API Client (Postman, SoapUI, Excel).

Como funciona identificação do usuário na API?

As informações que estão no pacote de acesso são utilizadas para identificar o usuário na B3. Por isso, é de extrema importância que sejam armazenadas em local seguro e que apenas pessoas autorizadas possam acessá-las.

 

O que é o Sandbox?

Um Sandbox é um ambiente isolado de testes que permite aos usuários executarem programas que estão em produção, sem afetar os sistemas, aplicações ou plataformas.

O Sandbox da B3 possui uma variedade de dados limitados e gratuitos que você pode usar para conhecer, desenvolver, testar e experimentar.

Isso permite os testes de cada um dos nossos feeds de dados sem a necessidade de contratar o serviço ou ter acesso limitado. Assim, é possível experimentar sem interrupção e sem afetar nenhum aplicativo de produção que você já tenha construído.

Preciso me cadastrar para fazer testes?

Sim, hoje o ambiente de Sandbox é permitido apenas para os usuários cadastrados.

Como me cadastro?

Acesse a página de cadastro e após o cadastro, faça o login para acessar o ambiente de Sandbox.