Stock Finder

Поиск акций

Быстрый способ запросить IEX Cloud для поиска последних данных по акциям.
Изучите документацию »

Посмотреть демо · Ошибка в Stock-Finder · Запросить функцию

Оглавление

• О проекте
  • Построен с
• Начиная
  • Предварительные условия
  • Установка
• Использование
• Дорожная карта
• Содействие
• Лицензия
• Контакт

О проекте

Я создал этот проект, чтобы легко запрашивать информацию об акциях в базе данных IEX Cloud для собственного использования. Первоначально я начал с поиска пакетов, которые уже предлагали это, и ни один из них не был обновлен. Затем я создал этот пакет, чтобы обеспечить гораздо более упрощенный подход к этому.

Построен с

• НПМ
• NodeFetch
• Машинопись

Начиная

Чтобы начать использовать этот пакет, выполните следующие действия.

Предварительные условия

Для работы этого проекта вам необходима последняя версия NPM.

• НПМ

npm install npm@latest -g

Установка

1. Клонирование Stock-Finder

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

2. Установите пакеты NPM

npm install

3. Создать JS-файл

tsc

Использование

Ниже приведен пример кода, показывающий, как выполнить простой запрос информации об акциях $TSLA с использованием пакета с функцией 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 )
} ) ;

Если вы хотите получить несколько акций, используйте функцию 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 )
} ) ;

Примечание

Иногда в IEX Cloud возникают проблемы с обычными запросами. Вместо этого вы можете переключиться на использование запроса CURL, следуя примеру.

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

Дорожная карта

Список предлагаемых функций (и известных проблем) см. в разделе «Открытые проблемы».

Содействие

Вклады — это то, что делает сообщество открытого исходного кода таким замечательным местом для обучения, вдохновения и творчества. Мы очень ценим любой ваш вклад.

1. Форкнуть проект
2. Создайте свою ветку функций ( git checkout -b feature/AmazingFeature )
3. Зафиксируйте свои изменения ( git commit -m 'Add some AmazingFeature' )
4. Нажмите на ветку ( git push origin feature/AmazingFeature )
5. Открыть запрос на включение

Лицензия

Распространяется по лицензии MIT. См. LICENSE для получения дополнительной информации.

Контакт

Остин МакКолли - [email protected]

Ссылка на проект: https://github.com/austinmccalley/Stock-Finder