Cryptos4J is an unofficial Java API for CryptoCompare.
This API retrieves Cryptocurrency information such as price and historical data from Cryptocomapre's Restful API.
To use Cryptos4J, simply add Cryptos4J.jar and gson.jar to your build path.
(optional)
After creating an account and api key with Cryptocompare, Cryptos4J allows you to use it.
Take a look at Cryptocompare's how-to-use-our-api guide for more info on api keys and how to use them.
To do this simply call Util.setApiKey() and pass your api key as a parameter.
- Google gson for parsing json objects.
- API Doc: Cryptocompare's documentation on all of their end points
- API Javadoc: Cryptos4J documentation
| End Point | Description |
|---|---|
| Single Symbol Price | Get the current price of any cryptocurrency in any other currency that you need. |
| Multiple Symbols Price | Same as Single Symbol Price but with multiple currency from symbols. |
| Generate Custom Average | Compute the current trading info (price, vol, open, high, low etc) of the requested pair as a volume weighted average based on the exchanges requested. |
| Historical Daily OHLCV | Get open, high, low, close, volumefrom and volumeto from daily historical data. |
| Historical Hourly OHLCV | Get open, high, low, close, volumefrom and volumeto from hourly historical data. |
| Historical Minute OHLCV | Get open, high, low, close, volumefrom and volumeto from minute historical data. |
| Coins General Info | Get combinations of subs and pricing info in order to know what needs to be streamed and how to connect to the streamers. |
| All Exchanges and Trading Pairs | Returns all the exchanges that CryptoCompare has integrated with. |
| All the Coins | Returns all the coins that CryptoCompare has added to the website. |
The code below minimally demonstrates how to create a stream of 100 TimestampedData objects aggregated by 1 minute.
For more examples see the examples directory.
HistoricalMinute histoMinute = HistoricalData.generateHistoMinute("USDT", "BTC", ExchangeStreamer.exchanges.Binance);
histoMinute.setLimit(100);
histoMinute.update();
Stream<TimestampedData> steam = histoMinute.getDataStream();
Cryptos4J is released under the MIT License.
MIT License
Copyright (c) 2018 Matthew McFadden
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.