Mining Development Kit API

Authentication

apiV1AuthLogoutPost

User logout

Validates and blacklists JWT tokens, effectively logging out the user.


/api/v1/auth/logout

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/auth/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AuthenticationApi apiInstance = new AuthenticationApi();
        AuthTokens body = ; // AuthTokens | 
        try {
            MessageResponse result = apiInstance.apiV1AuthLogoutPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#apiV1AuthLogoutPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        AuthTokens body = ; // AuthTokens | 
        try {
            MessageResponse result = apiInstance.apiV1AuthLogoutPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#apiV1AuthLogoutPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
AuthTokens *body = ; // 

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// User logout
[apiInstance apiV1AuthLogoutPostWith:body
              completionHandler: ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.AuthenticationApi()
var body = ; // {{AuthTokens}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiV1AuthLogoutPost(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiV1AuthLogoutPostExample
    {
        public void main()
        {


            var apiInstance = new AuthenticationApi();
            var body = new AuthTokens(); // AuthTokens | 

            try
            {
                // User logout
                MessageResponse result = apiInstance.apiV1AuthLogoutPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.apiV1AuthLogoutPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAuthenticationApi();
$body = ; // AuthTokens | 

try {
    $result = $api_instance->apiV1AuthLogoutPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->apiV1AuthLogoutPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;


my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();
my $body = WWW::SwaggerClient::Object::AuthTokens->new(); # AuthTokens | 

eval { 
    my $result = $api_instance->apiV1AuthLogoutPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->apiV1AuthLogoutPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
body =  # AuthTokens | 

try: 
    # User logout
    api_response = api_instance.api_v1_auth_logout_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->apiV1AuthLogoutPost: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successful logout.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 500 - Internal server error.


apiV1AuthRefreshPost

Refresh JWT access token

Validates the provided refresh token and returns a new JWT access token.


/api/v1/auth/refresh

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/auth/refresh"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        RefreshRequest body = ; // RefreshRequest | 
        try {
            RefreshResponse result = apiInstance.apiV1AuthRefreshPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#apiV1AuthRefreshPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        RefreshRequest body = ; // RefreshRequest | 
        try {
            RefreshResponse result = apiInstance.apiV1AuthRefreshPost(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#apiV1AuthRefreshPost");
            e.printStackTrace();
        }
    }
}
RefreshRequest *body = ; // 

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Refresh JWT access token
[apiInstance apiV1AuthRefreshPostWith:body
              completionHandler: ^(RefreshResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.AuthenticationApi()
var body = ; // {{RefreshRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiV1AuthRefreshPost(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiV1AuthRefreshPostExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();
            var body = new RefreshRequest(); // RefreshRequest | 

            try
            {
                // Refresh JWT access token
                RefreshResponse result = apiInstance.apiV1AuthRefreshPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.apiV1AuthRefreshPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();
$body = ; // RefreshRequest | 

try {
    $result = $api_instance->apiV1AuthRefreshPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->apiV1AuthRefreshPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();
my $body = WWW::SwaggerClient::Object::RefreshRequest->new(); # RefreshRequest | 

eval { 
    my $result = $api_instance->apiV1AuthRefreshPost(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->apiV1AuthRefreshPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
body =  # RefreshRequest | 

try: 
    # Refresh JWT access token
    api_response = api_instance.api_v1_auth_refresh_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->apiV1AuthRefreshPost: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successful refresh, returns a new access token.

Status: 400 - Bad request.

Status: 401 - Unauthorized, invalid or expired refresh token.

Status: 500 - Internal server error.


login

Authenticates a user using a password and returns a JWT access and refresh token pair.


/api/v1/auth/login

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/auth/login"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        PasswordRequest body = ; // PasswordRequest | 
        try {
            AuthTokens result = apiInstance.login(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#login");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        PasswordRequest body = ; // PasswordRequest | 
        try {
            AuthTokens result = apiInstance.login(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#login");
            e.printStackTrace();
        }
    }
}
PasswordRequest *body = ; // 

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

[apiInstance loginWith:body
              completionHandler: ^(AuthTokens output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.AuthenticationApi()
var body = ; // {{PasswordRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class loginExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();
            var body = new PasswordRequest(); // PasswordRequest | 

            try
            {
                AuthTokens result = apiInstance.login(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();
$body = ; // PasswordRequest | 

try {
    $result = $api_instance->login($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();
my $body = WWW::SwaggerClient::Object::PasswordRequest->new(); # PasswordRequest | 

eval { 
    my $result = $api_instance->login(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->login: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
body =  # PasswordRequest | 

try: 
    api_response = api_instance.login(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->login: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successful login, returns JWT tokens.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden.

Status: 500 - Internal server error.


setPassword

The password endpoint allows users to set a password during onboarding


/api/v1/auth/password

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/auth/password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        PasswordRequest body = ; // PasswordRequest | 
        try {
            MessageResponse result = apiInstance.setPassword(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#setPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        PasswordRequest body = ; // PasswordRequest | 
        try {
            MessageResponse result = apiInstance.setPassword(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#setPassword");
            e.printStackTrace();
        }
    }
}
PasswordRequest *body = ; // 

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

[apiInstance setPasswordWith:body
              completionHandler: ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.AuthenticationApi()
var body = ; // {{PasswordRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setPassword(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setPasswordExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();
            var body = new PasswordRequest(); // PasswordRequest | 

            try
            {
                MessageResponse result = apiInstance.setPassword(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.setPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();
$body = ; // PasswordRequest | 

try {
    $result = $api_instance->setPassword($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->setPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();
my $body = WWW::SwaggerClient::Object::PasswordRequest->new(); # PasswordRequest | 

eval { 
    my $result = $api_instance->setPassword(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->setPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()
body =  # PasswordRequest | 

try: 
    api_response = api_instance.set_password(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->setPassword: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Password successfully set.

Status: 400 - Bad request.

Status: 403 - Forbidden.

Status: 500 - Internal server error.


Cooling

getCooling

The cooling endpoint provides information on the cooling status of the device, including mode and current fan RPM.


/api/v1/cooling

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/cooling"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CoolingApi;

import java.io.File;
import java.util.*;

public class CoolingApiExample {

    public static void main(String[] args) {
        
        CoolingApi apiInstance = new CoolingApi();
        try {
            CoolingStatus result = apiInstance.getCooling();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CoolingApi#getCooling");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CoolingApi;

public class CoolingApiExample {

    public static void main(String[] args) {
        CoolingApi apiInstance = new CoolingApi();
        try {
            CoolingStatus result = apiInstance.getCooling();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CoolingApi#getCooling");
            e.printStackTrace();
        }
    }
}

CoolingApi *apiInstance = [[CoolingApi alloc] init];

[apiInstance getCoolingWithCompletionHandler: 
              ^(CoolingStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.CoolingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCooling(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCoolingExample
    {
        public void main()
        {

            var apiInstance = new CoolingApi();

            try
            {
                CoolingStatus result = apiInstance.getCooling();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CoolingApi.getCooling: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCoolingApi();

try {
    $result = $api_instance->getCooling();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoolingApi->getCooling: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CoolingApi;

my $api_instance = WWW::SwaggerClient::CoolingApi->new();

eval { 
    my $result = $api_instance->getCooling();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CoolingApi->getCooling: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CoolingApi()

try: 
    api_response = api_instance.get_cooling()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CoolingApi->getCooling: %s\n" % e)

Parameters

Responses

Status: 200 - Cooling status successfully returned.

Status: 500 - Internal server error.


setCoolingMode

The cooling configuration endpoint allows the user to control the fan mode.


/api/v1/cooling

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/cooling"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CoolingApi;

import java.io.File;
import java.util.*;

public class CoolingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CoolingApi apiInstance = new CoolingApi();
        CoolingConfig body = ; // CoolingConfig | 
        try {
            CoolingConfig result = apiInstance.setCoolingMode(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CoolingApi#setCoolingMode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CoolingApi;

public class CoolingApiExample {

    public static void main(String[] args) {
        CoolingApi apiInstance = new CoolingApi();
        CoolingConfig body = ; // CoolingConfig | 
        try {
            CoolingConfig result = apiInstance.setCoolingMode(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CoolingApi#setCoolingMode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
CoolingConfig *body = ; // 

CoolingApi *apiInstance = [[CoolingApi alloc] init];

[apiInstance setCoolingModeWith:body
              completionHandler: ^(CoolingConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.CoolingApi()
var body = ; // {{CoolingConfig}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setCoolingMode(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setCoolingModeExample
    {
        public void main()
        {


            var apiInstance = new CoolingApi();
            var body = new CoolingConfig(); // CoolingConfig | 

            try
            {
                CoolingConfig result = apiInstance.setCoolingMode(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CoolingApi.setCoolingMode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCoolingApi();
$body = ; // CoolingConfig | 

try {
    $result = $api_instance->setCoolingMode($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CoolingApi->setCoolingMode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CoolingApi;


my $api_instance = WWW::SwaggerClient::CoolingApi->new();
my $body = WWW::SwaggerClient::Object::CoolingConfig->new(); # CoolingConfig | 

eval { 
    my $result = $api_instance->setCoolingMode(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CoolingApi->setCoolingMode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.CoolingApi()
body =  # CoolingConfig | 

try: 
    api_response = api_instance.set_cooling_mode(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CoolingApi->setCoolingMode: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The cooling configuration has been successfully updated.

Status: 400 - Bad request.

Status: 401 - Authentication failed.

Status: 500 - Internal server error.

Status: 501 - Not implemented error - mode specified not supported/implemented.


Efficiency

getHashboardEfficiency

The efficiency endpoint provides hashboard-level historical operation data.


/api/v1/efficiency/{hb_sn}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/efficiency/{hb_sn}?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EfficiencyApi;

import java.io.File;
import java.util.*;

public class EfficiencyApiExample {

    public static void main(String[] args) {
        
        EfficiencyApi apiInstance = new EfficiencyApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide power information for.
        String duration = duration_example; // String | 
        try {
            EfficiencyResponse result = apiInstance.getHashboardEfficiency(hbSn, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EfficiencyApi#getHashboardEfficiency");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EfficiencyApi;

public class EfficiencyApiExample {

    public static void main(String[] args) {
        EfficiencyApi apiInstance = new EfficiencyApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide power information for.
        String duration = duration_example; // String | 
        try {
            EfficiencyResponse result = apiInstance.getHashboardEfficiency(hbSn, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EfficiencyApi#getHashboardEfficiency");
            e.printStackTrace();
        }
    }
}
String *hbSn = hbSn_example; // The serial number of the hashboard to provide power information for.
String *duration = duration_example; //  (optional) (default to 12h)

EfficiencyApi *apiInstance = [[EfficiencyApi alloc] init];

[apiInstance getHashboardEfficiencyWith:hbSn
    duration:duration
              completionHandler: ^(EfficiencyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.EfficiencyApi()
var hbSn = hbSn_example; // {{String}} The serial number of the hashboard to provide power information for.
var opts = { 
  'duration': duration_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHashboardEfficiency(hbSn, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHashboardEfficiencyExample
    {
        public void main()
        {

            var apiInstance = new EfficiencyApi();
            var hbSn = hbSn_example;  // String | The serial number of the hashboard to provide power information for.
            var duration = duration_example;  // String |  (optional)  (default to 12h)

            try
            {
                EfficiencyResponse result = apiInstance.getHashboardEfficiency(hbSn, duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EfficiencyApi.getHashboardEfficiency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEfficiencyApi();
$hbSn = hbSn_example; // String | The serial number of the hashboard to provide power information for.
$duration = duration_example; // String | 

try {
    $result = $api_instance->getHashboardEfficiency($hbSn, $duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EfficiencyApi->getHashboardEfficiency: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EfficiencyApi;

my $api_instance = WWW::SwaggerClient::EfficiencyApi->new();
my $hbSn = hbSn_example; # String | The serial number of the hashboard to provide power information for.
my $duration = duration_example; # String | 

eval { 
    my $result = $api_instance->getHashboardEfficiency(hbSn => $hbSn, duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EfficiencyApi->getHashboardEfficiency: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EfficiencyApi()
hbSn = hbSn_example # String | The serial number of the hashboard to provide power information for.
duration = duration_example # String |  (optional) (default to 12h)

try: 
    api_response = api_instance.get_hashboard_efficiency(hbSn, duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EfficiencyApi->getHashboardEfficiency: %s\n" % e)

Parameters

Path parameters
Name Description
hb_sn*
String
The serial number of the hashboard to provide power information for.
Required
Query parameters
Name Description
duration
String

Responses

Status: 200 - Successfully returned the requested miner-level efficiency data.

Status: 400 - Bad request.

Status: 500 - Internal server error.


getMinerEfficiency

The efficiency endpoint provides miner-level historical power operation data.


/api/v1/efficiency

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/efficiency?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EfficiencyApi;

import java.io.File;
import java.util.*;

public class EfficiencyApiExample {

    public static void main(String[] args) {
        
        EfficiencyApi apiInstance = new EfficiencyApi();
        String duration = duration_example; // String | 
        try {
            EfficiencyResponse result = apiInstance.getMinerEfficiency(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EfficiencyApi#getMinerEfficiency");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EfficiencyApi;

public class EfficiencyApiExample {

    public static void main(String[] args) {
        EfficiencyApi apiInstance = new EfficiencyApi();
        String duration = duration_example; // String | 
        try {
            EfficiencyResponse result = apiInstance.getMinerEfficiency(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EfficiencyApi#getMinerEfficiency");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; //  (optional) (default to 12h)

EfficiencyApi *apiInstance = [[EfficiencyApi alloc] init];

[apiInstance getMinerEfficiencyWith:duration
              completionHandler: ^(EfficiencyResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.EfficiencyApi()
var opts = { 
  'duration': duration_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMinerEfficiency(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMinerEfficiencyExample
    {
        public void main()
        {

            var apiInstance = new EfficiencyApi();
            var duration = duration_example;  // String |  (optional)  (default to 12h)

            try
            {
                EfficiencyResponse result = apiInstance.getMinerEfficiency(duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EfficiencyApi.getMinerEfficiency: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEfficiencyApi();
$duration = duration_example; // String | 

try {
    $result = $api_instance->getMinerEfficiency($duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EfficiencyApi->getMinerEfficiency: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EfficiencyApi;

my $api_instance = WWW::SwaggerClient::EfficiencyApi->new();
my $duration = duration_example; # String | 

eval { 
    my $result = $api_instance->getMinerEfficiency(duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EfficiencyApi->getMinerEfficiency: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EfficiencyApi()
duration = duration_example # String |  (optional) (default to 12h)

try: 
    api_response = api_instance.get_miner_efficiency(duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EfficiencyApi->getMinerEfficiency: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String

Responses

Status: 200 - Successfully returned the requested miner-level efficiency data.

Status: 400 - Bad request.

Status: 500 - Internal server error.


Errors

getErrors

The errors endpoint provides alerts to be surfaced on the UI with different severity levels such as errors or warnings. This endpoint should be polled periodically to surface any issues that arise during mining operation.


/api/v1/errors

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/errors"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ErrorsApi;

import java.io.File;
import java.util.*;

public class ErrorsApiExample {

    public static void main(String[] args) {
        
        ErrorsApi apiInstance = new ErrorsApi();
        try {
            ErrorListResponse result = apiInstance.getErrors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ErrorsApi#getErrors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ErrorsApi;

public class ErrorsApiExample {

    public static void main(String[] args) {
        ErrorsApi apiInstance = new ErrorsApi();
        try {
            ErrorListResponse result = apiInstance.getErrors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ErrorsApi#getErrors");
            e.printStackTrace();
        }
    }
}

ErrorsApi *apiInstance = [[ErrorsApi alloc] init];

[apiInstance getErrorsWithCompletionHandler: 
              ^(ErrorListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.ErrorsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getErrors(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getErrorsExample
    {
        public void main()
        {

            var apiInstance = new ErrorsApi();

            try
            {
                ErrorListResponse result = apiInstance.getErrors();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ErrorsApi.getErrors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiErrorsApi();

try {
    $result = $api_instance->getErrors();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ErrorsApi->getErrors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ErrorsApi;

my $api_instance = WWW::SwaggerClient::ErrorsApi->new();

eval { 
    my $result = $api_instance->getErrors();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ErrorsApi->getErrors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ErrorsApi()

try: 
    api_response = api_instance.get_errors()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ErrorsApi->getErrors: %s\n" % e)

Parameters

Responses

Status: 200 - Array of currently active errors.

Status: 400 - Bad request.

Status: 500 - Internal server error.


Hashboards

getAllHashboards

The hashboards endpoint provides information about all of the hashboards connected to the system, including firmware version, MCU, ASIC count, API version, and hardware serial numbers.


/api/v1/hashboards

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/hashboards"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HashboardsApi;

import java.io.File;
import java.util.*;

public class HashboardsApiExample {

    public static void main(String[] args) {
        
        HashboardsApi apiInstance = new HashboardsApi();
        try {
            HashboardsInfo result = apiInstance.getAllHashboards();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashboardsApi#getAllHashboards");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HashboardsApi;

public class HashboardsApiExample {

    public static void main(String[] args) {
        HashboardsApi apiInstance = new HashboardsApi();
        try {
            HashboardsInfo result = apiInstance.getAllHashboards();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashboardsApi#getAllHashboards");
            e.printStackTrace();
        }
    }
}

HashboardsApi *apiInstance = [[HashboardsApi alloc] init];

[apiInstance getAllHashboardsWithCompletionHandler: 
              ^(HashboardsInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.HashboardsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllHashboards(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllHashboardsExample
    {
        public void main()
        {

            var apiInstance = new HashboardsApi();

            try
            {
                HashboardsInfo result = apiInstance.getAllHashboards();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HashboardsApi.getAllHashboards: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHashboardsApi();

try {
    $result = $api_instance->getAllHashboards();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HashboardsApi->getAllHashboards: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HashboardsApi;

my $api_instance = WWW::SwaggerClient::HashboardsApi->new();

eval { 
    my $result = $api_instance->getAllHashboards();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HashboardsApi->getAllHashboards: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HashboardsApi()

try: 
    api_response = api_instance.get_all_hashboards()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HashboardsApi->getAllHashboards: %s\n" % e)

Parameters

Responses

Status: 200 - All hashboard information

Status: 500 - Internal server error.


getAsicStatus

The hashboard status endpoint returns current operating statistics for a single ASIC on the specified hashboard in the system based on serial number and ASIC ID.


/api/v1/hashboards/{hb_sn}/{asic_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/hashboards/{hb_sn}/{asic_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HashboardsApi;

import java.io.File;
import java.util.*;

public class HashboardsApiExample {

    public static void main(String[] args) {
        
        HashboardsApi apiInstance = new HashboardsApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide statistics for.
        String asicId = asicId_example; // String | The id of an ASIC to provide statistics for.
        try {
            AsicStatsResponse result = apiInstance.getAsicStatus(hbSn, asicId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashboardsApi#getAsicStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HashboardsApi;

public class HashboardsApiExample {

    public static void main(String[] args) {
        HashboardsApi apiInstance = new HashboardsApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide statistics for.
        String asicId = asicId_example; // String | The id of an ASIC to provide statistics for.
        try {
            AsicStatsResponse result = apiInstance.getAsicStatus(hbSn, asicId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashboardsApi#getAsicStatus");
            e.printStackTrace();
        }
    }
}
String *hbSn = hbSn_example; // The serial number of the hashboard to provide statistics for.
String *asicId = asicId_example; // The id of an ASIC to provide statistics for.

HashboardsApi *apiInstance = [[HashboardsApi alloc] init];

[apiInstance getAsicStatusWith:hbSn
    asicId:asicId
              completionHandler: ^(AsicStatsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.HashboardsApi()
var hbSn = hbSn_example; // {{String}} The serial number of the hashboard to provide statistics for.
var asicId = asicId_example; // {{String}} The id of an ASIC to provide statistics for.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAsicStatus(hbSn, asicId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAsicStatusExample
    {
        public void main()
        {

            var apiInstance = new HashboardsApi();
            var hbSn = hbSn_example;  // String | The serial number of the hashboard to provide statistics for.
            var asicId = asicId_example;  // String | The id of an ASIC to provide statistics for.

            try
            {
                AsicStatsResponse result = apiInstance.getAsicStatus(hbSn, asicId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HashboardsApi.getAsicStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHashboardsApi();
$hbSn = hbSn_example; // String | The serial number of the hashboard to provide statistics for.
$asicId = asicId_example; // String | The id of an ASIC to provide statistics for.

try {
    $result = $api_instance->getAsicStatus($hbSn, $asicId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HashboardsApi->getAsicStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HashboardsApi;

my $api_instance = WWW::SwaggerClient::HashboardsApi->new();
my $hbSn = hbSn_example; # String | The serial number of the hashboard to provide statistics for.
my $asicId = asicId_example; # String | The id of an ASIC to provide statistics for.

eval { 
    my $result = $api_instance->getAsicStatus(hbSn => $hbSn, asicId => $asicId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HashboardsApi->getAsicStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HashboardsApi()
hbSn = hbSn_example # String | The serial number of the hashboard to provide statistics for.
asicId = asicId_example # String | The id of an ASIC to provide statistics for.

try: 
    api_response = api_instance.get_asic_status(hbSn, asicId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HashboardsApi->getAsicStatus: %s\n" % e)

Parameters

Path parameters
Name Description
hb_sn*
String
The serial number of the hashboard to provide statistics for.
Required
asic_id*
String
The id of an ASIC to provide statistics for.
Required

Responses

Status: 200 - Successfully returned the statistics for the specified ASIC on specified hashboard.

Status: 400 - Bad request.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


getHashboardLogs

The hashboard logs endpoint provides the most recent log lines from the specified hashboard.


/api/v1/hashboards/{hb_sn}/logs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/hashboards/{hb_sn}/logs?lines="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HashboardsApi;

import java.io.File;
import java.util.*;

public class HashboardsApiExample {

    public static void main(String[] args) {
        
        HashboardsApi apiInstance = new HashboardsApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide statistics for.
        Integer lines = 56; // Integer | The number of most recent logs to return. Maximum of 500, defaults to 100.
        try {
            LogsResponse result = apiInstance.getHashboardLogs(hbSn, lines);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashboardsApi#getHashboardLogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HashboardsApi;

public class HashboardsApiExample {

    public static void main(String[] args) {
        HashboardsApi apiInstance = new HashboardsApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide statistics for.
        Integer lines = 56; // Integer | The number of most recent logs to return. Maximum of 500, defaults to 100.
        try {
            LogsResponse result = apiInstance.getHashboardLogs(hbSn, lines);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashboardsApi#getHashboardLogs");
            e.printStackTrace();
        }
    }
}
String *hbSn = hbSn_example; // The serial number of the hashboard to provide statistics for.
Integer *lines = 56; // The number of most recent logs to return. Maximum of 500, defaults to 100. (optional) (default to 100)

HashboardsApi *apiInstance = [[HashboardsApi alloc] init];

[apiInstance getHashboardLogsWith:hbSn
    lines:lines
              completionHandler: ^(LogsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.HashboardsApi()
var hbSn = hbSn_example; // {{String}} The serial number of the hashboard to provide statistics for.
var opts = { 
  'lines': 56 // {{Integer}} The number of most recent logs to return. Maximum of 500, defaults to 100.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHashboardLogs(hbSn, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHashboardLogsExample
    {
        public void main()
        {

            var apiInstance = new HashboardsApi();
            var hbSn = hbSn_example;  // String | The serial number of the hashboard to provide statistics for.
            var lines = 56;  // Integer | The number of most recent logs to return. Maximum of 500, defaults to 100. (optional)  (default to 100)

            try
            {
                LogsResponse result = apiInstance.getHashboardLogs(hbSn, lines);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HashboardsApi.getHashboardLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHashboardsApi();
$hbSn = hbSn_example; // String | The serial number of the hashboard to provide statistics for.
$lines = 56; // Integer | The number of most recent logs to return. Maximum of 500, defaults to 100.

try {
    $result = $api_instance->getHashboardLogs($hbSn, $lines);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HashboardsApi->getHashboardLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HashboardsApi;

my $api_instance = WWW::SwaggerClient::HashboardsApi->new();
my $hbSn = hbSn_example; # String | The serial number of the hashboard to provide statistics for.
my $lines = 56; # Integer | The number of most recent logs to return. Maximum of 500, defaults to 100.

eval { 
    my $result = $api_instance->getHashboardLogs(hbSn => $hbSn, lines => $lines);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HashboardsApi->getHashboardLogs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HashboardsApi()
hbSn = hbSn_example # String | The serial number of the hashboard to provide statistics for.
lines = 56 # Integer | The number of most recent logs to return. Maximum of 500, defaults to 100. (optional) (default to 100)

try: 
    api_response = api_instance.get_hashboard_logs(hbSn, lines=lines)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HashboardsApi->getHashboardLogs: %s\n" % e)

Parameters

Path parameters
Name Description
hb_sn*
String
The serial number of the hashboard to provide statistics for.
Required
Query parameters
Name Description
lines
Integer
The number of most recent logs to return. Maximum of 500, defaults to 100.

Responses

Status: 200 - Successfully returned the statistics information for the specified hashboard.

Status: 400 - Bad request.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


getHashboardStatus

The hashboard status endpoint returns current operating statistics for a single hashboard in the system based on its serial number.


/api/v1/hashboards/{hb_sn}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/hashboards/{hb_sn}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HashboardsApi;

import java.io.File;
import java.util.*;

public class HashboardsApiExample {

    public static void main(String[] args) {
        
        HashboardsApi apiInstance = new HashboardsApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide statistics for.
        try {
            HashboardStats result = apiInstance.getHashboardStatus(hbSn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashboardsApi#getHashboardStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HashboardsApi;

public class HashboardsApiExample {

    public static void main(String[] args) {
        HashboardsApi apiInstance = new HashboardsApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide statistics for.
        try {
            HashboardStats result = apiInstance.getHashboardStatus(hbSn);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashboardsApi#getHashboardStatus");
            e.printStackTrace();
        }
    }
}
String *hbSn = hbSn_example; // The serial number of the hashboard to provide statistics for.

HashboardsApi *apiInstance = [[HashboardsApi alloc] init];

[apiInstance getHashboardStatusWith:hbSn
              completionHandler: ^(HashboardStats output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.HashboardsApi()
var hbSn = hbSn_example; // {{String}} The serial number of the hashboard to provide statistics for.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHashboardStatus(hbSn, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHashboardStatusExample
    {
        public void main()
        {

            var apiInstance = new HashboardsApi();
            var hbSn = hbSn_example;  // String | The serial number of the hashboard to provide statistics for.

            try
            {
                HashboardStats result = apiInstance.getHashboardStatus(hbSn);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HashboardsApi.getHashboardStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHashboardsApi();
$hbSn = hbSn_example; // String | The serial number of the hashboard to provide statistics for.

try {
    $result = $api_instance->getHashboardStatus($hbSn);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HashboardsApi->getHashboardStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HashboardsApi;

my $api_instance = WWW::SwaggerClient::HashboardsApi->new();
my $hbSn = hbSn_example; # String | The serial number of the hashboard to provide statistics for.

eval { 
    my $result = $api_instance->getHashboardStatus(hbSn => $hbSn);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HashboardsApi->getHashboardStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HashboardsApi()
hbSn = hbSn_example # String | The serial number of the hashboard to provide statistics for.

try: 
    api_response = api_instance.get_hashboard_status(hbSn)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HashboardsApi->getHashboardStatus: %s\n" % e)

Parameters

Path parameters
Name Description
hb_sn*
String
The serial number of the hashboard to provide statistics for.
Required

Responses

Status: 200 - Successfully returned the statistics information for the specified hashboard.

Status: 400 - Bad request.

Status: 500 - Internal server error.


Hashrate

getAsicHashrate

The hashrate endpoint provides ASIC-level historical hashrate operation data.


/api/v1/hashrate/{hb_sn}/{asic_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/hashrate/{hb_sn}/{asic_id}?duration=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HashrateApi;

import java.io.File;
import java.util.*;

public class HashrateApiExample {

    public static void main(String[] args) {
        
        HashrateApi apiInstance = new HashrateApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide hashrate information for.
        Integer asicId = 56; // Integer | The ID of the ASIC to provide hashrate information for.
        String duration = duration_example; // String | 
        String granularity = granularity_example; // String | 
        try {
            HashrateResponse result = apiInstance.getAsicHashrate(hbSn, asicId, duration, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashrateApi#getAsicHashrate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HashrateApi;

public class HashrateApiExample {

    public static void main(String[] args) {
        HashrateApi apiInstance = new HashrateApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide hashrate information for.
        Integer asicId = 56; // Integer | The ID of the ASIC to provide hashrate information for.
        String duration = duration_example; // String | 
        String granularity = granularity_example; // String | 
        try {
            HashrateResponse result = apiInstance.getAsicHashrate(hbSn, asicId, duration, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashrateApi#getAsicHashrate");
            e.printStackTrace();
        }
    }
}
String *hbSn = hbSn_example; // The serial number of the hashboard to provide hashrate information for.
Integer *asicId = 56; // The ID of the ASIC to provide hashrate information for.
String *duration = duration_example; //  (optional) (default to 12h)
String *granularity = granularity_example; //  (optional) (default to 1m)

HashrateApi *apiInstance = [[HashrateApi alloc] init];

[apiInstance getAsicHashrateWith:hbSn
    asicId:asicId
    duration:duration
    granularity:granularity
              completionHandler: ^(HashrateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.HashrateApi()
var hbSn = hbSn_example; // {{String}} The serial number of the hashboard to provide hashrate information for.
var asicId = 56; // {{Integer}} The ID of the ASIC to provide hashrate information for.
var opts = { 
  'duration': duration_example, // {{String}} 
  'granularity': granularity_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAsicHashrate(hbSn, asicId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAsicHashrateExample
    {
        public void main()
        {

            var apiInstance = new HashrateApi();
            var hbSn = hbSn_example;  // String | The serial number of the hashboard to provide hashrate information for.
            var asicId = 56;  // Integer | The ID of the ASIC to provide hashrate information for.
            var duration = duration_example;  // String |  (optional)  (default to 12h)
            var granularity = granularity_example;  // String |  (optional)  (default to 1m)

            try
            {
                HashrateResponse result = apiInstance.getAsicHashrate(hbSn, asicId, duration, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HashrateApi.getAsicHashrate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHashrateApi();
$hbSn = hbSn_example; // String | The serial number of the hashboard to provide hashrate information for.
$asicId = 56; // Integer | The ID of the ASIC to provide hashrate information for.
$duration = duration_example; // String | 
$granularity = granularity_example; // String | 

try {
    $result = $api_instance->getAsicHashrate($hbSn, $asicId, $duration, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HashrateApi->getAsicHashrate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HashrateApi;

my $api_instance = WWW::SwaggerClient::HashrateApi->new();
my $hbSn = hbSn_example; # String | The serial number of the hashboard to provide hashrate information for.
my $asicId = 56; # Integer | The ID of the ASIC to provide hashrate information for.
my $duration = duration_example; # String | 
my $granularity = granularity_example; # String | 

eval { 
    my $result = $api_instance->getAsicHashrate(hbSn => $hbSn, asicId => $asicId, duration => $duration, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HashrateApi->getAsicHashrate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HashrateApi()
hbSn = hbSn_example # String | The serial number of the hashboard to provide hashrate information for.
asicId = 56 # Integer | The ID of the ASIC to provide hashrate information for.
duration = duration_example # String |  (optional) (default to 12h)
granularity = granularity_example # String |  (optional) (default to 1m)

try: 
    api_response = api_instance.get_asic_hashrate(hbSn, asicId, duration=duration, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HashrateApi->getAsicHashrate: %s\n" % e)

Parameters

Path parameters
Name Description
hb_sn*
String
The serial number of the hashboard to provide hashrate information for.
Required
asic_id*
Integer
The ID of the ASIC to provide hashrate information for.
Required
Query parameters
Name Description
duration
String
granularity
String

Responses

Status: 200 - Successfully returned the requested ASIC-level hashrate data.

Status: 400 - Bad request.

Status: 500 - Internal server error.


getHashboardHashrate

The hashrate endpoint provides hashboard-level historical operation data.


/api/v1/hashrate/{hb_sn}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/hashrate/{hb_sn}?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HashrateApi;

import java.io.File;
import java.util.*;

public class HashrateApiExample {

    public static void main(String[] args) {
        
        HashrateApi apiInstance = new HashrateApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide hashrate information for.
        String duration = duration_example; // String | 
        try {
            HashrateResponse result = apiInstance.getHashboardHashrate(hbSn, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashrateApi#getHashboardHashrate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HashrateApi;

public class HashrateApiExample {

    public static void main(String[] args) {
        HashrateApi apiInstance = new HashrateApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide hashrate information for.
        String duration = duration_example; // String | 
        try {
            HashrateResponse result = apiInstance.getHashboardHashrate(hbSn, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashrateApi#getHashboardHashrate");
            e.printStackTrace();
        }
    }
}
String *hbSn = hbSn_example; // The serial number of the hashboard to provide hashrate information for.
String *duration = duration_example; //  (optional) (default to 12h)

HashrateApi *apiInstance = [[HashrateApi alloc] init];

[apiInstance getHashboardHashrateWith:hbSn
    duration:duration
              completionHandler: ^(HashrateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.HashrateApi()
var hbSn = hbSn_example; // {{String}} The serial number of the hashboard to provide hashrate information for.
var opts = { 
  'duration': duration_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHashboardHashrate(hbSn, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHashboardHashrateExample
    {
        public void main()
        {

            var apiInstance = new HashrateApi();
            var hbSn = hbSn_example;  // String | The serial number of the hashboard to provide hashrate information for.
            var duration = duration_example;  // String |  (optional)  (default to 12h)

            try
            {
                HashrateResponse result = apiInstance.getHashboardHashrate(hbSn, duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HashrateApi.getHashboardHashrate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHashrateApi();
$hbSn = hbSn_example; // String | The serial number of the hashboard to provide hashrate information for.
$duration = duration_example; // String | 

try {
    $result = $api_instance->getHashboardHashrate($hbSn, $duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HashrateApi->getHashboardHashrate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HashrateApi;

my $api_instance = WWW::SwaggerClient::HashrateApi->new();
my $hbSn = hbSn_example; # String | The serial number of the hashboard to provide hashrate information for.
my $duration = duration_example; # String | 

eval { 
    my $result = $api_instance->getHashboardHashrate(hbSn => $hbSn, duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HashrateApi->getHashboardHashrate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HashrateApi()
hbSn = hbSn_example # String | The serial number of the hashboard to provide hashrate information for.
duration = duration_example # String |  (optional) (default to 12h)

try: 
    api_response = api_instance.get_hashboard_hashrate(hbSn, duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HashrateApi->getHashboardHashrate: %s\n" % e)

Parameters

Path parameters
Name Description
hb_sn*
String
The serial number of the hashboard to provide hashrate information for.
Required
Query parameters
Name Description
duration
String

Responses

Status: 200 - Successfully returned the requested miner-level hashrate data.

Status: 400 - Bad request.

Status: 500 - Internal server error.


getMinerHashrate

The hashrate endpoint provides miner-level historical hashrate operation data.


/api/v1/hashrate

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/hashrate?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HashrateApi;

import java.io.File;
import java.util.*;

public class HashrateApiExample {

    public static void main(String[] args) {
        
        HashrateApi apiInstance = new HashrateApi();
        String duration = duration_example; // String | 
        try {
            HashrateResponse result = apiInstance.getMinerHashrate(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashrateApi#getMinerHashrate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HashrateApi;

public class HashrateApiExample {

    public static void main(String[] args) {
        HashrateApi apiInstance = new HashrateApi();
        String duration = duration_example; // String | 
        try {
            HashrateResponse result = apiInstance.getMinerHashrate(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashrateApi#getMinerHashrate");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; //  (optional) (default to 12h)

HashrateApi *apiInstance = [[HashrateApi alloc] init];

[apiInstance getMinerHashrateWith:duration
              completionHandler: ^(HashrateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.HashrateApi()
var opts = { 
  'duration': duration_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMinerHashrate(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMinerHashrateExample
    {
        public void main()
        {

            var apiInstance = new HashrateApi();
            var duration = duration_example;  // String |  (optional)  (default to 12h)

            try
            {
                HashrateResponse result = apiInstance.getMinerHashrate(duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HashrateApi.getMinerHashrate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiHashrateApi();
$duration = duration_example; // String | 

try {
    $result = $api_instance->getMinerHashrate($duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HashrateApi->getMinerHashrate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HashrateApi;

my $api_instance = WWW::SwaggerClient::HashrateApi->new();
my $duration = duration_example; # String | 

eval { 
    my $result = $api_instance->getMinerHashrate(duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HashrateApi->getMinerHashrate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.HashrateApi()
duration = duration_example # String |  (optional) (default to 12h)

try: 
    api_response = api_instance.get_miner_hashrate(duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HashrateApi->getMinerHashrate: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String

Responses

Status: 200 - Successfully returned the requested miner-level hashrate data.

Status: 400 - Bad request.

Status: 500 - Internal server error.


Mining

editMiningTarget

The mining target endpoint can be used to set a target power consumption for the miner. Once set, the mining device will operate to consume as close to that amount of power as possible. In the event that the device is unable to maintain its temperature within the allowed range, it may scale down and use less power.


/api/v1/mining/target

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/mining/target"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MiningApi;

import java.io.File;
import java.util.*;

public class MiningApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MiningApi apiInstance = new MiningApi();
        MiningTarget body = ; // MiningTarget | 
        try {
            MiningTarget result = apiInstance.editMiningTarget(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#editMiningTarget");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MiningApi;

public class MiningApiExample {

    public static void main(String[] args) {
        MiningApi apiInstance = new MiningApi();
        MiningTarget body = ; // MiningTarget | 
        try {
            MiningTarget result = apiInstance.editMiningTarget(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#editMiningTarget");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
MiningTarget *body = ; // 

MiningApi *apiInstance = [[MiningApi alloc] init];

[apiInstance editMiningTargetWith:body
              completionHandler: ^(MiningTarget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.MiningApi()
var body = ; // {{MiningTarget}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editMiningTarget(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editMiningTargetExample
    {
        public void main()
        {


            var apiInstance = new MiningApi();
            var body = new MiningTarget(); // MiningTarget | 

            try
            {
                MiningTarget result = apiInstance.editMiningTarget(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MiningApi.editMiningTarget: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMiningApi();
$body = ; // MiningTarget | 

try {
    $result = $api_instance->editMiningTarget($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiningApi->editMiningTarget: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MiningApi;


my $api_instance = WWW::SwaggerClient::MiningApi->new();
my $body = WWW::SwaggerClient::Object::MiningTarget->new(); # MiningTarget | 

eval { 
    my $result = $api_instance->editMiningTarget(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiningApi->editMiningTarget: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.MiningApi()
body =  # MiningTarget | 

try: 
    api_response = api_instance.edit_mining_target(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiningApi->editMiningTarget: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The mining target has been successfully updated.

Status: 400 - Bad request.

Status: 401 - Authentication failed.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


getMiningStatus

The mining endpoint provides summary information about the mining operations of the device. This includes device level hashrate statistics, overall miner status, and current power usage and target information.


/api/v1/mining

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/mining"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MiningApi;

import java.io.File;
import java.util.*;

public class MiningApiExample {

    public static void main(String[] args) {
        
        MiningApi apiInstance = new MiningApi();
        try {
            MiningStatus result = apiInstance.getMiningStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#getMiningStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MiningApi;

public class MiningApiExample {

    public static void main(String[] args) {
        MiningApi apiInstance = new MiningApi();
        try {
            MiningStatus result = apiInstance.getMiningStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#getMiningStatus");
            e.printStackTrace();
        }
    }
}

MiningApi *apiInstance = [[MiningApi alloc] init];

[apiInstance getMiningStatusWithCompletionHandler: 
              ^(MiningStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.MiningApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMiningStatus(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMiningStatusExample
    {
        public void main()
        {

            var apiInstance = new MiningApi();

            try
            {
                MiningStatus result = apiInstance.getMiningStatus();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MiningApi.getMiningStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiMiningApi();

try {
    $result = $api_instance->getMiningStatus();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiningApi->getMiningStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MiningApi;

my $api_instance = WWW::SwaggerClient::MiningApi->new();

eval { 
    my $result = $api_instance->getMiningStatus();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiningApi->getMiningStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.MiningApi()

try: 
    api_response = api_instance.get_mining_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiningApi->getMiningStatus: %s\n" % e)

Parameters

Responses

Status: 200 - Mining status information has been successfully returned.

Status: 204 - No mining statistics available.

Status: 500 - Internal server error.


getMiningTarget

The mining target endpoint returns the current power target in watts that the miner is controlling for.


/api/v1/mining/target

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/mining/target"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MiningApi;

import java.io.File;
import java.util.*;

public class MiningApiExample {

    public static void main(String[] args) {
        
        MiningApi apiInstance = new MiningApi();
        try {
            MiningTarget result = apiInstance.getMiningTarget();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#getMiningTarget");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MiningApi;

public class MiningApiExample {

    public static void main(String[] args) {
        MiningApi apiInstance = new MiningApi();
        try {
            MiningTarget result = apiInstance.getMiningTarget();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#getMiningTarget");
            e.printStackTrace();
        }
    }
}

MiningApi *apiInstance = [[MiningApi alloc] init];

[apiInstance getMiningTargetWithCompletionHandler: 
              ^(MiningTarget output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.MiningApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMiningTarget(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMiningTargetExample
    {
        public void main()
        {

            var apiInstance = new MiningApi();

            try
            {
                MiningTarget result = apiInstance.getMiningTarget();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MiningApi.getMiningTarget: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiMiningApi();

try {
    $result = $api_instance->getMiningTarget();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiningApi->getMiningTarget: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MiningApi;

my $api_instance = WWW::SwaggerClient::MiningApi->new();

eval { 
    my $result = $api_instance->getMiningTarget();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiningApi->getMiningTarget: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.MiningApi()

try: 
    api_response = api_instance.get_mining_target()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiningApi->getMiningTarget: %s\n" % e)

Parameters

Responses

Status: 200 - The mining target value was successfully returned.

Status: 204 - No mining statistics available.

Status: 500 - Internal server error.


startMining

The start mining endpoint can be used to make the device start mining, into account the current power target of the system.


/api/v1/mining/start

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/mining/start"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MiningApi;

import java.io.File;
import java.util.*;

public class MiningApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MiningApi apiInstance = new MiningApi();
        try {
            MessageResponse result = apiInstance.startMining();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#startMining");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MiningApi;

public class MiningApiExample {

    public static void main(String[] args) {
        MiningApi apiInstance = new MiningApi();
        try {
            MessageResponse result = apiInstance.startMining();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#startMining");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

MiningApi *apiInstance = [[MiningApi alloc] init];

[apiInstance startMiningWithCompletionHandler: 
              ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.MiningApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startMining(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startMiningExample
    {
        public void main()
        {


            var apiInstance = new MiningApi();

            try
            {
                MessageResponse result = apiInstance.startMining();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MiningApi.startMining: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMiningApi();

try {
    $result = $api_instance->startMining();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiningApi->startMining: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MiningApi;


my $api_instance = WWW::SwaggerClient::MiningApi->new();

eval { 
    my $result = $api_instance->startMining();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiningApi->startMining: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.MiningApi()

try: 
    api_response = api_instance.start_mining()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiningApi->startMining: %s\n" % e)

Parameters

Responses

Status: 202 - Mining start command has been accepted.

Status: 401 - Authentication failed.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


stopMining

The stop mining endpoint can be used to stop the device from mining, going into a minimal power mode with only the control board running.


/api/v1/mining/stop

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/mining/stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MiningApi;

import java.io.File;
import java.util.*;

public class MiningApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MiningApi apiInstance = new MiningApi();
        try {
            MessageResponse result = apiInstance.stopMining();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#stopMining");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MiningApi;

public class MiningApiExample {

    public static void main(String[] args) {
        MiningApi apiInstance = new MiningApi();
        try {
            MessageResponse result = apiInstance.stopMining();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MiningApi#stopMining");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

MiningApi *apiInstance = [[MiningApi alloc] init];

[apiInstance stopMiningWithCompletionHandler: 
              ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.MiningApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopMining(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopMiningExample
    {
        public void main()
        {


            var apiInstance = new MiningApi();

            try
            {
                MessageResponse result = apiInstance.stopMining();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MiningApi.stopMining: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMiningApi();

try {
    $result = $api_instance->stopMining();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiningApi->stopMining: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MiningApi;


my $api_instance = WWW::SwaggerClient::MiningApi->new();

eval { 
    my $result = $api_instance->stopMining();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MiningApi->stopMining: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.MiningApi()

try: 
    api_response = api_instance.stop_mining()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MiningApi->stopMining: %s\n" % e)

Parameters

Responses

Status: 202 - Mining stop command has been accepted.

Status: 401 - Authentication failed.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


Network

getNetwork

The network GET endpoint provides information related to the network configuration of the miner including IP address, gateways, and MAC address.


/api/v1/network

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/network"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NetworkApi;

import java.io.File;
import java.util.*;

public class NetworkApiExample {

    public static void main(String[] args) {
        
        NetworkApi apiInstance = new NetworkApi();
        try {
            NetworkInfo result = apiInstance.getNetwork();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkApi#getNetwork");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NetworkApi;

public class NetworkApiExample {

    public static void main(String[] args) {
        NetworkApi apiInstance = new NetworkApi();
        try {
            NetworkInfo result = apiInstance.getNetwork();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkApi#getNetwork");
            e.printStackTrace();
        }
    }
}

NetworkApi *apiInstance = [[NetworkApi alloc] init];

[apiInstance getNetworkWithCompletionHandler: 
              ^(NetworkInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.NetworkApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNetwork(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNetworkExample
    {
        public void main()
        {

            var apiInstance = new NetworkApi();

            try
            {
                NetworkInfo result = apiInstance.getNetwork();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkApi.getNetwork: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNetworkApi();

try {
    $result = $api_instance->getNetwork();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkApi->getNetwork: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NetworkApi;

my $api_instance = WWW::SwaggerClient::NetworkApi->new();

eval { 
    my $result = $api_instance->getNetwork();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkApi->getNetwork: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NetworkApi()

try: 
    api_response = api_instance.get_network()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkApi->getNetwork: %s\n" % e)

Parameters

Responses

Status: 200 - The network information.

Status: 404 - No network interface found.


setNetworkConfig

The network PUT endpoint allows the user to change the configuration of the miner between DHCP and a static IP.


/api/v1/network

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/network"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NetworkApi;

import java.io.File;
import java.util.*;

public class NetworkApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        NetworkApi apiInstance = new NetworkApi();
        NetworkConfig body = ; // NetworkConfig | 
        try {
            NetworkInfo result = apiInstance.setNetworkConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkApi#setNetworkConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NetworkApi;

public class NetworkApiExample {

    public static void main(String[] args) {
        NetworkApi apiInstance = new NetworkApi();
        NetworkConfig body = ; // NetworkConfig | 
        try {
            NetworkInfo result = apiInstance.setNetworkConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetworkApi#setNetworkConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
NetworkConfig *body = ; // 

NetworkApi *apiInstance = [[NetworkApi alloc] init];

[apiInstance setNetworkConfigWith:body
              completionHandler: ^(NetworkInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.NetworkApi()
var body = ; // {{NetworkConfig}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setNetworkConfig(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setNetworkConfigExample
    {
        public void main()
        {


            var apiInstance = new NetworkApi();
            var body = new NetworkConfig(); // NetworkConfig | 

            try
            {
                NetworkInfo result = apiInstance.setNetworkConfig(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetworkApi.setNetworkConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiNetworkApi();
$body = ; // NetworkConfig | 

try {
    $result = $api_instance->setNetworkConfig($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NetworkApi->setNetworkConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NetworkApi;


my $api_instance = WWW::SwaggerClient::NetworkApi->new();
my $body = WWW::SwaggerClient::Object::NetworkConfig->new(); # NetworkConfig | 

eval { 
    my $result = $api_instance->setNetworkConfig(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NetworkApi->setNetworkConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.NetworkApi()
body =  # NetworkConfig | 

try: 
    api_response = api_instance.set_network_config(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NetworkApi->setNetworkConfig: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The network configuration has been successfully updated.

Status: 400 - Bad request.

Status: 401 - Authentication failed.

Status: 500 - Internal server error.


Pools

createPools

The post pools endpoint allows up to three pools to be configured, replacing the previous pool configuration.


/api/v1/pools

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/pools"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoolsApi;

import java.io.File;
import java.util.*;

public class PoolsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PoolsApi apiInstance = new PoolsApi();
        array[PoolConfig_inner] body = ; // array[PoolConfig_inner] | 
        try {
            MessageResponse result = apiInstance.createPools(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#createPools");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        array[PoolConfig_inner] body = ; // array[PoolConfig_inner] | 
        try {
            MessageResponse result = apiInstance.createPools(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#createPools");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
array[PoolConfig_inner] *body = ; //  (optional)

PoolsApi *apiInstance = [[PoolsApi alloc] init];

[apiInstance createPoolsWith:body
              completionHandler: ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.PoolsApi()
var opts = { 
  'body':  // {{array[PoolConfig_inner]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPools(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPoolsExample
    {
        public void main()
        {


            var apiInstance = new PoolsApi();
            var body = new array[PoolConfig_inner](); // array[PoolConfig_inner] |  (optional) 

            try
            {
                MessageResponse result = apiInstance.createPools(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.createPools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPoolsApi();
$body = ; // array[PoolConfig_inner] | 

try {
    $result = $api_instance->createPools($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolsApi->createPools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoolsApi;


my $api_instance = WWW::SwaggerClient::PoolsApi->new();
my $body = [WWW::SwaggerClient::Object::array[PoolConfig_inner]->new()]; # array[PoolConfig_inner] | 

eval { 
    my $result = $api_instance->createPools(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolsApi->createPools: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.PoolsApi()
body =  # array[PoolConfig_inner] |  (optional)

try: 
    api_response = api_instance.create_pools(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->createPools: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - The pool configuration has been successfully created.

Status: 400 - Bad request.

Status: 401 - Authentication failed.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


deletePool


/api/v1/pools/{id}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/pools/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoolsApi;

import java.io.File;
import java.util.*;

public class PoolsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PoolsApi apiInstance = new PoolsApi();
        Integer id = 56; // Integer | 
        try {
            MessageResponse result = apiInstance.deletePool(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#deletePool");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        Integer id = 56; // Integer | 
        try {
            MessageResponse result = apiInstance.deletePool(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#deletePool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *id = 56; // 

PoolsApi *apiInstance = [[PoolsApi alloc] init];

[apiInstance deletePoolWith:id
              completionHandler: ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.PoolsApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePool(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePoolExample
    {
        public void main()
        {


            var apiInstance = new PoolsApi();
            var id = 56;  // Integer | 

            try
            {
                MessageResponse result = apiInstance.deletePool(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.deletePool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPoolsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->deletePool($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolsApi->deletePool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoolsApi;


my $api_instance = WWW::SwaggerClient::PoolsApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deletePool(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolsApi->deletePool: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.PoolsApi()
id = 56 # Integer | 

try: 
    api_response = api_instance.delete_pool(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->deletePool: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses

Status: 204 - The pool configuration has been successfully deleted.

Status: 400 - Bad request.

Status: 401 - Authentication failed.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


editPool

Using this pool configuration endpoint, users can edit the properties of an existing pool.


/api/v1/pools/{id}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/pools/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoolsApi;

import java.io.File;
import java.util.*;

public class PoolsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PoolsApi apiInstance = new PoolsApi();
        PoolConfig_inner body = ; // PoolConfig_inner | 
        Integer id = 56; // Integer | 
        try {
            PoolConfigResponse result = apiInstance.editPool(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#editPool");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        PoolConfig_inner body = ; // PoolConfig_inner | 
        Integer id = 56; // Integer | 
        try {
            PoolConfigResponse result = apiInstance.editPool(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#editPool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
PoolConfig_inner *body = ; // 
Integer *id = 56; // 

PoolsApi *apiInstance = [[PoolsApi alloc] init];

[apiInstance editPoolWith:body
    id:id
              completionHandler: ^(PoolConfigResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.PoolsApi()
var body = ; // {{PoolConfig_inner}} 
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editPool(bodyid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editPoolExample
    {
        public void main()
        {


            var apiInstance = new PoolsApi();
            var body = new PoolConfig_inner(); // PoolConfig_inner | 
            var id = 56;  // Integer | 

            try
            {
                PoolConfigResponse result = apiInstance.editPool(body, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.editPool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPoolsApi();
$body = ; // PoolConfig_inner | 
$id = 56; // Integer | 

try {
    $result = $api_instance->editPool($body, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolsApi->editPool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoolsApi;


my $api_instance = WWW::SwaggerClient::PoolsApi->new();
my $body = WWW::SwaggerClient::Object::PoolConfig_inner->new(); # PoolConfig_inner | 
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->editPool(body => $body, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolsApi->editPool: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.PoolsApi()
body =  # PoolConfig_inner | 
id = 56 # Integer | 

try: 
    api_response = api_instance.edit_pool(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->editPool: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The pool configuration has been successfully updated.

Status: 400 - Bad request.

Status: 401 - Authentication failed.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


getPool


/api/v1/pools/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/pools/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoolsApi;

import java.io.File;
import java.util.*;

public class PoolsApiExample {

    public static void main(String[] args) {
        
        PoolsApi apiInstance = new PoolsApi();
        Integer id = 56; // Integer | 
        try {
            PoolResponse result = apiInstance.getPool(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#getPool");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        Integer id = 56; // Integer | 
        try {
            PoolResponse result = apiInstance.getPool(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#getPool");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 

PoolsApi *apiInstance = [[PoolsApi alloc] init];

[apiInstance getPoolWith:id
              completionHandler: ^(PoolResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.PoolsApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPool(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPoolExample
    {
        public void main()
        {

            var apiInstance = new PoolsApi();
            var id = 56;  // Integer | 

            try
            {
                PoolResponse result = apiInstance.getPool(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.getPool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPoolsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->getPool($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolsApi->getPool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoolsApi;

my $api_instance = WWW::SwaggerClient::PoolsApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->getPool(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolsApi->getPool: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()
id = 56 # Integer | 

try: 
    api_response = api_instance.get_pool(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->getPool: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
Required

Responses

Status: 200 - Configuration for a single pool was returned.

Status: 400 - Bad request.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


listPools

The get pools endpoint returns the full list of currently configured pools.


/api/v1/pools

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/pools"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoolsApi;

import java.io.File;
import java.util.*;

public class PoolsApiExample {

    public static void main(String[] args) {
        
        PoolsApi apiInstance = new PoolsApi();
        try {
            PoolsList result = apiInstance.listPools();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#listPools");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        try {
            PoolsList result = apiInstance.listPools();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#listPools");
            e.printStackTrace();
        }
    }
}

PoolsApi *apiInstance = [[PoolsApi alloc] init];

[apiInstance listPoolsWithCompletionHandler: 
              ^(PoolsList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.PoolsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPools(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listPoolsExample
    {
        public void main()
        {

            var apiInstance = new PoolsApi();

            try
            {
                PoolsList result = apiInstance.listPools();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.listPools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPoolsApi();

try {
    $result = $api_instance->listPools();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolsApi->listPools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoolsApi;

my $api_instance = WWW::SwaggerClient::PoolsApi->new();

eval { 
    my $result = $api_instance->listPools();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolsApi->listPools: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()

try: 
    api_response = api_instance.list_pools()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->listPools: %s\n" % e)

Parameters

Responses

Status: 200 - The list of pools was successfully returned.

Status: 500 - Internal server error.


testPoolConnection

Used to test a pool connection


/api/v1/pools/test-connection

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/pools/test-connection"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PoolsApi;

import java.io.File;
import java.util.*;

public class PoolsApiExample {

    public static void main(String[] args) {
        
        PoolsApi apiInstance = new PoolsApi();
        TestConnection body = ; // TestConnection | 
        try {
            MessageResponse result = apiInstance.testPoolConnection(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#testPoolConnection");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PoolsApi;

public class PoolsApiExample {

    public static void main(String[] args) {
        PoolsApi apiInstance = new PoolsApi();
        TestConnection body = ; // TestConnection | 
        try {
            MessageResponse result = apiInstance.testPoolConnection(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolsApi#testPoolConnection");
            e.printStackTrace();
        }
    }
}
TestConnection *body = ; // 

PoolsApi *apiInstance = [[PoolsApi alloc] init];

[apiInstance testPoolConnectionWith:body
              completionHandler: ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.PoolsApi()
var body = ; // {{TestConnection}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.testPoolConnection(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class testPoolConnectionExample
    {
        public void main()
        {

            var apiInstance = new PoolsApi();
            var body = new TestConnection(); // TestConnection | 

            try
            {
                MessageResponse result = apiInstance.testPoolConnection(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PoolsApi.testPoolConnection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPoolsApi();
$body = ; // TestConnection | 

try {
    $result = $api_instance->testPoolConnection($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolsApi->testPoolConnection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PoolsApi;

my $api_instance = WWW::SwaggerClient::PoolsApi->new();
my $body = WWW::SwaggerClient::Object::TestConnection->new(); # TestConnection | 

eval { 
    my $result = $api_instance->testPoolConnection(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolsApi->testPoolConnection: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()
body =  # TestConnection | 

try: 
    api_response = api_instance.test_pool_connection(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->testPoolConnection: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Connection test passed.

Status: 500 - Internal server error.

Status: 503 - Unable to establish connection.


Power

getHashboardPower

The power endpoint provides hashboard-level historical operation data.


/api/v1/power/{hb_sn}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/power/{hb_sn}?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PowerApi;

import java.io.File;
import java.util.*;

public class PowerApiExample {

    public static void main(String[] args) {
        
        PowerApi apiInstance = new PowerApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide power information for.
        String duration = duration_example; // String | 
        try {
            PowerResponse result = apiInstance.getHashboardPower(hbSn, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PowerApi#getHashboardPower");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PowerApi;

public class PowerApiExample {

    public static void main(String[] args) {
        PowerApi apiInstance = new PowerApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide power information for.
        String duration = duration_example; // String | 
        try {
            PowerResponse result = apiInstance.getHashboardPower(hbSn, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PowerApi#getHashboardPower");
            e.printStackTrace();
        }
    }
}
String *hbSn = hbSn_example; // The serial number of the hashboard to provide power information for.
String *duration = duration_example; //  (optional) (default to 12h)

PowerApi *apiInstance = [[PowerApi alloc] init];

[apiInstance getHashboardPowerWith:hbSn
    duration:duration
              completionHandler: ^(PowerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.PowerApi()
var hbSn = hbSn_example; // {{String}} The serial number of the hashboard to provide power information for.
var opts = { 
  'duration': duration_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHashboardPower(hbSn, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHashboardPowerExample
    {
        public void main()
        {

            var apiInstance = new PowerApi();
            var hbSn = hbSn_example;  // String | The serial number of the hashboard to provide power information for.
            var duration = duration_example;  // String |  (optional)  (default to 12h)

            try
            {
                PowerResponse result = apiInstance.getHashboardPower(hbSn, duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PowerApi.getHashboardPower: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPowerApi();
$hbSn = hbSn_example; // String | The serial number of the hashboard to provide power information for.
$duration = duration_example; // String | 

try {
    $result = $api_instance->getHashboardPower($hbSn, $duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PowerApi->getHashboardPower: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PowerApi;

my $api_instance = WWW::SwaggerClient::PowerApi->new();
my $hbSn = hbSn_example; # String | The serial number of the hashboard to provide power information for.
my $duration = duration_example; # String | 

eval { 
    my $result = $api_instance->getHashboardPower(hbSn => $hbSn, duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PowerApi->getHashboardPower: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PowerApi()
hbSn = hbSn_example # String | The serial number of the hashboard to provide power information for.
duration = duration_example # String |  (optional) (default to 12h)

try: 
    api_response = api_instance.get_hashboard_power(hbSn, duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PowerApi->getHashboardPower: %s\n" % e)

Parameters

Path parameters
Name Description
hb_sn*
String
The serial number of the hashboard to provide power information for.
Required
Query parameters
Name Description
duration
String

Responses

Status: 200 - Successfully returned the requested miner-level power data.

Status: 400 - Bad request.

Status: 500 - Internal server error.


getMinerPower

The power endpoint provides miner-level historical power operation data.


/api/v1/power

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/power?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PowerApi;

import java.io.File;
import java.util.*;

public class PowerApiExample {

    public static void main(String[] args) {
        
        PowerApi apiInstance = new PowerApi();
        String duration = duration_example; // String | 
        try {
            PowerResponse result = apiInstance.getMinerPower(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PowerApi#getMinerPower");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PowerApi;

public class PowerApiExample {

    public static void main(String[] args) {
        PowerApi apiInstance = new PowerApi();
        String duration = duration_example; // String | 
        try {
            PowerResponse result = apiInstance.getMinerPower(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PowerApi#getMinerPower");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; //  (optional) (default to 12h)

PowerApi *apiInstance = [[PowerApi alloc] init];

[apiInstance getMinerPowerWith:duration
              completionHandler: ^(PowerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.PowerApi()
var opts = { 
  'duration': duration_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMinerPower(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMinerPowerExample
    {
        public void main()
        {

            var apiInstance = new PowerApi();
            var duration = duration_example;  // String |  (optional)  (default to 12h)

            try
            {
                PowerResponse result = apiInstance.getMinerPower(duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PowerApi.getMinerPower: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPowerApi();
$duration = duration_example; // String | 

try {
    $result = $api_instance->getMinerPower($duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PowerApi->getMinerPower: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PowerApi;

my $api_instance = WWW::SwaggerClient::PowerApi->new();
my $duration = duration_example; # String | 

eval { 
    my $result = $api_instance->getMinerPower(duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PowerApi->getMinerPower: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PowerApi()
duration = duration_example # String |  (optional) (default to 12h)

try: 
    api_response = api_instance.get_miner_power(duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PowerApi->getMinerPower: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String

Responses

Status: 200 - Successfully returned the requested miner-level power data.

Status: 400 - Bad request.

Status: 500 - Internal server error.


System

getSSH

The get ssh endpoint returns if SSH is enabled or disabled on the control board


/api/v1/system/ssh

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/system/ssh"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemApi;

import java.io.File;
import java.util.*;

public class SystemApiExample {

    public static void main(String[] args) {
        
        SystemApi apiInstance = new SystemApi();
        try {
            SshResponse result = apiInstance.getSSH();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#getSSH");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemApi;

public class SystemApiExample {

    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        try {
            SshResponse result = apiInstance.getSSH();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#getSSH");
            e.printStackTrace();
        }
    }
}

SystemApi *apiInstance = [[SystemApi alloc] init];

[apiInstance getSSHWithCompletionHandler: 
              ^(SshResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.SystemApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSSH(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSSHExample
    {
        public void main()
        {

            var apiInstance = new SystemApi();

            try
            {
                SshResponse result = apiInstance.getSSH();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemApi.getSSH: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSystemApi();

try {
    $result = $api_instance->getSSH();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->getSSH: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemApi;

my $api_instance = WWW::SwaggerClient::SystemApi->new();

eval { 
    my $result = $api_instance->getSSH();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->getSSH: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemApi()

try: 
    api_response = api_instance.get_ssh()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->getSSH: %s\n" % e)

Parameters

Responses

Status: 200 - The SSH status was successfully returned.

Status: 500 - Internal server error.


getSystemInfo

The system endpoint provides information related to the control board including OS, software, and hardware component details.


/api/v1/system

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/system"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemApi;

import java.io.File;
import java.util.*;

public class SystemApiExample {

    public static void main(String[] args) {
        
        SystemApi apiInstance = new SystemApi();
        try {
            SystemInfo result = apiInstance.getSystemInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#getSystemInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemApi;

public class SystemApiExample {

    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        try {
            SystemInfo result = apiInstance.getSystemInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#getSystemInfo");
            e.printStackTrace();
        }
    }
}

SystemApi *apiInstance = [[SystemApi alloc] init];

[apiInstance getSystemInfoWithCompletionHandler: 
              ^(SystemInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.SystemApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSystemInfo(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSystemInfoExample
    {
        public void main()
        {

            var apiInstance = new SystemApi();

            try
            {
                SystemInfo result = apiInstance.getSystemInfo();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemApi.getSystemInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSystemApi();

try {
    $result = $api_instance->getSystemInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->getSystemInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemApi;

my $api_instance = WWW::SwaggerClient::SystemApi->new();

eval { 
    my $result = $api_instance->getSystemInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->getSystemInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemApi()

try: 
    api_response = api_instance.get_system_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->getSystemInfo: %s\n" % e)

Parameters

Responses

Status: 200 - The mining device system information.


getSystemLogs

The logs endpoint provides the most recent log lines from a given source, either OS, pool software, or miner logs.


/api/v1/system/logs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/system/logs?lines=&source="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemApi;

import java.io.File;
import java.util.*;

public class SystemApiExample {

    public static void main(String[] args) {
        
        SystemApi apiInstance = new SystemApi();
        Integer lines = 56; // Integer | Number of log lines to return from the tail of the log, up to a maximum of 10000 lines. Defaults to 100 lines.
        String source = source_example; // String | Source of logs to fetch. Defaults to miner software logs.
        try {
            LogsResponse result = apiInstance.getSystemLogs(lines, source);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#getSystemLogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemApi;

public class SystemApiExample {

    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        Integer lines = 56; // Integer | Number of log lines to return from the tail of the log, up to a maximum of 10000 lines. Defaults to 100 lines.
        String source = source_example; // String | Source of logs to fetch. Defaults to miner software logs.
        try {
            LogsResponse result = apiInstance.getSystemLogs(lines, source);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#getSystemLogs");
            e.printStackTrace();
        }
    }
}
Integer *lines = 56; // Number of log lines to return from the tail of the log, up to a maximum of 10000 lines. Defaults to 100 lines. (optional) (default to 100)
String *source = source_example; // Source of logs to fetch. Defaults to miner software logs. (optional) (default to miner_sw)

SystemApi *apiInstance = [[SystemApi alloc] init];

[apiInstance getSystemLogsWith:lines
    source:source
              completionHandler: ^(LogsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.SystemApi()
var opts = { 
  'lines': 56, // {{Integer}} Number of log lines to return from the tail of the log, up to a maximum of 10000 lines. Defaults to 100 lines.
  'source': source_example // {{String}} Source of logs to fetch. Defaults to miner software logs.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSystemLogs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSystemLogsExample
    {
        public void main()
        {

            var apiInstance = new SystemApi();
            var lines = 56;  // Integer | Number of log lines to return from the tail of the log, up to a maximum of 10000 lines. Defaults to 100 lines. (optional)  (default to 100)
            var source = source_example;  // String | Source of logs to fetch. Defaults to miner software logs. (optional)  (default to miner_sw)

            try
            {
                LogsResponse result = apiInstance.getSystemLogs(lines, source);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemApi.getSystemLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSystemApi();
$lines = 56; // Integer | Number of log lines to return from the tail of the log, up to a maximum of 10000 lines. Defaults to 100 lines.
$source = source_example; // String | Source of logs to fetch. Defaults to miner software logs.

try {
    $result = $api_instance->getSystemLogs($lines, $source);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->getSystemLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemApi;

my $api_instance = WWW::SwaggerClient::SystemApi->new();
my $lines = 56; # Integer | Number of log lines to return from the tail of the log, up to a maximum of 10000 lines. Defaults to 100 lines.
my $source = source_example; # String | Source of logs to fetch. Defaults to miner software logs.

eval { 
    my $result = $api_instance->getSystemLogs(lines => $lines, source => $source);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->getSystemLogs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemApi()
lines = 56 # Integer | Number of log lines to return from the tail of the log, up to a maximum of 10000 lines. Defaults to 100 lines. (optional) (default to 100)
source = source_example # String | Source of logs to fetch. Defaults to miner software logs. (optional) (default to miner_sw)

try: 
    api_response = api_instance.get_system_logs(lines=lines, source=source)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->getSystemLogs: %s\n" % e)

Parameters

Query parameters
Name Description
lines
Integer
Number of log lines to return from the tail of the log, up to a maximum of 10000 lines. Defaults to 100 lines.
source
String
Source of logs to fetch. Defaults to miner software logs.

Responses

Status: 200 - Successfully returned linux system, miner pool interface, or MCDD logs.

Status: 400 - Bad request.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


locateSystem

The locate system endpoint can be used to flash the indicator LED on the control board to assist in finding the miner.


/api/v1/system/locate

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/system/locate?led_on_time="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemApi;

import java.io.File;
import java.util.*;

public class SystemApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SystemApi apiInstance = new SystemApi();
        Integer ledOnTime = 56; // Integer | The duration in seconds for which to turn on the LED, with a max value of 300 seconds. If not specified, a default value of 30 seconds will be used. Requests made while the LED is on will be ignored.
        try {
            MessageResponse result = apiInstance.locateSystem(ledOnTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#locateSystem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemApi;

public class SystemApiExample {

    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        Integer ledOnTime = 56; // Integer | The duration in seconds for which to turn on the LED, with a max value of 300 seconds. If not specified, a default value of 30 seconds will be used. Requests made while the LED is on will be ignored.
        try {
            MessageResponse result = apiInstance.locateSystem(ledOnTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#locateSystem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Integer *ledOnTime = 56; // The duration in seconds for which to turn on the LED, with a max value of 300 seconds. If not specified, a default value of 30 seconds will be used. Requests made while the LED is on will be ignored. (optional) (default to 30)

SystemApi *apiInstance = [[SystemApi alloc] init];

[apiInstance locateSystemWith:ledOnTime
              completionHandler: ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.SystemApi()
var opts = { 
  'ledOnTime': 56 // {{Integer}} The duration in seconds for which to turn on the LED, with a max value of 300 seconds. If not specified, a default value of 30 seconds will be used. Requests made while the LED is on will be ignored.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locateSystem(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class locateSystemExample
    {
        public void main()
        {


            var apiInstance = new SystemApi();
            var ledOnTime = 56;  // Integer | The duration in seconds for which to turn on the LED, with a max value of 300 seconds. If not specified, a default value of 30 seconds will be used. Requests made while the LED is on will be ignored. (optional)  (default to 30)

            try
            {
                MessageResponse result = apiInstance.locateSystem(ledOnTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemApi.locateSystem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSystemApi();
$ledOnTime = 56; // Integer | The duration in seconds for which to turn on the LED, with a max value of 300 seconds. If not specified, a default value of 30 seconds will be used. Requests made while the LED is on will be ignored.

try {
    $result = $api_instance->locateSystem($ledOnTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->locateSystem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemApi;


my $api_instance = WWW::SwaggerClient::SystemApi->new();
my $ledOnTime = 56; # Integer | The duration in seconds for which to turn on the LED, with a max value of 300 seconds. If not specified, a default value of 30 seconds will be used. Requests made while the LED is on will be ignored.

eval { 
    my $result = $api_instance->locateSystem(ledOnTime => $ledOnTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->locateSystem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.SystemApi()
ledOnTime = 56 # Integer | The duration in seconds for which to turn on the LED, with a max value of 300 seconds. If not specified, a default value of 30 seconds will be used. Requests made while the LED is on will be ignored. (optional) (default to 30)

try: 
    api_response = api_instance.locate_system(ledOnTime=ledOnTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->locateSystem: %s\n" % e)

Parameters

Query parameters
Name Description
led_on_time
Integer
The duration in seconds for which to turn on the LED, with a max value of 300 seconds. If not specified, a default value of 30 seconds will be used. Requests made while the LED is on will be ignored.

Responses

Status: 202 - The mining device's LED has started flashing for the specified duration

Status: 400 - Bad request.

Status: 422 - Unprocessable request.


rebootSystem

The reboot endpoint can be used to reboot the entire system.


/api/v1/system/reboot

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/system/reboot"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemApi;

import java.io.File;
import java.util.*;

public class SystemApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SystemApi apiInstance = new SystemApi();
        try {
            MessageResponse result = apiInstance.rebootSystem();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#rebootSystem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemApi;

public class SystemApiExample {

    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        try {
            MessageResponse result = apiInstance.rebootSystem();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#rebootSystem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

SystemApi *apiInstance = [[SystemApi alloc] init];

[apiInstance rebootSystemWithCompletionHandler: 
              ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.SystemApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.rebootSystem(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class rebootSystemExample
    {
        public void main()
        {


            var apiInstance = new SystemApi();

            try
            {
                MessageResponse result = apiInstance.rebootSystem();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemApi.rebootSystem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSystemApi();

try {
    $result = $api_instance->rebootSystem();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->rebootSystem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemApi;


my $api_instance = WWW::SwaggerClient::SystemApi->new();

eval { 
    my $result = $api_instance->rebootSystem();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->rebootSystem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.SystemApi()

try: 
    api_response = api_instance.reboot_system()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->rebootSystem: %s\n" % e)

Parameters

Responses

Status: 202 - System reboot command was accepted.

Status: 401 - Authentication failed.

Status: 500 - Internal server error.


setSSH

The put ssh endpoint enables/disables SSH on the control board


/api/v1/system/ssh

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/system/ssh"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemApi;

import java.io.File;
import java.util.*;

public class SystemApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SystemApi apiInstance = new SystemApi();
        SshConfig body = ; // SshConfig | 
        try {
            SshResponse result = apiInstance.setSSH(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#setSSH");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemApi;

public class SystemApiExample {

    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        SshConfig body = ; // SshConfig | 
        try {
            SshResponse result = apiInstance.setSSH(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#setSSH");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
SshConfig *body = ; // 

SystemApi *apiInstance = [[SystemApi alloc] init];

[apiInstance setSSHWith:body
              completionHandler: ^(SshResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.SystemApi()
var body = ; // {{SshConfig}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setSSH(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setSSHExample
    {
        public void main()
        {


            var apiInstance = new SystemApi();
            var body = new SshConfig(); // SshConfig | 

            try
            {
                SshResponse result = apiInstance.setSSH(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemApi.setSSH: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSystemApi();
$body = ; // SshConfig | 

try {
    $result = $api_instance->setSSH($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->setSSH: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemApi;


my $api_instance = WWW::SwaggerClient::SystemApi->new();
my $body = WWW::SwaggerClient::Object::SshConfig->new(); # SshConfig | 

eval { 
    my $result = $api_instance->setSSH(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->setSSH: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.SystemApi()
body =  # SshConfig | 

try: 
    api_response = api_instance.set_ssh(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->setSSH: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - The SSH status was successfully updated

Status: 400 - Bad request.

Status: 401 - Authentication failed.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


updateSystem

The update system endpoint can be used to initiate a system update of the miner software.


/api/v1/system/update

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/system/update"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemApi;

import java.io.File;
import java.util.*;

public class SystemApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SystemApi apiInstance = new SystemApi();
        try {
            MessageResponse result = apiInstance.updateSystem();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#updateSystem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemApi;

public class SystemApiExample {

    public static void main(String[] args) {
        SystemApi apiInstance = new SystemApi();
        try {
            MessageResponse result = apiInstance.updateSystem();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemApi#updateSystem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

SystemApi *apiInstance = [[SystemApi alloc] init];

[apiInstance updateSystemWithCompletionHandler: 
              ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');
var defaultClient = MiningDevelopmentKitApi.ApiClient.instance;


var api = new MiningDevelopmentKitApi.SystemApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateSystem(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateSystemExample
    {
        public void main()
        {


            var apiInstance = new SystemApi();

            try
            {
                MessageResponse result = apiInstance.updateSystem();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemApi.updateSystem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSystemApi();

try {
    $result = $api_instance->updateSystem();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemApi->updateSystem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemApi;


my $api_instance = WWW::SwaggerClient::SystemApi->new();

eval { 
    my $result = $api_instance->updateSystem();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemApi->updateSystem: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.SystemApi()

try: 
    api_response = api_instance.update_system()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemApi->updateSystem: %s\n" % e)

Parameters

Responses

Status: 202 - The mining device has successfully started the update process.

Status: 400 - Bad request.

Status: 401 - Authentication failed.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


SystemInformation

getSystemStatus

Get system statuses


/api/v1/system/status

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/system/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SystemInformationApi;

import java.io.File;
import java.util.*;

public class SystemInformationApiExample {

    public static void main(String[] args) {
        
        SystemInformationApi apiInstance = new SystemInformationApi();
        try {
            SystemStatuses result = apiInstance.getSystemStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemInformationApi#getSystemStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SystemInformationApi;

public class SystemInformationApiExample {

    public static void main(String[] args) {
        SystemInformationApi apiInstance = new SystemInformationApi();
        try {
            SystemStatuses result = apiInstance.getSystemStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemInformationApi#getSystemStatus");
            e.printStackTrace();
        }
    }
}

SystemInformationApi *apiInstance = [[SystemInformationApi alloc] init];

[apiInstance getSystemStatusWithCompletionHandler: 
              ^(SystemStatuses output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.SystemInformationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSystemStatus(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSystemStatusExample
    {
        public void main()
        {

            var apiInstance = new SystemInformationApi();

            try
            {
                SystemStatuses result = apiInstance.getSystemStatus();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SystemInformationApi.getSystemStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSystemInformationApi();

try {
    $result = $api_instance->getSystemStatus();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemInformationApi->getSystemStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SystemInformationApi;

my $api_instance = WWW::SwaggerClient::SystemInformationApi->new();

eval { 
    my $result = $api_instance->getSystemStatus();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemInformationApi->getSystemStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SystemInformationApi()

try: 
    api_response = api_instance.get_system_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemInformationApi->getSystemStatus: %s\n" % e)

Parameters

Responses

Status: 200 - The onboarded status of the mining device.


Temperature

getAsicTemperature

The hashrate endpoint provides ASIC-level historical temperature operation data.


/api/v1/temperature/{hb_sn}/{asic_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/temperature/{hb_sn}/{asic_id}?duration=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemperatureApi;

import java.io.File;
import java.util.*;

public class TemperatureApiExample {

    public static void main(String[] args) {
        
        TemperatureApi apiInstance = new TemperatureApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide temperature information for.
        Integer asicId = 56; // Integer | The ID of the ASIC to provide temperature information for.
        String duration = duration_example; // String | 
        String granularity = granularity_example; // String | 
        try {
            TemperatureResponse result = apiInstance.getAsicTemperature(hbSn, asicId, duration, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemperatureApi#getAsicTemperature");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemperatureApi;

public class TemperatureApiExample {

    public static void main(String[] args) {
        TemperatureApi apiInstance = new TemperatureApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide temperature information for.
        Integer asicId = 56; // Integer | The ID of the ASIC to provide temperature information for.
        String duration = duration_example; // String | 
        String granularity = granularity_example; // String | 
        try {
            TemperatureResponse result = apiInstance.getAsicTemperature(hbSn, asicId, duration, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemperatureApi#getAsicTemperature");
            e.printStackTrace();
        }
    }
}
String *hbSn = hbSn_example; // The serial number of the hashboard to provide temperature information for.
Integer *asicId = 56; // The ID of the ASIC to provide temperature information for.
String *duration = duration_example; //  (optional) (default to 12h)
String *granularity = granularity_example; //  (optional) (default to 1m)

TemperatureApi *apiInstance = [[TemperatureApi alloc] init];

[apiInstance getAsicTemperatureWith:hbSn
    asicId:asicId
    duration:duration
    granularity:granularity
              completionHandler: ^(TemperatureResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.TemperatureApi()
var hbSn = hbSn_example; // {{String}} The serial number of the hashboard to provide temperature information for.
var asicId = 56; // {{Integer}} The ID of the ASIC to provide temperature information for.
var opts = { 
  'duration': duration_example, // {{String}} 
  'granularity': granularity_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAsicTemperature(hbSn, asicId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAsicTemperatureExample
    {
        public void main()
        {

            var apiInstance = new TemperatureApi();
            var hbSn = hbSn_example;  // String | The serial number of the hashboard to provide temperature information for.
            var asicId = 56;  // Integer | The ID of the ASIC to provide temperature information for.
            var duration = duration_example;  // String |  (optional)  (default to 12h)
            var granularity = granularity_example;  // String |  (optional)  (default to 1m)

            try
            {
                TemperatureResponse result = apiInstance.getAsicTemperature(hbSn, asicId, duration, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemperatureApi.getAsicTemperature: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTemperatureApi();
$hbSn = hbSn_example; // String | The serial number of the hashboard to provide temperature information for.
$asicId = 56; // Integer | The ID of the ASIC to provide temperature information for.
$duration = duration_example; // String | 
$granularity = granularity_example; // String | 

try {
    $result = $api_instance->getAsicTemperature($hbSn, $asicId, $duration, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemperatureApi->getAsicTemperature: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TemperatureApi;

my $api_instance = WWW::SwaggerClient::TemperatureApi->new();
my $hbSn = hbSn_example; # String | The serial number of the hashboard to provide temperature information for.
my $asicId = 56; # Integer | The ID of the ASIC to provide temperature information for.
my $duration = duration_example; # String | 
my $granularity = granularity_example; # String | 

eval { 
    my $result = $api_instance->getAsicTemperature(hbSn => $hbSn, asicId => $asicId, duration => $duration, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemperatureApi->getAsicTemperature: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TemperatureApi()
hbSn = hbSn_example # String | The serial number of the hashboard to provide temperature information for.
asicId = 56 # Integer | The ID of the ASIC to provide temperature information for.
duration = duration_example # String |  (optional) (default to 12h)
granularity = granularity_example # String |  (optional) (default to 1m)

try: 
    api_response = api_instance.get_asic_temperature(hbSn, asicId, duration=duration, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemperatureApi->getAsicTemperature: %s\n" % e)

Parameters

Path parameters
Name Description
hb_sn*
String
The serial number of the hashboard to provide temperature information for.
Required
asic_id*
Integer
The ID of the ASIC to provide temperature information for.
Required
Query parameters
Name Description
duration
String
granularity
String

Responses

Status: 200 - Successfully returned the requested ASIC-level temperature data.

Status: 400 - Bad request.

Status: 500 - Internal server error.


getHashboardTemperature

The temperature endpoint provides hashboard-level historical operation data.


/api/v1/temperature/{hb_sn}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/temperature/{hb_sn}?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemperatureApi;

import java.io.File;
import java.util.*;

public class TemperatureApiExample {

    public static void main(String[] args) {
        
        TemperatureApi apiInstance = new TemperatureApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide temperature information for.
        String duration = duration_example; // String | 
        try {
            TemperatureResponse result = apiInstance.getHashboardTemperature(hbSn, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemperatureApi#getHashboardTemperature");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemperatureApi;

public class TemperatureApiExample {

    public static void main(String[] args) {
        TemperatureApi apiInstance = new TemperatureApi();
        String hbSn = hbSn_example; // String | The serial number of the hashboard to provide temperature information for.
        String duration = duration_example; // String | 
        try {
            TemperatureResponse result = apiInstance.getHashboardTemperature(hbSn, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemperatureApi#getHashboardTemperature");
            e.printStackTrace();
        }
    }
}
String *hbSn = hbSn_example; // The serial number of the hashboard to provide temperature information for.
String *duration = duration_example; //  (optional) (default to 12h)

TemperatureApi *apiInstance = [[TemperatureApi alloc] init];

[apiInstance getHashboardTemperatureWith:hbSn
    duration:duration
              completionHandler: ^(TemperatureResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.TemperatureApi()
var hbSn = hbSn_example; // {{String}} The serial number of the hashboard to provide temperature information for.
var opts = { 
  'duration': duration_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHashboardTemperature(hbSn, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHashboardTemperatureExample
    {
        public void main()
        {

            var apiInstance = new TemperatureApi();
            var hbSn = hbSn_example;  // String | The serial number of the hashboard to provide temperature information for.
            var duration = duration_example;  // String |  (optional)  (default to 12h)

            try
            {
                TemperatureResponse result = apiInstance.getHashboardTemperature(hbSn, duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemperatureApi.getHashboardTemperature: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTemperatureApi();
$hbSn = hbSn_example; // String | The serial number of the hashboard to provide temperature information for.
$duration = duration_example; // String | 

try {
    $result = $api_instance->getHashboardTemperature($hbSn, $duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemperatureApi->getHashboardTemperature: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TemperatureApi;

my $api_instance = WWW::SwaggerClient::TemperatureApi->new();
my $hbSn = hbSn_example; # String | The serial number of the hashboard to provide temperature information for.
my $duration = duration_example; # String | 

eval { 
    my $result = $api_instance->getHashboardTemperature(hbSn => $hbSn, duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemperatureApi->getHashboardTemperature: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TemperatureApi()
hbSn = hbSn_example # String | The serial number of the hashboard to provide temperature information for.
duration = duration_example # String |  (optional) (default to 12h)

try: 
    api_response = api_instance.get_hashboard_temperature(hbSn, duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemperatureApi->getHashboardTemperature: %s\n" % e)

Parameters

Path parameters
Name Description
hb_sn*
String
The serial number of the hashboard to provide temperature information for.
Required
Query parameters
Name Description
duration
String

Responses

Status: 200 - Successfully returned the requested miner-level temperature data.

Status: 400 - Bad request.

Status: 422 - Unprocessable request.

Status: 500 - Internal server error.


getMinerTemperature

The temperature endpoint provides miner-level historical temperature operation data.


/api/v1/temperature

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/kkurucz/mining_development_kit_api/1.0.0/api/v1/temperature?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemperatureApi;

import java.io.File;
import java.util.*;

public class TemperatureApiExample {

    public static void main(String[] args) {
        
        TemperatureApi apiInstance = new TemperatureApi();
        String duration = duration_example; // String | 
        try {
            TemperatureResponse result = apiInstance.getMinerTemperature(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemperatureApi#getMinerTemperature");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemperatureApi;

public class TemperatureApiExample {

    public static void main(String[] args) {
        TemperatureApi apiInstance = new TemperatureApi();
        String duration = duration_example; // String | 
        try {
            TemperatureResponse result = apiInstance.getMinerTemperature(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemperatureApi#getMinerTemperature");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; //  (optional) (default to 12h)

TemperatureApi *apiInstance = [[TemperatureApi alloc] init];

[apiInstance getMinerTemperatureWith:duration
              completionHandler: ^(TemperatureResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var MiningDevelopmentKitApi = require('mining_development_kit_api');

var api = new MiningDevelopmentKitApi.TemperatureApi()
var opts = { 
  'duration': duration_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMinerTemperature(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMinerTemperatureExample
    {
        public void main()
        {

            var apiInstance = new TemperatureApi();
            var duration = duration_example;  // String |  (optional)  (default to 12h)

            try
            {
                TemperatureResponse result = apiInstance.getMinerTemperature(duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemperatureApi.getMinerTemperature: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTemperatureApi();
$duration = duration_example; // String | 

try {
    $result = $api_instance->getMinerTemperature($duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemperatureApi->getMinerTemperature: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TemperatureApi;

my $api_instance = WWW::SwaggerClient::TemperatureApi->new();
my $duration = duration_example; # String | 

eval { 
    my $result = $api_instance->getMinerTemperature(duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemperatureApi->getMinerTemperature: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TemperatureApi()
duration = duration_example # String |  (optional) (default to 12h)

try: 
    api_response = api_instance.get_miner_temperature(duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemperatureApi->getMinerTemperature: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String

Responses

Status: 200 - Successfully returned the requested miner-level temperature data.

Status: 400 - Bad request.

Status: 500 - Internal server error.