Org.OpenAPITools.Api.PublicApi

All URIs are relative to https://www.deribit.com/api/v2

Method	HTTP request	Description
PublicAuthGet	GET /public/auth	Authenticate
PublicGetAnnouncementsGet	GET /public/get_announcements	Retrieves announcements from the last 30 days.
PublicGetBookSummaryByCurrencyGet	GET /public/get_book_summary_by_currency	Retrieves the summary information such as open interest, 24h volume, etc. for all instruments for the currency (optionally filtered by kind).
PublicGetBookSummaryByInstrumentGet	GET /public/get_book_summary_by_instrument	Retrieves the summary information such as open interest, 24h volume, etc. for a specific instrument.
PublicGetContractSizeGet	GET /public/get_contract_size	Retrieves contract size of provided instrument.
PublicGetCurrenciesGet	GET /public/get_currencies	Retrieves all cryptocurrencies supported by the API.
PublicGetFundingChartDataGet	GET /public/get_funding_chart_data	Retrieve the latest user trades that have occurred for PERPETUAL instruments in a specific currency symbol and within given time range.
PublicGetHistoricalVolatilityGet	GET /public/get_historical_volatility	Provides information about historical volatility for given cryptocurrency.
PublicGetIndexGet	GET /public/get_index	Retrieves the current index price for the instruments, for the selected currency.
PublicGetInstrumentsGet	GET /public/get_instruments	Retrieves available trading instruments. This method can be used to see which instruments are available for trading, or which instruments have existed historically.
PublicGetLastSettlementsByCurrencyGet	GET /public/get_last_settlements_by_currency	Retrieves historical settlement, delivery and bankruptcy events coming from all instruments within given currency.
PublicGetLastSettlementsByInstrumentGet	GET /public/get_last_settlements_by_instrument	Retrieves historical public settlement, delivery and bankruptcy events filtered by instrument name.
PublicGetLastTradesByCurrencyAndTimeGet	GET /public/get_last_trades_by_currency_and_time	Retrieve the latest trades that have occurred for instruments in a specific currency symbol and within given time range.
PublicGetLastTradesByCurrencyGet	GET /public/get_last_trades_by_currency	Retrieve the latest trades that have occurred for instruments in a specific currency symbol.
PublicGetLastTradesByInstrumentAndTimeGet	GET /public/get_last_trades_by_instrument_and_time	Retrieve the latest trades that have occurred for a specific instrument and within given time range.
PublicGetLastTradesByInstrumentGet	GET /public/get_last_trades_by_instrument	Retrieve the latest trades that have occurred for a specific instrument.
PublicGetOrderBookGet	GET /public/get_order_book	Retrieves the order book, along with other market values for a given instrument.
PublicGetTimeGet	GET /public/get_time	Retrieves the current time (in milliseconds). This API endpoint can be used to check the clock skew between your software and Deribit's systems.
PublicGetTradeVolumesGet	GET /public/get_trade_volumes	Retrieves aggregated 24h trade volumes for different instrument types and currencies.
PublicGetTradingviewChartDataGet	GET /public/get_tradingview_chart_data	Publicly available market data used to generate a TradingView candle chart.
PublicTestGet	GET /public/test	Tests the connection to the API server, and returns its version. You can use this to make sure the API is reachable, and matches the expected version.
PublicTickerGet	GET /public/ticker	Get ticker for an instrument.
PublicValidateFieldGet	GET /public/validate_field	Method used to introduce the client software connected to Deribit platform over websocket. Provided data may have an impact on the maintained connection and will be collected for internal statistical purposes. In response, Deribit will also introduce itself.

PublicAuthGet

Object PublicAuthGet (string grantType, string username, string password, string clientId, string clientSecret, string refreshToken, string timestamp, string signature, string nonce = null, string state = null, string scope = null)

Authenticate

Retrieve an Oauth access token, to be used for authentication of 'private' requests. Three methods of authentication are supported: - password - using email and and password as when logging on to the website - client_credentials - using the access key and access secret that can be found on the API page on the website - client_signature - using the access key that can be found on the API page on the website and user generated signature. The signature is calculated using some fields provided in the request, using formula described here Deribit signature credentials - refresh_token - using a refresh token that was received from an earlier invocation The response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens.

Example

using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class PublicAuthGetExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://www.deribit.com/api/v2";
            // Configure HTTP basic authorization: bearerAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new PublicApi(Configuration.Default);
            var grantType = grantType_example;  // string | Method of authentication
            var username = your_email@mail.com;  // string | Required for grant type `password`
            var password = your_password;  // string | Required for grant type `password`
            var clientId = clientId_example;  // string | Required for grant type `client_credentials` and `client_signature`
            var clientSecret = clientSecret_example;  // string | Required for grant type `client_credentials`
            var refreshToken = refreshToken_example;  // string | Required for grant type `refresh_token`
            var timestamp = timestamp_example;  // string | Required for grant type `client_signature`, provides time when request has been generated
            var signature = signature_example;  // string | 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
            var nonce = nonce_example;  // string | Optional for grant type `client_signature`; delivers user generated initialization vector for the server token (optional) 
            var state = state_example;  // string | Will be passed back in the response (optional) 
            var scope = connection;  // string | 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` (token will expire after `NUMBER` of seconds).</BR></BR> **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``` (optional) 

            try
            {
                // Authenticate
                Object result = apiInstance.PublicAuthGet(grantType, username, password, clientId, clientSecret, refreshToken, timestamp, signature, nonce, state, scope);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling PublicApi.PublicAuthGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
grantType	string	Method of authentication
username	string	Required for grant type `password`
password	string	Required for grant type `password`
clientId	string	Required for grant type `client_credentials` and `client_signature`
clientSecret	string	Required for grant type `client_credentials`
refreshToken	string	Required for grant type `refresh_token`
timestamp	string	Required for grant type `client_signature`, provides time when request has been generated
signature	string	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	string	Optional for grant type `client_signature`; delivers user generated initialization vector for the server token	[optional]
state	string	Will be passed back in the response	[optional]
scope	string	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` (token will expire after `NUMBER` of seconds).</BR></BR> 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```	[optional]

Return type

Object

Name	Type	Description	Notes
currency	string	The currency symbol
kind	string	Instrument kind, if not provided instruments of all kinds are considered	[optional]

Name	Type	Description	Notes
instrumentName	string	Instrument name
length	string	Specifies time period. `8h` - 8 hours, `24h` - 24 hours	[optional]

Name	Type	Description	Notes
instrumentName	string	The instrument name for which to retrieve the order book, see `getinstruments` to obtain instrument names.
depth	decimal?	The number of entries to return for bids and asks.	[optional]

Name	Type	Description	Notes
field	string	Name of the field to be validated, examples: postal_code, date_of_birth
value	string	Value to be checked
value2	string	Additional value to be compared with	[optional]

Name	Type	Description	Notes
instrumentName	string	Instrument name
startTimestamp	int?	The earliest timestamp to return result for
endTimestamp	int?	The most recent timestamp to return result for
count	int?	Number of requested items, default - `10`	[optional]
includeOld	bool?	Include trades older than 7 days, default - `false`	[optional]
sorting	string	Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database)	[optional]

Name	Type	Description	Notes
instrumentName	string	Instrument name
startSeq	int?	The sequence number of the first trade to be returned	[optional]
endSeq	int?	The sequence number of the last trade to be returned	[optional]
count	int?	Number of requested items, default - `10`	[optional]
includeOld	bool?	Include trades older than 7 days, default - `false`	[optional]
sorting	string	Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database)	[optional]

Files

PublicApi.md

Latest commit

History

PublicApi.md

File metadata and controls

Org.OpenAPITools.Api.PublicApi

PublicAuthGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetAnnouncementsGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetBookSummaryByCurrencyGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetBookSummaryByInstrumentGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetContractSizeGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetCurrenciesGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetFundingChartDataGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetHistoricalVolatilityGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetIndexGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetInstrumentsGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetLastSettlementsByCurrencyGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetLastSettlementsByInstrumentGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetLastTradesByCurrencyAndTimeGet