Stock Finder

Recherche d'actions

Un moyen rapide d'interroger IEX Cloud pour trouver des données boursières récentes.
Explorer les documents »

Voir la démo · Bug de Stock-Finder · Fonctionnalité de demande

Table des matières

• À propos du projet
  • Construit avec
• Commencer
  • Conditions préalables
  • Installation
• Usage
• Feuille de route
• Contribuer
• Licence
• Contact

À propos du projet

J'ai créé ce projet pour interroger facilement la base de données IEX Cloud d'informations boursières pour mon propre usage. Au départ, j’ai commencé par rechercher des packages proposant déjà cela et aucun n’a été mis à jour. J'ai ensuite créé ce package pour permettre une approche beaucoup plus rationalisée pour ce faire.

Construit avec

• MNP
• Récupération de nœud
• Manuscrit

Commencer

Pour commencer à utiliser ce package, suivez ces étapes.

Conditions préalables

Vous devez disposer de la dernière version de NPM pour que ce projet fonctionne.

• npm

npm install npm@latest -g

Installation

1. Cloner le Stock-Finder

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

2. Installer les packages NPM

npm install

3. Construire un fichier JS

tsc

Usage

Voici un exemple de code montrant comment effectuer une simple demande d'informations boursières $TSLA à l'aide du package avec la fonction 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 )
} ) ;

Si vous souhaitez obtenir plusieurs actions, vous utiliserez la fonction 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 )
} ) ;

Note

Parfois, IEX Cloud rencontre des problèmes avec les requêtes normales. Vous pouvez plutôt utiliser une requête CURL en suivant l'exemple.

 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 )
} ) ; 

Feuille de route

Consultez les problèmes ouverts pour une liste des fonctionnalités proposées (et des problèmes connus).

Contribuer

Les contributions sont ce qui fait de la communauté open source un endroit si formidable pour apprendre, inspirer et créer. Toutes les contributions que vous apportez sont grandement appréciées .

1. Forkez le projet
2. Créez votre branche de fonctionnalités ( git checkout -b feature/AmazingFeature )
3. Validez vos modifications ( git commit -m 'Add some AmazingFeature' )
4. Pousser vers la branche ( git push origin feature/AmazingFeature )
5. Ouvrir une demande de tirage

Licence

Distribué sous licence MIT. Voir LICENSE pour plus d’informations.

Contact

Austin McCalley - [email protected]

Lien du projet : https://github.com/austinmccalley/Stock-Finder