Use a API de Stock Events

A API do Stock Events é um recurso Pro para automatizar os dados da sua conta Stock Events usando suas próprias ferramentas. Ela foi feita para automação de conta, e não como uma API geral de dados de mercado ou busca de símbolos.

As requisições de escrita modificam as mesmas watchlists, símbolos e transações que você vê no Stock Events.

O que você pode fazer com a API

• Listar, criar, recuperar e atualizar watchlists.
• Listar, adicionar, atualizar e remover símbolos de uma watchlist.
• Listar, criar, recuperar, atualizar e deletar transações.
• Ler as visualizações calculadas de Holdings e Dividends.

Como criar uma API key

É necessário ter uma assinatura Pro ativa do Stock Events para criar e usar API keys.

1. Faça login no web app do Stock Events.
2. Abra o seu Profile.
3. Selecione Settings.
4. Em Account, selecione Data.
5. Selecione API Keys.
6. Selecione Create API key.
7. Digite um Name descritivo e selecione Create.
8. Selecione Copy API key e guarde a chave em um lugar seguro antes de fechar o diálogo.

A API key completa é exibida apenas uma vez. Depois que você fechar o diálogo, a tela de API Keys mostrará apenas o nome, o prefixo, a data de criação e a data do último uso, em vez da chave completa.

Se a sua assinatura Pro ficar inativa, suas chaves continuam vinculadas à sua conta, mas as requisições de API retornarão 403 Forbidden até que o acesso Pro esteja ativo novamente.

Faça sua primeira requisição

A URL base da API é https://stockevents.app/api/v1. Envie sua API key como um bearer token no header de Authorization.

curl -H "Authorization: Bearer $STOCK_EVENTS_API_KEY" \  
  https://stockevents.app/api/v1/watchlists

Essa requisição retorna suas watchlists e os IDs delas. Você pode usar o ID de uma watchlist com os endpoints de símbolos, Holdings e Dividends específicos daquela watchlist.

Para campos de requisição, estruturas de resposta, parâmetros opcionais e todos os endpoints disponíveis, use estes recursos:

• Documentação da API do Stock Events
• Configurações de API Keys
• Documento OpenAPI

Mantenha sua API key segura

Trate uma API key como se fosse uma senha. Não a envie para o seu controle de versão (source control), não a exponha em código de cliente público e não a envie em parâmetros de query ou no corpo da requisição.

As API keys autenticam a API de automação de conta sem permissões separadas para cada chave. Use-as apenas com ferramentas em que você confia.

Se uma chave for exposta, volte em API Keys, selecione Revoke API key e confirme em Revoke. A chave parará de funcionar imediatamente e não poderá ser reativada. Se precisar, crie uma nova chave para substituir a antiga.

Erros comuns

• 401 Unauthorized: A API key está faltando, é inválida ou foi revogada.
• 403 Forbidden: A conta não possui acesso Pro ativo no momento.