alpha-vantage-cli

alpha-vantage-cli

A command line app and Node.js api for retreiving data from Alpha Vantage.

You can use this from the command line to download stock data from Alpha Vantage to a CSV file.

You can use it from your Node.js app as a reusable code module.

Data is returned as is from Alpha Vantage with no modification.

Getting an Alpha Vantage API key

https://www.alphavantage.co/support/#api-key

Usage from the command line

todo

npm install -g alpha-vantage-cli

alpha-vantage-cli --type=<data-type> --symbol=<code-for-the-instrument> --api-key=<your-api-key> --function=<alpha-vantage-function> --out=<output-csv-file> [--output-data-size=<output-data-size>] [--interval=<time-interval>]

todo: describe each of the options

todo: these options are passed through directly

todo: Can provide an example using demo apikey and MSFT.

Data type

daily
intraday

Functions:

TIME_SERIES_DAILY_ADJUSTED
TIME_SERIES_INTRADAY
todo: etc

Output data size

full
compact

Interval

1min, 5min, 15min, 30min, 60min

Usage from a Node.js script

todo

How it works

todo

Testing

ts-node cli.ts --type=daily --symbol=STW.AX --api-key=<api-key> --out=./test.csv

or

npm run test:daily
npm run test:intraday

TODO: Article

Reference the article! Reference the type script template