Package org.knowm.xchange.deribit.v2

Interface Deribit

@Path("/api/v2/public")
@Produces("application/json")
public interface Deribit

Method Summary

Modifier and Type	Method	Description
DeribitResponse<DeribitAuthentication>	auth(GrantType grantType, String username, String password, String clientId, String clientSecret, String refreshToken, String timestamp, String signature, String nonce, String state, String scope)	Retrieve an Oauth access token, to be used for authentication of 'private' requests.
DeribitResponse<List<DeribitCurrency>>	getCurrencies()	Retrieves available trading instruments.
DeribitResponse<List<List<BigDecimal>>>	getHistoricalVolatility(String currency)	Provides information about historical volatility for given cryptocurrency.
DeribitResponse<List<DeribitInstrument>>	getInstruments(String currency, Kind kind, Boolean expired)
DeribitResponse<DeribitTrades>	getLastTradesByInstrument(String instrumentName, Integer startSeq, Integer endSeq, Integer count, Boolean includeOld, String sorting)	Retrieve the latest trades that have occurred for a specific instrument.
DeribitResponse<DeribitOrderBook>	getOrderBook(String instrumentName, Integer depth)	Retrieves the order book, along with other market values for a given instrument.
DeribitResponse<List<DeribitSummary>>	getSummaryByInstrument(String instrumentName)	Retrieves the summary information such as open interest, 24h volume, etc.
DeribitResponse<DeribitTicker>	getTicker(String instrumentName)	Get ticker for an instrument.

Method Details

getInstruments

@GET
@Path("get_instruments")
DeribitResponse<List<DeribitInstrument>> getInstruments(@QueryParam("currency")
 String currency,
 @QueryParam("kind")
 Kind kind,
 @QueryParam("expired")
 Boolean expired)
                                                 throws DeribitException,
IOException

Parameters:

currency - required, the currency symbol

kind - optional, Instrument kind, if not provided instruments of all kinds are considered

expired - optional, set to true to show expired instruments instead of active ones

Returns:

Throws:

DeribitException

IOException

getCurrencies

@GET
@Path("get_currencies")
DeribitResponse<List<DeribitCurrency>> getCurrencies()
                                              throws DeribitException,
IOException

Retrieves available trading instruments. This method can be used to see which instruments are available for trading, or which instruments have existed historically.

Returns:

Throws:

DeribitException

IOException

getOrderBook

@GET
@Path("get_order_book")
DeribitResponse<DeribitOrderBook> getOrderBook(@QueryParam("instrument_name")
 String instrumentName,
 @QueryParam("depth")
 Integer depth)
                                        throws DeribitException,
IOException

Retrieves the order book, along with other market values for a given instrument.

Parameters:

instrumentName - required, the instrument name for which to retrieve the order book, see getInstruments to obtain instrument names.

depth - optional, the number of entries to return for bids and asks. max: 10000, default: 20

Returns:

Throws:

DeribitException

IOException

getHistoricalVolatility

@GET
@Path("get_historical_volatility")
DeribitResponse<List<List<BigDecimal>>> getHistoricalVolatility(@QueryParam("currency")
 String currency)
                                                         throws DeribitException,
IOException

Provides information about historical volatility for given cryptocurrency.

Parameters:

currency - required, the currency name for which to retrieve the historical volatility,the value can be BTC,ETH or USDT.

Returns:

Throws:

DeribitException

IOException

getLastTradesByInstrument

@GET
@Path("get_last_trades_by_instrument")
DeribitResponse<DeribitTrades> getLastTradesByInstrument(@QueryParam("instrument_name")
 String instrumentName,
 @QueryParam("start_seq")
 Integer startSeq,
 @QueryParam("end_seq")
 Integer endSeq,
 @QueryParam("count")
 Integer count,
 @QueryParam("include_old")
 Boolean includeOld,
 @QueryParam("sorting")
 String sorting)
                                                  throws DeribitException,
IOException

Retrieve the latest trades that have occurred for a specific instrument.

Parameters:

instrumentName - required, Instrument name

startSeq - optional, The sequence number of the first trade to be returned

endSeq - optional, The sequence number of the last trade to be returned

count - optional, Number of requested items, default: 10

includeOld - optional, Include trades older than 7 days, default: false

sorting - optional, (asc, desc, default) Direction of results sorting (default value means no sorting, results will be returned in order in which they left the database)

Returns:

Throws:

DeribitException

IOException

getSummaryByInstrument

@GET
@Path("get_book_summary_by_instrument")
DeribitResponse<List<DeribitSummary>> getSummaryByInstrument(@QueryParam("instrument_name")
 String instrumentName)
                                                      throws DeribitException,
IOException

Retrieves the summary information such as open interest, 24h volume, etc. for a specific instrument.

Parameters:

instrumentName - required, Instrument name

Returns:

Throws:

DeribitException

IOException

getTicker

@GET
@Path("ticker")
DeribitResponse<DeribitTicker> getTicker(@QueryParam("instrument_name")
 String instrumentName)
                                  throws DeribitException,
IOException

Get ticker for an instrument.

Parameters:

instrumentName - required, Instrument name

Returns:

Throws:

DeribitException

IOException

auth

@GET
@Path("auth")
DeribitResponse<DeribitAuthentication> auth(@QueryParam("grant_type")
 GrantType grantType,
 @QueryParam("username")
 String username,
 @QueryParam("password")
 String password,
 @QueryParam("client_id")
 String clientId,
 @QueryParam("client_secret")
 String clientSecret,
 @QueryParam("refresh_token")
 String refreshToken,
 @QueryParam("timestamp")
 String timestamp,
 @QueryParam("signature")
 String signature,
 @QueryParam("nonce")
 String nonce,
 @QueryParam("state")
 String state,
 @QueryParam("scope")
 String scope)
                                     throws DeribitException,
IOException

Retrieve an Oauth access token, to be used for authentication of 'private' requests.

Parameters:

grantType - Method of authentication

username - Required for grant type 'password'

password - Required for grant type 'password'

clientId - Required for grant type 'client_credentials' and 'client_signature'

clientSecret - Required for grant type 'client_credentials'

refreshToken - Required for grant type 'refresh_token'

timestamp - Required for grant type 'client_signature', provides time when request has been generated

signature - Required for grant type 'client_signature'; it's a cryptographic signature calculated over provided fields using user secret key. The signature should be calculated as an HMAC (Hash-based Message Authentication Code) with SHA256 hash algorithm

nonce - Optional for grant type 'client_signature'; delivers user generated initialization vector for the server token

state - Will be passed back in the response

scope - Describes type of the access for assigned token, possible values: connection, session, session:name, trade:[read, read_write, none], wallet:[read, read_write, none], account:[read, read_write, none], expires:NUMBER, ip:ADDR. NOTICE: Depending on choosing an authentication method (grant type) some scopes could be narrowed by the server. e.g. when grant_type = client_credentials and scope = wallet:read_write it's modified by the server as scope = wallet:read

Returns:

Throws:

DeribitException

IOException