logo
API docs by Redocly

Simplemining.net API (latest)

Download OpenAPI specification:Download

REST API

Overview

The API is based on REST principles. It supports GET, POST, PUT, PATCH and DELETE requests.

Base URI

All URLs referenced in the documentation have the following base: https://api.simplemining.net

Authentication

apiKey

To call api methods you must provide api key.
The api key is listed in Account Settings on Subaccouts tab.
Each api key is assigned to subaccount and its permissions.

Security Scheme Type: API Key
Header parameter name: X-AUTH-TOKEN

Find Instances

Instances list

List instances for rent

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

order[gpuCount]
string
Enum: "asc" "desc"
Example: order[gpuCount]=desc

Order by GPUs

order[sla]
string
Enum: "asc" "desc"
Example: order[sla]=desc

Order by availability

order[pricePerGpu]
string
Enum: "asc" "desc"
Example: order[pricePerGpu]=desc

Order by price

order[sysDlp]
string
Enum: "asc" "desc"
Example: order[sysDlp]=desc

Order by DLPerf

order[pricePerDlp]
string
Enum: "asc" "desc"
Example: order[pricePerDlp]=desc

Order by DLPerf/$/h

order[gpuTFlops]
string
Enum: "asc" "desc"
Example: order[gpuTFlops]=desc

Order by TFLOPs

order[pricePerTFlops]
string
Enum: "asc" "desc"
Example: order[pricePerTFlops]=desc

Order by TFLOPs/$/h

region
string
Enum: "World" "Asia" "Europe" "North America" "Oceania" "South America" "Poland"
Example: region=World

Filter by region

downloadSpeedtest[gte]
int
Example: downloadSpeedtest[gte]=1

Filter by download speedtest (greater or equal than): value from 1 to 16384

downloadSpeedtest[lte]
int
Example: downloadSpeedtest[lte]=16384

Filter by download speedtest (lower or equals than): value from 1 to 16384

uploadSpeedtest[gte]
int
Example: uploadSpeedtest[gte]=1

Filter by upload speedtest (greater or equal than): value from 1 to 16384

uploadSpeedtest[lte]
int
Example: uploadSpeedtest[lte]=16384

Filter by upload speedtest (lower or equals than): value from 1 to 16384

diskSize[gte]
int
Example: diskSize[gte]=32

Filter by disk space GB (greater or equal than): value from 32 to 65536

diskSize[lte]
int
Example: diskSize[lte]=65536

Filter by disk space GB (lower or equals than): value from 32 to 65536

cpuCoreCount[gte]
int
Example: cpuCoreCount[gte]=1

Filter by CPU cores (greater or equal than): value from 1 to 512

cpuCoreCount[lte]
int
Example: cpuCoreCount[lte]=512

Filter by CPU cores (lower or equals than): value from 1 to 512

systemMemory[gte]
int
Example: systemMemory[gte]=4096

Filter by system memory MB (greater or equal than): value from 4096 to 8388608

systemMemory[lte]
int
Example: systemMemory[lte]=8388608

Filter by system memory MB (lower or equals than): value from 4096 to 8388608

diskSpeedWrite[gte]
int
Example: diskSpeedWrite[gte]=1

Filter by disk speed MB/s (greater or equal than): value from 1 to 131072

diskSpeedWrite[lte]
int
Example: diskSpeedWrite[lte]=131072

Filter by disk speed MB/s (lower or equals than): value from 1 to 131072

gpuModel
string
Enum: "Any" "RTX 4090"
Example: gpuModel=Any

Filter by GPU Model

gpuCount[gte]
int
Example: gpuCount[gte]=1

Filter by GPU count (greater or equal than): value from 1 to 16

gpuCount[lte]
int
Example: gpuCount[lte]=16

Filter by GPU count (lower or equals than): value from 1 to 16

gpuTFlops[gte]
int
Example: gpuTFlops[gte]=1

Filter by TFLOPS total (greater or equal than): value from 1 to 256

gpuTFlops[lte]
int
Example: gpuTFlops[lte]=256

Filter by TFLOPS total (lower or equals than): value from 1 to 256

gpuMemorySize[gte]
int
Example: gpuMemorySize[gte]=8192

Filter by GPU Memory size MB (greater or equal than): value from 8192 to 524288

gpuMemorySize[lte]
int
Example: gpuMemorySize[lte]=524288

Filter by GPU Memory size MB (lower or equals than): value from 8192 to 524288

gpuPcieBandwidth[gte]
int
Example: gpuPcieBandwidth[gte]=1

Filter by PCI-E bandwidth GBit/s (greater or equal than): value from 1 to 128

gpuPcieBandwidth[lte]
int
Example: gpuPcieBandwidth[lte]=128

Filter by PCI-E bandwidth GBit/s (lower or equals than): value from 1 to 128

gpuDriverVer
string
Example: gpuDriverVer=1

Filter by Driver version

gpuDriverVerOperator
string
Enum: "=" "<=" ">="
Example: gpuDriverVerOperator==

Filter by Driver version - comparison method

gpuCudaVer
string
Example: gpuCudaVer=1

Filter by CUDA version

gpuCudaVerOperator
string
Enum: "=" "<=" ">="
Example: gpuCudaVerOperator==

Filter by CUDA version - comparison method

rentalStatus
string
Enum: "Any" "active" "inactive"
Example: rentalStatus=Any

Filter by Rental status:
Any
active - Available for rent
inactive - Rented

sla[gte]
int
Example: sla[gte]=1

Filter by uptime % (greater or equal than): value from 1 to 100

sla[lte]
int
Example: sla[lte]=100

Filter by uptime % (lower or equals than): value from 1 to 100

rentalTimeMin[gte]
int
Example: rentalTimeMin[gte]=1

Filter by min duration h (greater or equal than): value from 1 to 8600

rentalTimeMin[lte]
int
Example: rentalTimeMin[lte]=8600

Filter by min duration h (lower or equals than): value from 1 to 8600

pricePerGpu[gte]
int

Filter by price $/hour (greater or equal than): value from 0 to 5

pricePerGpu[lte]
int
Example: pricePerGpu[lte]=5

Filter by price $/hour (lower or equals than): value from 0 to 5

pricePerTFlops[gte]
int

Filter by price TFLOPS/$/hour (greater or equal than): value from 0 to 200

pricePerTFlops[lte]
int
Example: pricePerTFlops[lte]=200

Filter by price TFLOPS/$/hour (lower or equals than): value from 0 to 200

pricePerDlp[gte]
int

Filter by price DLP/$/hour (greater or equal than): value from 0 to 200

pricePerDlp[lte]
int
Example: pricePerDlp[lte]=200

Filter by price DLP/$/hour (lower or equals than): value from 0 to 200

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/market/list?rentalStatus=active' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Global templates

List of global templates

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

search
string
Example: search=ubuntu

Filter by search phrase

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/global-templates/list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Global template details

Get global template details by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Template ID

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/global-templates/1' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "id": 0,
  • "imageName": "string",
  • "categoryName": "string",
  • "defaultTag": "string",
  • "diskSize": 0,
  • "exposePorts": "string",
  • "startScript": "string",
  • "argOptions": [ ],
  • "envVariables": [ ],
  • "notes": "string",
  • "host": "string",
  • "username": "string",
  • "password": "string",
  • "isPublic": true,
  • "isPasswordProtected": true,
  • "isRunSshServerOn": true,
  • "isRunJupyterOn": true
}

My Template Groups

List of my template groups

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

search
string
Example: search=ubuntu

Filter by search phrase

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/templates/list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

My Template Group details

Get my template template group details by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Template ID

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/templates/1' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "id": 0,
  • "imageName": "string",
  • "categoryName": "string",
  • "defaultTag": "string",
  • "diskSize": 0,
  • "exposePorts": "string",
  • "startScript": "string",
  • "argOptions": [ ],
  • "envVariables": [ ],
  • "notes": "string",
  • "host": "string",
  • "username": "string",
  • "password": "string",
  • "isPublic": true,
  • "isPasswordProtected": true,
  • "isRunSshServerOn": true,
  • "isRunJupyterOn": true
}

Update Template Group

Change Template Group details by ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
host
string

Host of private docker hub

username
string

Username of private docker hub

password
string

password of private docker hub

name
string

Name of template

imageName
string

Name of image

categoryName
float

Category of image

defaultTag
float

Tag of image

diskSize
int

Size of instances created with this template

exposePorts
string

Provide comma separated port numbers

startScript
float

Autostart bash script

argOptions
string

Docker image ARG

envVariables
Array of arrays

ENV variables

notes
string

Notes

isPasswordProtected
boolean

Custom repository server

isRunSshServerOn
boolean

SSH server

isRunJupyterOn
boolean

Jupyter Notebook

Responses

Request samples

Content type
application/json
{
  • "host": "https://hub.docker.com",
  • "username": "simplemining",
  • "password": "password",
  • "name": "ubuntu",
  • "imageName": "ubuntu",
  • "categoryName": "ubuntu",
  • "defaultTag": "latest",
  • "diskSize": 32,
  • "exposePorts": "22,80,443",
  • "startScript": null,
  • "argOptions": "string",
  • "envVariables": "[ { \"name\": \"ENV1\", \"value\": \"VALUE1\" } ]",
  • "notes": "string",
  • "isPasswordProtected": false,
  • "isRunSshServerOn": true,
  • "isRunJupyterOn": true
}

Response samples

Content type
application/json
{ }

Add Template Group

Add Template Group

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
host
string

Host of private docker hub

username
string

Username of private docker hub

password
string

password of private docker hub

name
string

Name of template

imageName
string

Name of image

categoryName
float

Category of image

defaultTag
float

Tag of image

diskSize
int

Size of instances created with this template

exposePorts
string

Provide comma separated port numbers

startScript
float

Autostart bash script

argOptions
string

Docker image ARG

envVariables
Array of arrays

ENV variables

notes
string

Notes

isPasswordProtected
boolean

Custom repository server

isRunSshServerOn
boolean

SSH server

isRunJupyterOn
boolean

Jupyter Notebook

Responses

Request samples

Content type
application/json
{
  • "host": "https://hub.docker.com",
  • "username": "simplemining",
  • "password": "password",
  • "name": "ubuntu",
  • "imageName": "ubuntu",
  • "categoryName": "ubuntu",
  • "defaultTag": "latest",
  • "diskSize": 32,
  • "exposePorts": "22,80,443",
  • "startScript": null,
  • "argOptions": "string",
  • "envVariables": "[ { \"name\": \"ENV1\", \"value\": \"VALUE1\" } ]",
  • "notes": "string",
  • "isPasswordProtected": false,
  • "isRunSshServerOn": true,
  • "isRunJupyterOn": true
}

Response samples

Content type
application/json
{ }

My Instances

My Instances list

List of my instances

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

search
string
Example: search=ubuntu

Filter by search phrase

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Execute Reboot

Execute Reboot on Instances by IDs

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
instanceIds
Array of arrays

Provide Instance IDs

Responses

Request samples

Content type
application/merge-patch+json
{
  • "instanceIds": [
    ]
}

Response samples

Content type
application/json
{ }

My instance details

Get my instance details by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Instance ID

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/1' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "id": 0,
  • "hashId": "string",
  • "name": "string",
  • "notes": "string",
  • "gpuModel": "string",
  • "gpuMemorySize": 0,
  • "gpuCount": 0,
  • "cpuCoreCount": null,
  • "systemMemory": 0,
  • "diskSize": 0,
  • "diskSizeMax": 0,
  • "status": "active",
  • "duration": 0,
  • "rentalType": "demand",
  • "pricePerGpu": null,
  • "pricePerDiskSize": null,
  • "priceAutoRenewMax": null,
  • "expiresAt": "2025-05-10T13:59:01+02:00",
  • "autoRenewAt": "2025-05-10T13:59:01+02:00",
  • "isAutoRenewOn": true,
  • "instanceTemplate": {
    },
  • "ports": {
    },
  • "cpuUsage": 0,
  • "memUsage": 0,
  • "diskUsage": 0,
  • "processUptime": 0,
  • "console": "string",
  • "consoleSystem": "string"
}

Update Instance

Change Instance details by ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
isAutoRenewOn
boolean

Set Allow Auto Renew

priceAutoRenewMax
float

Set max price for auto renew

notes
string

Set notes

instanceTemplate
string

IRI of template

name
string

Set name of instance

Responses

Request samples

Content type
application/json
{
  • "isAutoRenewOn": true,
  • "priceAutoRenewMax": 1,
  • "notes": "notes here",
  • "instanceTemplate": "/instances/templates/29",
  • "name": "sensible_pangolin"
}

Response samples

Content type
application/json
{ }

Delete My Instance

Delete Instance by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Instance ID

Responses

Request samples 

curl --location --request DELETE 'https://api.simplemining.net/instances/1' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{}

Rent Instance

Rent instance

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
gpuCount
integer

Number of GPUs

instanceMarket
float

IRI of instance market

instanceTemplate
string

IRI of template group

Responses

Request samples

Content type
application/json
{
  • "gpuCount": 1,
  • "instanceMarket": "/instances/market/1",
  • "instanceTemplate": "/instances/templates/29"
}

Response samples

Content type
application/json
{ }

Templates

Global templates

List of global templates

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

search
string
Example: search=ubuntu

Filter by search phrase

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/global-templates/list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Global template details

Get global template details by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Template ID

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/global-templates/1' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "id": 0,
  • "imageName": "string",
  • "categoryName": "string",
  • "defaultTag": "string",
  • "diskSize": 0,
  • "exposePorts": "string",
  • "startScript": "string",
  • "argOptions": [ ],
  • "envVariables": [ ],
  • "notes": "string",
  • "host": "string",
  • "username": "string",
  • "password": "string",
  • "isPublic": true,
  • "isPasswordProtected": true,
  • "isRunSshServerOn": true,
  • "isRunJupyterOn": true
}

My Template Groups

List of my template groups

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

search
string
Example: search=ubuntu

Filter by search phrase

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/templates/list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

My Template Group details

Get my template template group details by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Template ID

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/templates/1' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "id": 0,
  • "imageName": "string",
  • "categoryName": "string",
  • "defaultTag": "string",
  • "diskSize": 0,
  • "exposePorts": "string",
  • "startScript": "string",
  • "argOptions": [ ],
  • "envVariables": [ ],
  • "notes": "string",
  • "host": "string",
  • "username": "string",
  • "password": "string",
  • "isPublic": true,
  • "isPasswordProtected": true,
  • "isRunSshServerOn": true,
  • "isRunJupyterOn": true
}

Update Template Group

Change Template Group details by ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
host
string

Host of private docker hub

username
string

Username of private docker hub

password
string

password of private docker hub

name
string

Name of template

imageName
string

Name of image

categoryName
float

Category of image

defaultTag
float

Tag of image

diskSize
int

Size of instances created with this template

exposePorts
string

Provide comma separated port numbers

startScript
float

Autostart bash script

argOptions
string

Docker image ARG

envVariables
Array of arrays

ENV variables

notes
string

Notes

isPasswordProtected
boolean

Custom repository server

isRunSshServerOn
boolean

SSH server

isRunJupyterOn
boolean

Jupyter Notebook

Responses

Request samples

Content type
application/json
{
  • "host": "https://hub.docker.com",
  • "username": "simplemining",
  • "password": "password",
  • "name": "ubuntu",
  • "imageName": "ubuntu",
  • "categoryName": "ubuntu",
  • "defaultTag": "latest",
  • "diskSize": 32,
  • "exposePorts": "22,80,443",
  • "startScript": null,
  • "argOptions": "string",
  • "envVariables": "[ { \"name\": \"ENV1\", \"value\": \"VALUE1\" } ]",
  • "notes": "string",
  • "isPasswordProtected": false,
  • "isRunSshServerOn": true,
  • "isRunJupyterOn": true
}

Response samples

Content type
application/json
{ }

Delete Template Group

Delete Instance by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Instance ID

Responses

Request samples 

curl --location --request DELETE 'https://api.simplemining.net/instances/templates/1' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{}

Add Template Group

Add Template Group

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
host
string

Host of private docker hub

username
string

Username of private docker hub

password
string

password of private docker hub

name
string

Name of template

imageName
string

Name of image

categoryName
float

Category of image

defaultTag
float

Tag of image

diskSize
int

Size of instances created with this template

exposePorts
string

Provide comma separated port numbers

startScript
float

Autostart bash script

argOptions
string

Docker image ARG

envVariables
Array of arrays

ENV variables

notes
string

Notes

isPasswordProtected
boolean

Custom repository server

isRunSshServerOn
boolean

SSH server

isRunJupyterOn
boolean

Jupyter Notebook

Responses

Request samples

Content type
application/json
{
  • "host": "https://hub.docker.com",
  • "username": "simplemining",
  • "password": "password",
  • "name": "ubuntu",
  • "imageName": "ubuntu",
  • "categoryName": "ubuntu",
  • "defaultTag": "latest",
  • "diskSize": 32,
  • "exposePorts": "22,80,443",
  • "startScript": null,
  • "argOptions": "string",
  • "envVariables": "[ { \"name\": \"ENV1\", \"value\": \"VALUE1\" } ]",
  • "notes": "string",
  • "isPasswordProtected": false,
  • "isRunSshServerOn": true,
  • "isRunJupyterOn": true
}

Response samples

Content type
application/json
{ }

Billing

List of usage

List of usage

Authorizations:
apiKey
query Parameters
instanceId
integer
Example: instanceId=1

Instance ID

itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/billing/list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Deposits

List of your deposits

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/instances/deposit/list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Rig List

Get Rig List

Get Rig List for User

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

order[name]
string
Enum: "asc" "desc"
Example: order[name]=desc

Order by name

order[hashrate]
string
Enum: "asc" "desc"
Example: order[hashrate]=desc

Order by hashrate

order[status]
string
Enum: "asc" "desc"
Example: order[status]=desc

Order by status

order[temp]
string
Enum: "asc" "desc"
Example: order[temp]=desc

Order by max temperature

order[rigOc.name]
string
Enum: "asc" "desc"
Example: order[rigOc.name]=desc

Order by Group OC name

order[description]
string
Enum: "asc" "desc"
Example: order[description]=desc

Order by info

order[startCount]
string
Enum: "asc" "desc"
Example: order[startCount]=desc

Order by number of restarts

order[sysPwr]
string
Enum: "asc" "desc"
Example: order[sysPwr]=desc

Order by power consumption (watts)

statusAlert
string
Enum: "has_alerts" "no_alerts" "reboot" "gpu" "paused" "temp"
Example: statusAlert=has_alerts

Filter by alerts:
has_alerts - With alerts
no_alerts - Without alerts
reboot - Only Reboots
gpu - Only Missing GPU
paused - Only Paused
temp - Only Temp

status
string
Enum: "on" "off"
Example: status=on

Filter by status

statusAddedTimeDelay
integer
Example: statusAddedTimeDelay=3600

Filter by rig added within (value in seconds)

statusTimeDelay
integer
Example: statusTimeDelay=3600

Filter by status OFF within (value in seconds)

statusTimeGreaterThan
integer
Example: statusTimeGreaterThan=3600

Filter by status OFF more than (value in seconds)

osSeries
string
Example: osSeries=NV

Filter by osSeries
see: Get filter List

rigGroup
integer
Example: rigGroup=1

Filter by Group Config ID
see: Get filter List

rigOc
integer
Example: rigOc=1

Filter by Group OC ID
see: Get filter List

userTags[]
Array of integers
Example: userTags[]=1

Filter by Tags
see: Get filter List

search
string

Filter by name, description, OS Series, OS Version, Group Config name, Group OC name, Support ID

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/rigs/user-list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Get Filter List

Get Filter List for User

Authorizations:
apiKey

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/rigs/filter-list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Get Rigs Summary

Get Rigs summary details

Authorizations:
apiKey
query Parameters
order[name]
string
Enum: "asc" "desc"
Example: order[name]=desc

Order by name

order[hashrate]
string
Enum: "asc" "desc"
Example: order[hashrate]=desc

Order by hashrate

order[status]
string
Enum: "asc" "desc"
Example: order[status]=desc

Order by status

order[temp]
string
Enum: "asc" "desc"
Example: order[temp]=desc

Order by max temperature

order[rigOc.name]
string
Enum: "asc" "desc"
Example: order[rigOc.name]=desc

Order by Group OC name

order[description]
string
Enum: "asc" "desc"
Example: order[description]=desc

Order by info

statusAlert
string
Enum: "has_alerts" "no_alerts" "reboot" "gpu" "paused" "temp"
Example: statusAlert=has_alerts

Filter by alerts:
has_alerts - With alerts
no_alerts - Without alerts
reboot - Only Reboots
gpu - Only Missing GPU
paused - Only Paused
temp - Only Temp

status
string
Enum: "on" "off"
Example: status=on

Filter by status

statusAddedTimeDelay
integer
Example: statusAddedTimeDelay=3600

Filter by rig added within (value in seconds)

statusTimeDelay
integer
Example: statusTimeDelay=3600

Filter by status OFF within (value in seconds)

statusTimeGreaterThan
integer
Example: statusTimeGreaterThan=3600

Filter by status OFF more than (value in seconds)

osSeries
string
Example: osSeries=NV

Filter by osSeries
see: Get filter List

rigGroup
integer
Example: rigGroup=1

Filter by Group Config ID
see: Get filter List

rigOc
integer
Example: rigOc=1

Filter by Group OC ID
see: Get filter List

userTags[]
Array of integers
Example: userTags[]=1

Filter by Tags
see: Get filter List

search
string

Filter by name, description, OS Series, OS Version, Group Config name, Group OC name, Support ID

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/rigs/summary' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "all": {
    },
  • "filtered": {
    }
}

Get Rig Details

Get Rig Details by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Rig ID

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/rigs/1' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "id": 0,
  • "supportId": "string",
  • "name": "string",
  • "description": "string",
  • "startCount": 0,
  • "ebSerial": "string",
  • "ip": "string",
  • "gpuCountMax": 0,
  • "executeStatus": "string",
  • "osSeries": "string",
  • "osVersion": "string",
  • "ocCore": "string",
  • "ocMemory": "string",
  • "ocPowerLimit": "string",
  • "ocVddc": "string",
  • "ocMode": true,
  • "ocTempTarget": "string",
  • "ocFanSpeedMin": "string",
  • "ocAdvTools": "string",
  • "ocMvdd": "string",
  • "ocMvddci": "string",
  • "dateResetCounter": "2022-05-10T13:59:01+02:00",
  • "date": "2022-03-16T11:47:34+01:00",
  • "dateStart": "2022-03-10T09:27:30+01:00",
  • "isPaused": true,
  • "isOcAdvToolsOn": true,
  • "isOcDelayed": true,
  • "isOnline": true,
  • "srrSerial": "string",
  • "srrSlot": 0,
  • "isSrrEnabled": true,
  • "rigGroup": {
    },
  • "rigOc": {
    },
  • "schedule": {
    },
  • "userTags": [
    ],
  • "redisData": null,
  • "alerts": [
    ],
  • "gpuList": [
    ]
}

Delete Rig

Delete Rig by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Rig ID

Responses

Request samples 

curl --location --request DELETE 'https://api.simplemining.net/rigs/1' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{}

Get Rig Console

Get Rig Console by ID

Authorizations:
apiKey
path Parameters
id
required
integer
Example: 1

Rig ID

query Parameters
type
string
Enum: "debug" "dmesg"

Console Type

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/rigs/1/console' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "console": "string"
}

Change Group Config

Change Group Config in Rigs by Rig IDs

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigGroupId
integer

Group Config ID

execute
string

Provide additional execute command:
reload - reload rigs after change
reboot - reboot rigs after change

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigGroupId": 7,
  • "execute": "reload"
}

Response samples

Content type
application/json
{ }

Change Group OC

Change Group OC in Rigs by Rig IDs

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Group OC ID

action
string

Provide action type:
link - change Group OC on given rigs
unlink - remove Group OC from given rigs

execute
string

Provide execute command:
reload - reload rigs after change
reboot - reboot rigs after change

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 7,
  • "action": "link",
  • "execute": "reload"
}

Response samples

Content type
application/json
{ }

Execute Reboot

Execute Reboot on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ]
}

Response samples

Content type
application/json
{ }

Execute Reload

Execute Reload on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ]
}

Response samples

Content type
application/json
{ }

Execute Pause

Execute Pause on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ]
}

Response samples

Content type
application/json
{ }

Execute Resume

Execute Resume on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ]
}

Response samples

Content type
application/json
{ }

Execute Find Rig

Execute Find Rig on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ]
}

Response samples

Content type
application/json
{ }

Execute Find GPU

Execute Find GPU on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

gpuId
integer

Number starting of 0

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ],
  • "gpuId": 0
}

Response samples

Content type
application/json
{ }

Execute Shutdown

Execute Shutdown on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ]
}

Response samples

Content type
application/json
{ }

Execute Sleep

Execute Sleep on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

minutes
integer

Number of minutes

hours
integer

Number of hours

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ],
  • "minutes": 1,
  • "hours": 1
}

Response samples

Content type
application/json
{ }

Execute Clear Counter

Execute Clear Counter on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ]
}

Response samples

Content type
application/json
{ }

Execute Delete

Execute Delete on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ]
}

Response samples

Content type
application/json
{ }

Execute Command

Execute Command on Rigs by Rig IDs, Group OC ID or Group Config ID

Authorizations:
apiKey
header Parameters
Content-Type
required
string
Example: application/merge-patch+json
Request Body schema: application/merge-patch+json
rigIds
Array of arrays

Provide Rig IDs to apply change on selected Rigs

rigOcId
integer

Provide Group OC ID to apply change on Rigs within this group

rigGroupId
integer

Provide Group Config ID to apply change on Rigs within this group

rigGroupIds
Array of arrays

Provide Group Config IDs to apply change on Rigs within this groups

commandId
integer

Command ID

commandOptions
string

Provide command options when applicable

Responses

Request samples

Content type
application/merge-patch+json
{
  • "rigIds": [
    ],
  • "rigOcId": 1,
  • "rigGroupId": 1,
  • "rigGroupIds": [
    ],
  • "commandId": 7,
  • "commandOptions": "string"
}

Response samples

Content type
application/json
{ }

Group Config

Get available Group Configs

Get available Group Configs

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

order[name]
string
Enum: "asc" "desc"
Example: order[name]=desc

Order by name

order[rigsCount]
string
Enum: "asc" "desc"
Example: order[rigsCount]=desc

Order by rigs count

order[minerProgram.name]
string
Enum: "asc" "desc"
Example: order[minerProgram.name]=desc

Order by miner program name

search
string

Filter by name, description

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/rig-groups/user-list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Group OC

Get available Group OCs

Get available Group OCs

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

order[name]
string
Enum: "asc" "desc"
Example: order[name]=desc

Order by name

order[rigsCount]
string
Enum: "asc" "desc"
Example: order[rigsCount]=desc

Order by rigs count

order[ocCore]
string
Enum: "asc" "desc"
Example: order[ocCore]=desc

Order by core

order[ocMemory]
string
Enum: "asc" "desc"
Example: order[ocMemory]=desc

Order by memory

order[ocVddc]
string
Enum: "asc" "desc"
Example: order[ocVddc]=desc

Order by core voltage

order[ocMvdd]
string
Enum: "asc" "desc"
Example: order[ocMvdd]=desc

Order by MVDD

order[ocMvddci]
string
Enum: "asc" "desc"
Example: order[ocMvddci]=desc

Order by MVDDCI

order[ocMode]
string
Enum: "asc" "desc"
Example: order[ocMode]=desc

Order by aggressive undervolt

order[ocPowerLimit]
string
Enum: "asc" "desc"
Example: order[ocPowerLimit]=desc

Order by power stage (RX) or power limit (NV)

order[ocTempTarget]
string
Enum: "asc" "desc"
Example: order[ocTempTarget]=desc

Order by target temp

order[ocFanSpeedMin]
string
Enum: "asc" "desc"
Example: order[ocFanSpeedMin]=desc

Order by min fan speed

order[isOcAdvToolsOn]
string
Enum: "asc" "desc"
Example: order[isOcAdvToolsOn]=desc

Order by advanced tools

osSeries
string
Enum: "RX" "NV" "R"
Example: osSeries=has_alerts

Filter by osSeries:
RX - AMD rigs
NV - Nvidia rigs
R - very old AMD (HD7000/R200) rigs

search
string

Filter by name, description

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/rig-ocs/user-list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Commands

Get available commands

Get available commands to execute on rig

Authorizations:
apiKey

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/rig-commands' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[
  • {
    }
]

Deposit Fee

Get deposit address

Get deposit address by currency code

Authorizations:
apiKey
query Parameters
currency
required
string
Enum: "BTC" "ETH" "ETC" "ZEC" "LTC"
Example: currency=ETH

Currency code

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/deposits/address?currency=eth' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "currency": "ETH",
  • "currencyStatus": "online",
  • "address": "0x734272hdhduahdufu38748er7wDC"
}

Get deposit summary

Get deposit summary including balance, service days remaining, etc

Authorizations:
apiKey

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/deposits/summary' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
{
  • "balanceUsd": "20.002",
  • "daysRemaining": 10,
  • "isAccountBlocked": false,
  • "rates": {
    },
  • "last24hRigsCount": 2,
  • "discountLevel": 0,
  • "discountLevelRate": 1,
  • "currentPricePerRig": 2
}

Get deposit list

Get deposit list with transaction ID, status, etc

Authorizations:
apiKey
query Parameters
itemsPerPage
integer
Example: itemsPerPage=100

Number of items returned

page
integer
Example: page=1

Number of page

order[createdAt]
string
Enum: "asc" "desc"
Example: order[createdAt]=desc

Order by createdAt

order[amountUsd]
string
Enum: "asc" "desc"
Example: order[amountUsd]=desc

Order by amountUsd

order[status]
string
Enum: "asc" "desc"
Example: order[status]=desc

Order by status

Responses

Request samples 

curl --location --request GET 'https://api.simplemining.net/deposits/user-list' \
--header 'X-AUTH-TOKEN: apiKey'

Response samples

Content type
application/json
[]