API de Cotações Bolsa Financeira – Versão 1.0 –03/2013
API de Cotações
Bolsa Financeira
API de Cotações Bolsa Financeira
© Bolsa Financeira – 2013. Todos os Direitos Reservados.
Dúvidas ou Sugestões: [email protected]
Página 1 de 7
API de Cotações Bolsa Financeira – Versão 1.0 –03/2013
Sumário
API & Documentação .................................................................................................................... 3
Como Funciona?............................................................................................................................ 3
Formato de Requisição.................................................................................................................. 3
Visão Geral ................................................................................................................................ 3
Exemplo de Requisição utilizando REST................................................................................ 3
Explicação.................................................................................................................................. 4
Formatos de Retorno .................................................................................................................... 4
Visão Geral ................................................................................................................................ 4
Exemplo de Retorno utilizando CSV...................................................................................... 4
Explicação.............................................................................................................................. 4
Exemplos ....................................................................................................................................... 6
Exemplo 1: Buscar dados de um único ativo ............................................................................ 6
Exemplo 2: Buscar dados de mais de um ativo......................................................................... 6
Exemplo 3: Retornar dados com atraso de 15 minutos............................................................ 7
Contato.......................................................................................................................................... 7
API de Cotações Bolsa Financeira
© Bolsa Financeira – 2013. Todos os Direitos Reservados.
Dúvidas ou Sugestões: [email protected]
Página 2 de 7
API de Cotações Bolsa Financeira – Versão 1.0 –03/2013
API & Documentação
A API (Interface de Programação de Aplicativos) do Bolsa Financeira é um conjunto de
funções e padrões estabelecidos para criação de aplicativos customizados, em que há
necessidade de uso dos serviços oferecidos pelo Bolsa Financeira.
Como Funciona?
Para integrar à API do Bolsa Financeira é necessário primeiramente obter um token
para sua aplicação, que deverá ser usado em todas as requisições feitas ao serviço que for
solicitado. É através deste token que é feita a autenticação para o uso da API.
Todos os serviços oferecidos utilizam a tecnologia REST no tratamento de requisições,
sendo assim possível construir facilmente uma URL que pode ser executada em seu navegador,
na linha de comando, ou através do código.
Formato de Requisição
Para enviar os dados, é necessário utilizar uma URL que é constituída basicamente da
seguinte forma:
http://datafeed.bolsafinanceira.com/cgi-bin/quote.cgi?token=[token]&symbol=PETR4
Visão Geral
Transferência de Estado Representacional (Representational State Transfer) ou
somente REST é uma técnica de engenharia de software para sistemas distribuídos, que
descreve uma interface web simples que utiliza XML, HTTP, JSON ou texto puro, sem
abstrações adicionais dos protocolos baseados em padrões de troca de mensagem como o
SOAP.
Exemplo de Requisição utilizando REST.
A tecnologia REST é a única utilizada em todos os serviços da API do Bolsa Financeira
no tratamento de requisições.
http://datafeed.bolsafinanceira.com/cgi-bin/quote.cgi?token=[token]&symbol=PETR4
Na URL acima usamos o serviço de datafeed da API de Cotações do Bolsa Financeira, a
qual retorna todos os dados relevantes em tempo real de cada ativo negociado na Bovespa.
API de Cotações Bolsa Financeira
© Bolsa Financeira – 2013. Todos os Direitos Reservados.
Dúvidas ou Sugestões: [email protected]
Página 3 de 7
API de Cotações Bolsa Financeira – Versão 1.0 –03/2013
Através desta URL de requisição, a API do Bolsa Financeira lhe retornará um CSV
(Comma-separated values) com os dados do ativo PETR4.
Explicação
token: Seu código único para usar a API. Seu uso é obrigatório.
symbol: Códigos que serão consultados.
dl: Buscar os dados com atraso (delay) de 15 minutos.
Formatos de Retorno
O formato utilizado para retorno dos dados deve ser o CSV.
Visão Geral
Para o retorno dos dados, deve ser utilizado o formato CSV que é um bloco de texto,
separados por vírgula.
Exemplo de Retorno utilizando CSV
Para uma requisição feita com a seguinte URL:
http://datafeed.bolsafinanceira.com/cgi-bin/quote.cgi?token=[token]&symbol=PETR4
A qual irá buscar os dados em tempo real do ativo PETR4, teremos como retorno:
PETR4,PETROBRAS,PN,20130320,162216,19.05,19.16,18.68,18.87,18.77,19.10,229190
00,432393520,26504,18.77,18.78,100,3000,-1.73,0,A
Onde no exemplo acima, cada campo antes da vírgula tem um significado, conforme
segue abaixo:
código,empresa,tipo,data,hora,abertura,máxima,mínima,médio,fechamento,fechamen
to anterior,volume,volume financeiro,negócios,oferta de compra,oferta de venda,qtd
oferta compra,qtd oferta venda,variação,status,fase
Explicação
Código: Código do ativo (PETR4);
Empresa: PETROBRAS;
API de Cotações Bolsa Financeira
© Bolsa Financeira – 2013. Todos os Direitos Reservados.
Dúvidas ou Sugestões: [email protected]
Página 4 de 7
API de Cotações Bolsa Financeira – Versão 1.0 –03/2013
Tipo: Tipo do Ativo (ON, PN...);
Data: 20130320 (ano mês e dia, sem separador – 20/03/2013);
Hora: 162216 (hora minuto e segundo, sem separador – 16:22:16)
Abertura: Preço de Abertura;
Máxima: Preço Máximo;
Mínima: Preço Mínimo;
Médio: Preço Médio;
Fechamento: Preço atual;
Fechamento Anterior: (fechamento do dia anterior);
Volume: Volume negociado;
Volume Financeiro: Volume Financeiro;
Negócios: Quantidade de negócios;
Oferta de Compra: Melhor oferta de compra no Book;
Oferta de Venda: Melhor oferta de venda no Book;
Qtd oferta compra: Quantidade da melhor oferta de compra.
Qtd oferta venda: Quantidade da melhor oferta de venda;
Variação: Variação percentual;
Status:
0 = normal
1 = congelado
2 = suspenso
3 = leilão
4 = inibido
API de Cotações Bolsa Financeira
© Bolsa Financeira – 2013. Todos os Direitos Reservados.
Dúvidas ou Sugestões: [email protected]
Página 5 de 7
API de Cotações Bolsa Financeira – Versão 1.0 –03/2013
Fase:
P = pré-abertura
A = abertura
PN = pré-fechamento
N = fechamento
E = pré-abertura do after
R = abertura after
NE = fechamento do after
F = final
Exemplos
Para auxiliar na requisição dos dados, veja alguns exemplos com 1 ativo ou mais de 1
ativo na mesma busca.
Exemplo 1: Buscar dados de um único ativo
Retorna os dados de um único ativo
Busca
http://datafeed.bolsafinanceira.com/cgi-bin/quote.cgi?token=[token]&symbol=PETR4
Retorno
PETR4,PETROBRAS,PN,20130320,173519,19.05,19.16,18.68,18.86,18.81,
19.10,25550800,481832621,31415,18.88,18.88,6200,2400,-1.52,3,N
Exemplo 2: Buscar dados de mais de um ativo
Retorna os dados de múltiplos ativos, cada ativo corresponde a uma consulta, no
exemplo abaixo, são contabilizadas 6 consultas de cotações.
Busca
http://datafeed.bolsafinanceira.com/cgibin/quote.cgi?token=[token]&symbol=PETR4,VALE5,ITUB4,CSAN3,AMBV3,GGBR4
API de Cotações Bolsa Financeira
© Bolsa Financeira – 2013. Todos os Direitos Reservados.
Dúvidas ou Sugestões: [email protected]
Página 6 de 7
API de Cotações Bolsa Financeira – Versão 1.0 –03/2013
Retorno
PETR4,PETROBRAS,PN,20130320,173519,19.05,19.16,18.68,18.86,18.81,
19.10,25550800,481832621,31415,18.88,18.88,6200,2400,-1.52,3,N
VALE5,VALE,PNA
N1,20130320,173534,32.45,33.15,32.41,32.83,32.93,32.39,18044900,5
92363326,32601,33.09,33.09,30600,3900,1.67,3,N
ITUB4,ITAUUNIBANCO,PN
N1,20130320,173535,35.65,36.20,35.47,36.02,36.19,35.82,7415800,26
7127826,22181,36.18,36.18,16900,800,1.03,3,N
CSAN3,COSAN,ON
NM,20130320,173500,46.24,46.45,45.20,45.93,45.20,46.06,1122200,51
546656,5997,45.45,45.45,300,1000,-1.87,3,N
AMBV3,AMBEV,ON,20130320,173500,83.81,84.85,83.81,84.57,84.50,83.8
8,158900,13437923,927,84.50,84.60,1200,500,0.74,0,N
GGBR4,GERDAU,PN
N1,20130320,173527,14.82,15.12,14.71,14.93,14.85,14.83,5884700,87
882484,12567,14.89,14.89,1000,400,0.13,3,N
Exemplo 3: Retornar dados com atraso de 15 minutos
Retorna os dados em qualquer busca, com atraso de 15 minutos
Busca
http://datafeed.bolsafinanceira.com/cgi-bin/quote.cgi?token=[token]&symbol=PETR4&dl=1
Retorno
PETR4,PETROBRAS,PN,20130320,173519,19.05,19.16,18.68,18.86,18.81,
19.10,25550800,481832621,31415,18.88,18.88,6200,2400,-1.52,3,N
Contato
Se você tiver qualquer dúvida ou sugestão, favor entrar em contato pelo email:
[email protected].
Equipe Bolsa Financeira
API de Cotações Bolsa Financeira
© Bolsa Financeira – 2013. Todos os Direitos Reservados.
Dúvidas ou Sugestões: [email protected]
Página 7 de 7