@zrichardson/alphavantage
v1.0.7
Published
A TypeScript SDK for the AlphaVantage API
Downloads
24
Maintainers
Readme
AlphaVantage
This is a wrapper for the AlphaVantage API that makes use of TypeScript and exports various enums and interfaces from each respective model for easier typing. I have no affiliation with AlphaVantage and no attribution is required to use this library.
Installation
npm install @zrichardson/alphavantage
yarn add @zrichardson/alphavantage
Usage
The AlphaVantage module exports a class that can be instantiated with your API key to enable you to make API calls without having to provide your key on every call. Simply invoke the api method from the class, passing in the sdk function and params.
import AlphaVantage from '@zrichardson/alphavantage';
import { exchangeRate } from '@zrichardson/alphavantage/cryptocurrencies';
const alpha = AlphaVantage('your-api-key');
alpha.api(
exchangeRate,
{ from_currency: 'BTC', to_currency: 'USD' }
);
Alternatively, you may import methods individually and call them without first instantiating an AlphaVantage object.
import { exchangeRate } from '@zrichardson/alphavantage/cryptocurrencies';
exchangeRate({
apikey: 'your-api-key',
from_currency: 'BTC',
to_currency: 'BTC',
});