org.knowm.xchange.cobinhood.Cobinhood Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xchange-cobinhood Show documentation

Development fork. Not for general use.

There is a newer version: 4.3.17.1

package org.knowm.xchange.cobinhood;

import java.io.IOException;
import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import org.knowm.xchange.cobinhood.dto.CobinhoodResponse;
import org.knowm.xchange.cobinhood.dto.marketdata.*;

@Path("v1")
@Produces(MediaType.APPLICATION_JSON)
public interface Cobinhood {
  /**
   * Retrieves a ticker.
   *
   * @param symbol the currency pair
   * @return
   * @throws IOException
   */
  @GET
  @Path("market/tickers/{symbol}")
  CobinhoodResponse tick(@PathParam("symbol") String symbol)
      throws IOException, CobinhoodException;

  /**
   * Retrieves all tickers.
   *
   * @return
   * @throws IOException
   */
  @GET
  @Path("market/tickers")
  CobinhoodResponse tick() throws IOException, CobinhoodException;

  /**
   * Retrieves a list of all currencies.
   *
   * @return
   * @throws IOException
   */
  @GET
  @Path("market/currencies")
  CobinhoodResponse currencies() throws IOException, CobinhoodException;

  /**
   * The call for order books
   *
   * @param symbol the currency pair
   * @param limit order book length limit
   * @return
   * @throws IOException
   */
  @GET
  @Path("market/orderbooks/{symbol}")
  CobinhoodResponse orders(
      @PathParam("symbol") String symbol, @QueryParam("limit") Integer limit)
      throws IOException, CobinhoodException;

  /**
   * The call for recent trades
   *
   * @param symbol the currency pair
   * @param limit trades length limit
   * @return
   * @throws IOException
   */
  @GET
  @Path("market/trades/{symbol}")
  CobinhoodResponse trades(
      @PathParam("symbol") String symbol, @QueryParam("limit") Integer limit)
      throws IOException, CobinhoodException;
}