Stock Finder

Localizador de estoque

Uma maneira rápida de consultar o IEX Cloud para encontrar dados recentes de ações.
Explore os documentos »

Ver demonstração · Bug no Stock-Finder · Solicitar recurso

Índice

• Sobre o Projeto
  • Construído com
• Começando
  • Pré-requisitos
  • Instalação
• Uso
• Roteiro
• Contribuindo
• Licença
• Contato

Sobre o projeto

Criei este projeto para consultar facilmente o banco de dados IEX Cloud de informações de estoque para meu próprio uso. Originalmente, comecei procurando pacotes que já ofereciam isso e não havia nenhum atualizado. Em seguida, criei este pacote para permitir uma abordagem muito mais simplificada para fazer isso.

Construído com

• NPM
• NodeFetch
• Texto datilografado

Começando

Para começar a usar este pacote, siga estas etapas.

Pré-requisitos

Você precisa ter a versão mais recente do NPM para que este projeto funcione.

• npm

npm install npm@latest -g

Instalação

1. Clonar o Stock-Finder

git clone https://github.com/austinmccalley/Stock-Finder.git

2. Instale pacotes NPM

npm install

3. Construir arquivo JS

tsc

Uso

Aqui está um exemplo de código de como fazer uma solicitação simples de informações de estoque $TSLA usando o pacote com a função getStock() .

 const stockFinder = require ( 'stockfinder' ) ;

/*
  Declare the Stock Finder with
  the parameters you want
*/
const sf = new stockFinder ( 'stable' , 'TSLA' , apiKey , false ) ;

/*
  Call the get stock function and then wait
  for the promise to return
*/
sf . getStock ( ) . then ( res => {
  console . log ( res )
} ) ;

Se você deseja obter várias ações, você usará a função getStocks() .

 const stockFinder = require ( 'stockfinder' ) ;

/*
  Declare the Stock Finder with
  the parameters you want
*/
const sf = new stockFinder ( 'stable' , [ 'TSLA' , 'AAPL' ] , apiKey , false ) ;

/*
  Call the get stocks function and then wait
  for the promise to return
*/
sf . getStocks ( ) . then ( res => {
  console . log ( res )
} ) ;

Observação

Às vezes, o IEX Cloud tem problemas com solicitações normais. Você pode passar a usar uma solicitação CURL seguindo o exemplo.

 const stockFinder = require ( 'stockfinder' ) ;

/*
  Declare the Stock Finder with
  the parameters you want
*/
const sf = new stockFinder ( 'stable' , 'TSLA' , apiKey , true ) ;

/*
  Call the get stock function and then wait
  for the promise to return
*/
sf . getStock ( ) . then ( res => {
  console . log ( res )
} ) ; 

Roteiro

Consulte os problemas em aberto para obter uma lista dos recursos propostos (e dos problemas conhecidos).

Contribuindo

As contribuições são o que tornam a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito apreciada .

1. Bifurque o projeto
2. Crie sua ramificação de recursos ( git checkout -b feature/AmazingFeature )
3. Confirme suas alterações ( git commit -m 'Add some AmazingFeature' )
4. Enviar para a filial ( git push origin feature/AmazingFeature )
5. Abra uma solicitação pull

Licença

Distribuído sob a licença MIT. Consulte LICENSE para obter mais informações.

Contato

Austin McCalley - [email protected]

Link do projeto: https://github.com/austinmccalley/Stock-Finder