AuthenticationApi.md

Org.OpenAPITools.Api.AuthenticationApi

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

Method	HTTP request	Description
PublicAuthGet	GET /public/auth	Authenticate

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 AuthenticationApi(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 AuthenticationApi.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

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]