npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-realtime-crypto-prices

v0.0.1

Published

The easiest way to use live crypto prices in React components

Downloads

57

Readme

React Real Time Crypto Prices

The easiest way to use live crypto prices in React components

language license

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:

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!