Stock Finder

Aktienfinder

Eine schnelle Möglichkeit, IEX Cloud abzufragen, um aktuelle Bestandsdaten zu finden.
Entdecken Sie die Dokumente »

Demo ansehen · Stock-Finder-Fehler · Funktion anfordern

Inhaltsverzeichnis

• Über das Projekt
  • Gebaut mit
• Erste Schritte
  • Voraussetzungen
  • Installation
• Verwendung
• Roadmap
• Mitwirken
• Lizenz
• Kontakt

Über das Projekt

Ich habe dieses Projekt erstellt, um die IEX Cloud-Datenbank mit Aktieninformationen für meinen eigenen Gebrauch einfach abzufragen. Ursprünglich habe ich nach Paketen gesucht, die dies bereits boten, aber es gab keines, das aktualisiert wurde. Anschließend habe ich dieses Paket erstellt, um einen wesentlich effizienteren Ansatz hierfür zu ermöglichen.

Gebaut mit

• NPM
• NodeFetch
• Typoskript

Erste Schritte

Um mit der Verwendung dieses Pakets zu beginnen, befolgen Sie diese Schritte.

Voraussetzungen

Damit dieses Projekt funktioniert, benötigen Sie die neueste Version von NPM.

• npm

npm install npm@latest -g

Installation

1. Klonen Sie den Stock-Finder

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

2. Installieren Sie NPM-Pakete

npm install

3. Erstellen Sie eine JS-Datei

tsc

Verwendung

Hier ist ein Codebeispiel, wie Sie mithilfe des Pakets mit der Funktion getStock() eine einfache Anfrage nach $TSLA-Aktieninformationen durchführen können.

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

Wenn Sie mehrere Aktien erhalten möchten, verwenden Sie die Funktion 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 )
} ) ;

Notiz

Manchmal hat IEX Cloud Probleme mit normalen Anfragen. Sie können stattdessen zur Verwendung einer CURL-Anfrage wechseln, indem Sie dem Beispiel folgen.

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

Roadmap

Eine Liste der vorgeschlagenen Funktionen (und bekannten Probleme) finden Sie unter „Offene Probleme“.

Mitwirken

Beiträge machen die Open-Source-Community zu einem so wunderbaren Ort zum Lernen, Inspirieren und Schaffen. Jeder Beitrag, den Sie leisten, wird sehr geschätzt .

1. Forken Sie das Projekt
2. Erstellen Sie Ihren Feature-Zweig ( git checkout -b feature/AmazingFeature )
3. Übernehmen Sie Ihre Änderungen ( git commit -m 'Add some AmazingFeature' )
4. Push to the Branch ( git push origin feature/AmazingFeature )
5. Öffnen Sie eine Pull-Anfrage

Lizenz

Verteilt unter der MIT-Lizenz. Weitere Informationen finden Sie unter LICENSE .

Kontakt

Austin McCalley – [email protected]

Projektlink: https://github.com/austinmccalley/Stock-Finder