Org.OpenAPITools.Api.InternalApi

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

Method	HTTP request	Description
PrivateAddToAddressBookGet	GET /private/add_to_address_book	Adds new entry to address book of given type
PrivateDisableTfaWithRecoveryCodeGet	GET /private/disable_tfa_with_recovery_code	Disables TFA with one time recovery code
PrivateGetAddressBookGet	GET /private/get_address_book	Retrieves address book of given type
PrivateRemoveFromAddressBookGet	GET /private/remove_from_address_book	Adds new entry to address book of given type
PrivateSubmitTransferToSubaccountGet	GET /private/submit_transfer_to_subaccount	Transfer funds to a subaccount.
PrivateSubmitTransferToUserGet	GET /private/submit_transfer_to_user	Transfer funds to a another user.
PrivateToggleDepositAddressCreationGet	GET /private/toggle_deposit_address_creation	Enable or disable deposit address creation
PublicGetFooterGet	GET /public/get_footer	Get information to be displayed in the footer of the website.
PublicGetOptionMarkPricesGet	GET /public/get_option_mark_prices	Retrives market prices and its implied volatility of options instruments
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.

PrivateAddToAddressBookGet

Object PrivateAddToAddressBookGet (string currency, string type, string address, string name, string tfa = null)

Adds new entry to address book of given type

Example

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

namespace Example
{
    public class PrivateAddToAddressBookGetExample
    {
        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 InternalApi(Configuration.Default);
            var currency = currency_example;  // string | The currency symbol
            var type = type_example;  // string | Address book type
            var address = address_example;  // string | Address in currency format, it must be in address book
            var name = Main address;  // string | Name of address book entry
            var tfa = tfa_example;  // string | TFA code, required when TFA is enabled for current account (optional) 

            try
            {
                // Adds new entry to address book of given type
                Object result = apiInstance.PrivateAddToAddressBookGet(currency, type, address, name, tfa);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PrivateAddToAddressBookGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
currency	string	The currency symbol
type	string	Address book type
address	string	Address in currency format, it must be in address book
name	string	Name of address book entry
tfa	string	TFA code, required when TFA is enabled for current account	[optional]

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PrivateDisableTfaWithRecoveryCodeGet

Object PrivateDisableTfaWithRecoveryCodeGet (string password, string code)

Disables TFA with one time recovery code

Example

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

namespace Example
{
    public class PrivateDisableTfaWithRecoveryCodeGetExample
    {
        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 InternalApi(Configuration.Default);
            var password = password_example;  // string | The password for the subaccount
            var code = code_example;  // string | One time recovery code

            try
            {
                // Disables TFA with one time recovery code
                Object result = apiInstance.PrivateDisableTfaWithRecoveryCodeGet(password, code);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PrivateDisableTfaWithRecoveryCodeGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
password	string	The password for the subaccount
code	string	One time recovery code

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PrivateGetAddressBookGet

Object PrivateGetAddressBookGet (string currency, string type)

Retrieves address book of given type

Example

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

namespace Example
{
    public class PrivateGetAddressBookGetExample
    {
        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 InternalApi(Configuration.Default);
            var currency = currency_example;  // string | The currency symbol
            var type = type_example;  // string | Address book type

            try
            {
                // Retrieves address book of given type
                Object result = apiInstance.PrivateGetAddressBookGet(currency, type);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PrivateGetAddressBookGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
currency	string	The currency symbol
type	string	Address book type

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PrivateRemoveFromAddressBookGet

Object PrivateRemoveFromAddressBookGet (string currency, string type, string address, string tfa = null)

Adds new entry to address book of given type

Example

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

namespace Example
{
    public class PrivateRemoveFromAddressBookGetExample
    {
        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 InternalApi(Configuration.Default);
            var currency = currency_example;  // string | The currency symbol
            var type = type_example;  // string | Address book type
            var address = address_example;  // string | Address in currency format, it must be in address book
            var tfa = tfa_example;  // string | TFA code, required when TFA is enabled for current account (optional) 

            try
            {
                // Adds new entry to address book of given type
                Object result = apiInstance.PrivateRemoveFromAddressBookGet(currency, type, address, tfa);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PrivateRemoveFromAddressBookGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
currency	string	The currency symbol
type	string	Address book type
address	string	Address in currency format, it must be in address book
tfa	string	TFA code, required when TFA is enabled for current account	[optional]

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PrivateSubmitTransferToSubaccountGet

Object PrivateSubmitTransferToSubaccountGet (string currency, decimal? amount, int? destination)

Transfer funds to a subaccount.

Example

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

namespace Example
{
    public class PrivateSubmitTransferToSubaccountGetExample
    {
        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 InternalApi(Configuration.Default);
            var currency = currency_example;  // string | The currency symbol
            var amount = 8.14;  // decimal? | Amount of funds to be transferred
            var destination = 1;  // int? | Id of destination subaccount

            try
            {
                // Transfer funds to a subaccount.
                Object result = apiInstance.PrivateSubmitTransferToSubaccountGet(currency, amount, destination);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PrivateSubmitTransferToSubaccountGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
currency	string	The currency symbol
amount	decimal?	Amount of funds to be transferred
destination	int?	Id of destination subaccount

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PrivateSubmitTransferToUserGet

Object PrivateSubmitTransferToUserGet (string currency, decimal? amount, string destination, string tfa = null)

Transfer funds to a another user.

Example

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

namespace Example
{
    public class PrivateSubmitTransferToUserGetExample
    {
        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 InternalApi(Configuration.Default);
            var currency = currency_example;  // string | The currency symbol
            var amount = 8.14;  // decimal? | Amount of funds to be transferred
            var destination = destination_example;  // string | Destination address from address book
            var tfa = tfa_example;  // string | TFA code, required when TFA is enabled for current account (optional) 

            try
            {
                // Transfer funds to a another user.
                Object result = apiInstance.PrivateSubmitTransferToUserGet(currency, amount, destination, tfa);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PrivateSubmitTransferToUserGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
currency	string	The currency symbol
amount	decimal?	Amount of funds to be transferred
destination	string	Destination address from address book
tfa	string	TFA code, required when TFA is enabled for current account	[optional]

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PrivateToggleDepositAddressCreationGet

Object PrivateToggleDepositAddressCreationGet (string currency, bool? state)

Enable or disable deposit address creation

Example

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

namespace Example
{
    public class PrivateToggleDepositAddressCreationGetExample
    {
        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 InternalApi(Configuration.Default);
            var currency = currency_example;  // string | The currency symbol
            var state = true;  // bool? | 

            try
            {
                // Enable or disable deposit address creation
                Object result = apiInstance.PrivateToggleDepositAddressCreationGet(currency, state);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PrivateToggleDepositAddressCreationGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
currency	string	The currency symbol
state	bool?

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicGetFooterGet

Object PublicGetFooterGet ()

Get information to be displayed in the footer of the website.

Example

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

namespace Example
{
    public class PublicGetFooterGetExample
    {
        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 InternalApi(Configuration.Default);

            try
            {
                // Get information to be displayed in the footer of the website.
                Object result = apiInstance.PublicGetFooterGet();
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PublicGetFooterGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicGetOptionMarkPricesGet

Object PublicGetOptionMarkPricesGet (string currency)

Retrives market prices and its implied volatility of options instruments

Example

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

namespace Example
{
    public class PublicGetOptionMarkPricesGetExample
    {
        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 InternalApi(Configuration.Default);
            var currency = currency_example;  // string | The currency symbol

            try
            {
                // Retrives market prices and its implied volatility of options instruments
                Object result = apiInstance.PublicGetOptionMarkPricesGet(currency);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PublicGetOptionMarkPricesGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
currency	string	The currency symbol

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PublicValidateFieldGet

Object PublicValidateFieldGet (string field, string value, string value2 = null)

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.

Example

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

namespace Example
{
    public class PublicValidateFieldGetExample
    {
        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 InternalApi(Configuration.Default);
            var field = field_example;  // string | Name of the field to be validated, examples: postal_code, date_of_birth
            var value = value_example;  // string | Value to be checked
            var value2 = value2_example;  // string | Additional value to be compared with (optional) 

            try
            {
                // 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.
                Object result = apiInstance.PublicValidateFieldGet(field, value, value2);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling InternalApi.PublicValidateFieldGet: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

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]

Return type

Object

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

InternalApi.md

Latest commit

History

InternalApi.md

File metadata and controls

Org.OpenAPITools.Api.InternalApi

PrivateAddToAddressBookGet

Example

Parameters

Return type

Authorization

HTTP request headers

PrivateDisableTfaWithRecoveryCodeGet

Example

Parameters

Return type

Authorization

HTTP request headers

PrivateGetAddressBookGet

Example

Parameters

Return type

Authorization

HTTP request headers

PrivateRemoveFromAddressBookGet

Example

Parameters

Return type

Authorization

HTTP request headers

PrivateSubmitTransferToSubaccountGet

Example

Parameters

Return type

Authorization

HTTP request headers

PrivateSubmitTransferToUserGet

Example

Parameters

Return type

Authorization

HTTP request headers

PrivateToggleDepositAddressCreationGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetFooterGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicGetOptionMarkPricesGet

Example

Parameters

Return type

Authorization

HTTP request headers

PublicValidateFieldGet

Example

Parameters

Return type

Authorization

HTTP request headers