react-realtime-crypto-prices v0.0.1

React Real Time Crypto Prices

The easiest way to use live crypto prices in React components

React Real Time Crypto Prices provides a simple context provider and hooks for using live simple prices and candle data in your components.

Dependencies

This library requires the following packages to be installed:

• react v17.0.2+
• react-dom v17.0.2+

Installation

React Real Time Crypto Prices requires Node.js v14+ to run.

Install React Real Time Crypto Prices from npm

npm install react-realtime-crypto-prices

Or with yarn

yarn add react-realtime-crypto-prices

Supported Symbols

TODO: Add a list (or link to one) of supported symbols for simple and candle prices

Usage

All symbols should be lowercase to avoid capitalization mismatching.

import React from "react";
import {
    useCryptoPrices,
    useCryptoTickers,
    CryptoPriceProvider,
} from "react-realtime-crypto-prices";

const HookExample = () => {
    const prices = useCryptoPrices(["btc", "eth"]);
    const tickers = useCryptoTickers(["btc", "eth"]);
    return (
        <>
            <div>Live Prices</div>
            <div>{JSON.stringify(prices)}</div>

            <div>Live Tickers</div>
            <div>{JSON.stringify(tickers)}</div>
        </>
    );
};

const App = () => {
    return (
        <div className="App">
            <CryptoPriceProvider cryptoCompareApiKey="<YOUR-API_KEY>">
                <HookExample />
            </CryptoPriceProvider>
        </div>
    );
};

export default App;

Ladies and gents we have ~live prices~

*Note: cryptoCompareApiKey is an optional prop for CryptoPriceProvider, however, if not included, the library will be unable to stream ticker data

Hooks

useCryptoPrices

• Accepts array of symbols
• returns data in format {symbol: price}

Example

{
    "btc": 40105.28,
    "eth": 2381.19,
    "ltc": 526.97
}

useCryptoTickers

• Accepts array of symbols
• returns data in format {symbol: {timestamp, open, high, low, close, volume}

Example

{
    btc: {
        timestamp:2021-07-29T15:55:00.000Z,
        open: 39961.26,
        high: 39978.48,
        low: 39955.29,
        close:39978.48,
        volume: 772926.41
    },
    eth: {
        timestamp:2021-07-29T15:55:00.000Z,
        open: 2322.47,
        high: 2323.23,
        low: 2321.54,
        close:2323.23,
        volume: 932626.37
    }
}

Development

Interested in helping out a bit?

React Real Time Crypto Prices is written in TypeScript and will be tested using jest. Next step in the roadmap is to define all the types and interfaces used throughout the project. Make sure all new features are tested before creating PR.

Install Package Dependencies:

npm install

Build Package:

npm run build

Create Package Link:

npm link

Install Example Project Dependencies:

cd example/
npm install
npm link react-realtime-crypto-prices

Resolve React versions between package and example project:

cd ../
npm link example/node_modules/react

Run tests:

npm run test

License

MIT

Houston we have...Free Software!