com.lucadev.coinmarketcap.CoinMarketCap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of coinmarketcap-api Show documentation

A REST API client specifically developed to connect to the CoinMarketCap API.

The newest version!

package com.lucadev.coinmarketcap;

import com.lucadev.coinmarketcap.api.CoinListingsFetcher;
import com.lucadev.coinmarketcap.api.CurrencyTicker;
import com.lucadev.coinmarketcap.api.GlobalTicker;

/**
 * Base API class used to access basic API functionality.
 *
 * @author Luca Camphuisen < [email protected] >
 * @since 19-11-17
 */
public final class CoinMarketCap {

    private static final CoinListingsFetcher COIN_LISTING_FETCHER = new CoinListingsFetcher();

    /**
     * Obtain a price ticker that can fetch multiple markets at once.
     *
     * @return a {@code /ticker/} API implementation.
     * @see /ticker/ endpoint documentation.
     */
    public static GlobalTicker ticker() {
        return new GlobalTicker();
    }

    /**
     * Obtain a price ticker that can fetch one market at a time.
     *
     * @return a {@code /ticker/{id}/} API implementation.
     * @see /ticker/{id} endpoint documentation.
     */
    public static CurrencyTicker ticker(long marketId) {
        return new CurrencyTicker(marketId);
    }

    /**
     * Obtain a price ticker that can fetch one market at a time.
     *
     * @return a {@code /ticker/{id}/} API implementation. This argument requires the coin's name such as "bitcoin"
     * @see /ticker/{id} endpoint documentation.
     */
    public static CurrencyTicker ticker(String marketName) {
        return ticker(listings().get().getByName(marketName)
                .orElseThrow(() -> new NullPointerException("No market found for name " + marketName)).getId());
    }

    /**
     * Coin listings
     *
     * @return
     */
    public static CoinListingsFetcher listings() {
        return COIN_LISTING_FETCHER;
    }

}