Download OpenAPI specification:Download
All URLs referenced in the documentation have the following base: https://api.simplemining.net
List instances for rent
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: |
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 |
curl --location --request GET 'https://api.simplemining.net/instances/market/list?rentalStatus=active' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 0,
- "instanceMarket": "/instances/market/1",
- "cpuCoreCount": 0,
- "cpuModel": "string",
- "diskSize": 0,
- "diskSpeedRead": 0,
- "diskSpeedWrite": 0,
- "diskType": "string",
- "downloadSpeedtest": 0,
- "errors": [ ],
- "gpuCount": 0,
- "gpuCudaVer": "string",
- "gpuDriverVer": "string",
- "gpuMemorySize": 0,
- "gpuModel": "string",
- "gpuPcieBandwidth": 0,
- "gpuPcieGen": 0,
- "gpuPcieWidth": 0,
- "gpuTFlops": 0,
- "expiresAt": "2025-05-10T13:59:01+02:00",
- "isAvailableForDemand": true,
- "isAvailableForInterruptible": true,
- "pricePerDiskSize": null,
- "pricePerDlp": null,
- "pricePerGpu": null,
- "pricePerTFlops": null,
- "rentalTimeMax": 0,
- "sla": null,
- "sysDlp": 0,
- "systemMemory": 0,
- "uploadSpeedtest": 0
}
]
List of global templates
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 |
curl --location --request GET 'https://api.simplemining.net/instances/global-templates/list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 0,
- "imageName": "string",
- "categoryName": "string",
- "defaultTag": "string",
- "diskSize": 0,
- "exposePorts": "string",
- "startScript": "string",
- "argOptions": [ ],
- "envVariables": [ ],
- "notes": "string",
- "isPublic": true,
- "isRunSshServerOn": true,
- "isRunJupyterOn": true
}
]
Get global template details by ID
id required | integer Example: 1 Template ID |
curl --location --request GET 'https://api.simplemining.net/instances/global-templates/1' \ --header 'X-AUTH-TOKEN: apiKey'
{- "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
}
List of my template groups
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 |
curl --location --request GET 'https://api.simplemining.net/instances/templates/list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 0,
- "imageName": "string",
- "categoryName": "string",
- "defaultTag": "string",
- "diskSize": 0,
- "exposePorts": "string",
- "notes": "string",
- "isPasswordProtected": true,
- "isRunSshServerOn": true,
- "isRunJupyterOn": true
}
]
Get my template template group details by ID
id required | integer Example: 1 Template ID |
curl --location --request GET 'https://api.simplemining.net/instances/templates/1' \ --header 'X-AUTH-TOKEN: apiKey'
{- "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
}
Change Template Group details by ID
Content-Type required | string Example: 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 |
{- "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
}
{ }
Add Template Group
Content-Type required | string Example: 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 |
{- "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
}
{ }
List of my instances
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 |
curl --location --request GET 'https://api.simplemining.net/instances/list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 0,
- "hashId": "string",
- "name": "string",
- "notes": "string",
- "gpuModel": "string",
- "gpuMemorySize": 0,
- "gpuCount": 0,
- "cpuCoreCount": null,
- "diskSize": 0,
- "status": "active",
- "duration": 0,
- "rentalType": "demand",
- "pricePerGpu": null,
- "pricePerDiskSize": null,
- "priceAutoRenewMax": null,
- "createdAt": "2025-05-10T13:59:01+02:00",
- "expiresAt": "2025-05-10T13:59:01+02:00",
- "autoRenewAt": "2025-05-10T13:59:01+02:00",
- "isAutoRenewOn": true,
- "ports": {
- "direct": null,
- "proxy": null
}, - "cpuUsage": 0,
- "memUsage": 0,
- "diskUsage": 0,
- "processUptime": 0,
- "console": "string",
- "consoleSystem": "string"
}
]
Execute Reboot on Instances by IDs
Content-Type required | string Example: application/merge-patch+json |
instanceIds | Array of arrays Provide Instance IDs |
{- "instanceIds": [
- 1,
- 2,
- 3
]
}
{ }
Get my instance details by ID
id required | integer Example: 1 Instance ID |
curl --location --request GET 'https://api.simplemining.net/instances/1' \ --header 'X-AUTH-TOKEN: apiKey'
{- "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": {
- "id": 0,
- "imageName": "string",
- "defaultTag": "string",
- "isRunSshServerOn": true,
- "isRunJupyterOn": true
}, - "ports": {
- "direct": null,
- "proxy": null
}, - "cpuUsage": 0,
- "memUsage": 0,
- "diskUsage": 0,
- "processUptime": 0,
- "console": "string",
- "consoleSystem": "string"
}
Change Instance details by ID
Content-Type required | string Example: 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 |
{- "isAutoRenewOn": true,
- "priceAutoRenewMax": 1,
- "notes": "notes here",
- "instanceTemplate": "/instances/templates/29",
- "name": "sensible_pangolin"
}
{ }
Delete Instance by ID
id required | integer Example: 1 Instance ID |
curl --location --request DELETE 'https://api.simplemining.net/instances/1' \ --header 'X-AUTH-TOKEN: apiKey'
{- "title": "An error occurred",
- "detail": "Invalid credentials."
}
Rent instance
Content-Type required | string Example: application/json |
gpuCount | integer Number of GPUs |
instanceMarket | float IRI of instance market |
instanceTemplate | string IRI of template group |
{- "gpuCount": 1,
- "instanceMarket": "/instances/market/1",
- "instanceTemplate": "/instances/templates/29"
}
{ }
List of global templates
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 |
curl --location --request GET 'https://api.simplemining.net/instances/global-templates/list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 0,
- "imageName": "string",
- "categoryName": "string",
- "defaultTag": "string",
- "diskSize": 0,
- "exposePorts": "string",
- "startScript": "string",
- "argOptions": [ ],
- "envVariables": [ ],
- "notes": "string",
- "isPublic": true,
- "isRunSshServerOn": true,
- "isRunJupyterOn": true
}
]
Get global template details by ID
id required | integer Example: 1 Template ID |
curl --location --request GET 'https://api.simplemining.net/instances/global-templates/1' \ --header 'X-AUTH-TOKEN: apiKey'
{- "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
}
List of my template groups
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 |
curl --location --request GET 'https://api.simplemining.net/instances/templates/list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 0,
- "imageName": "string",
- "categoryName": "string",
- "defaultTag": "string",
- "diskSize": 0,
- "exposePorts": "string",
- "notes": "string",
- "isPasswordProtected": true,
- "isRunSshServerOn": true,
- "isRunJupyterOn": true
}
]
Get my template template group details by ID
id required | integer Example: 1 Template ID |
curl --location --request GET 'https://api.simplemining.net/instances/templates/1' \ --header 'X-AUTH-TOKEN: apiKey'
{- "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
}
Change Template Group details by ID
Content-Type required | string Example: 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 |
{- "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
}
{ }
Delete Instance by ID
id required | integer Example: 1 Instance ID |
curl --location --request DELETE 'https://api.simplemining.net/instances/templates/1' \ --header 'X-AUTH-TOKEN: apiKey'
{- "title": "An error occurred",
- "detail": "Invalid credentials."
}
Add Template Group
Content-Type required | string Example: 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 |
{- "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
}
{ }
List of usage
instanceId | integer Example: instanceId=1 Instance ID |
itemsPerPage | integer Example: itemsPerPage=100 Number of items returned |
page | integer Example: page=1 Number of page |
curl --location --request GET 'https://api.simplemining.net/instances/billing/list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 0,
- "hashId": "string",
- "name": "string",
- "notes": "string",
- "gpuModel": "string",
- "gpuMemorySize": 0,
- "gpuCount": 0,
- "cpuCoreCount": null,
- "diskSize": 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": {
- "id": 0,
- "imageName": "string",
- "defaultTag": "string",
- "isRunSshServerOn": true,
- "isRunJupyterOn": true
}, - "ports": {
- "direct": null,
- "proxy": null
}, - "cpuUsage": 0,
- "memUsage": 0,
- "diskUsage": 0,
- "processUptime": 0,
- "console": "string",
- "consoleSystem": "string"
}
]
List of your deposits
itemsPerPage | integer Example: itemsPerPage=100 Number of items returned |
page | integer Example: page=1 Number of page |
curl --location --request GET 'https://api.simplemining.net/instances/deposit/list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 0,
- "cpuCoreCount": 0,
- "cpuModel": "string",
- "diskSize": 0,
- "diskSpeedRead": 0,
- "diskSpeedWrite": 0,
- "diskType": "string",
- "downloadSpeedtest": 0,
- "errors": [ ],
- "gpuCount": 0,
- "gpuCudaVer": "string",
- "gpuDriverVer": "string",
- "gpuMemorySize": 0,
- "gpuModel": "string",
- "gpuPcieBandwidth": 0,
- "gpuPcieGen": 0,
- "gpuPcieWidth": 0,
- "gpuTFlops": 0,
- "expiresAt": "2025-05-10T13:59:01+02:00",
- "isAvailableForDemand": true,
- "isAvailableForInterruptible": true,
- "pricePerDiskSize": null,
- "pricePerDlp": null,
- "pricePerGpu": null,
- "pricePerTFlops": null,
- "rentalTimeMax": 0,
- "sla": null,
- "sysDlp": 0,
- "systemMemory": 0,
- "uploadSpeedtest": 0
}
]
Get Rig List for User
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: |
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 | |
rigGroup | |
rigOc | |
userTags[] | |
search | string Filter by name, description, OS Series, OS Version, Group Config name, Group OC name, Support ID |
curl --location --request GET 'https://api.simplemining.net/rigs/user-list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 0,
- "name": "string",
- "description": "string",
- "startCount": 0,
- "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,
- "user": {
- "alertRestartLimit": 15
}, - "rigGroup": {
- "id": 1,
- "name": "string",
- "minerProgram": {
- "id": 1,
- "name": "teamredminer-v0.9.4.1"
}
}, - "rigOc": {
- "id": 1,
- "name": "string",
- "osSeries": "RX",
- "ocCore": "string",
- "ocMemory": "string",
- "ocPowerLimit": "string",
- "ocVddc": "string",
- "ocMode": true,
- "ocTempTarget": "string",
- "ocFanSpeedMin": "string",
- "ocAdvTools": "string",
- "ocMvdd": "string",
- "ocMvddci": "string",
- "isOcAdvToolsOn": true,
- "isOcDelayed": true
}, - "schedule": {
- "id": 1,
- "name": "string",
- "color": "string"
}, - "userTags": [
- {
- "id": 1,
- "name": "string",
- "description": "string",
- "color": "string"
}
], - "redisData": {
- "ipLAN": "string",
- "ipWAN4": "string",
- "ipWAN6": "string",
- "kernel": "string",
- "driver": "string",
- "gpuCoreClk": [ ],
- "gpuMemClk": [ ],
- "rej": "string",
- "acc": "string",
- "hash": "string",
- "hash2": "string",
- "gpuCount": "string",
- "consoleShort": "string",
- "gpuHash": [ ],
- "gpuTemp": [ ],
- "gpuFan": [ ],
- "gpuPwrCur": [ ],
- "sysPwr": "string",
- "uptime": "string"
}, - "alerts": [ ],
- "valueLastUpdate": 0,
- "calculatedPeriod": 0,
- "processUptime": 0
}
]
curl --location --request GET 'https://api.simplemining.net/rigs/filter-list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "osSeries": [
- {
- "osSeries": "NV"
}
], - "rigOc": [
- {
- "id": 1,
- "name": "string"
}
], - "rigGroup": [
- {
- "id": 1,
- "name": "string"
}
], - "userTags": [
- {
- "id": 1,
- "name": "string",
- "color": "string"
}
]
}
]
Get Rigs summary details
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: |
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 | |
rigGroup | |
rigOc | |
userTags[] | |
search | string Filter by name, description, OS Series, OS Version, Group Config name, Group OC name, Support ID |
curl --location --request GET 'https://api.simplemining.net/rigs/summary' \ --header 'X-AUTH-TOKEN: apiKey'
{- "all": {
- "online": {
- "paused": {
- "rigs": [
- "A01",
- "A02"
], - "rigCountTotal": 2
}, - "temp": {
- "rigs": [
- "A01",
- "A02"
], - "rigCountTotal": 2
}, - "reboot": {
- "rigs": [
- "A01",
- "A02"
], - "rigCountTotal": 2
}, - "gpu": {
- "rigs": [
- {
- "rigName": "A01",
- "gpuCountMissing": 2
}
], - "rigCountTotal": 1,
- "gpuCountMaxTotal": 14,
- "gpuCountTotal": 12,
- "gpuCountMissing": 2
}, - "group": [
- {
- "name": "string",
- "hashTotal": 120300000,
- "sysPwrTotal": 700
}
], - "maxTemps": {
- "rigs": [
- {
- "rigName": "string",
- "gpuTemp": 68,
- "gpuFan": 0
}
], - "maxTemp": 68,
- "maxFan": 0
}, - "maxFans": {
- "rigs": [
- {
- "rigName": "string",
- "gpuTemp": 65,
- "gpuFan": 100
}
], - "maxTemp": 65,
- "maxFan": 100
}, - "sysPwrTotal": 1469,
- "hashTotal": 249784987,
- "rigs": [ ],
- "rigCountTotal": 2
}, - "offline": {
- "rigs": [
- "A01",
- "A02"
], - "rigCountTotal": 2
}
}, - "filtered": {
- "online": {
- "paused": {
- "rigs": [
- "A01",
- "A02"
], - "rigCountTotal": 2
}, - "temp": {
- "rigs": [
- "A01",
- "A02"
], - "rigCountTotal": 2
}, - "reboot": {
- "rigs": [
- "A01",
- "A02"
], - "rigCountTotal": 2
}, - "gpu": {
- "rigs": [
- {
- "rigName": "A01",
- "gpuCountMissing": 2
}
], - "rigCountTotal": 1,
- "gpuCountMaxTotal": 14,
- "gpuCountTotal": 12,
- "gpuCountMissing": 2
}, - "group": [
- {
- "name": "string",
- "hashTotal": 120300000,
- "sysPwrTotal": 700
}
], - "maxTemps": {
- "rigs": [
- {
- "rigName": "string",
- "gpuTemp": 68,
- "gpuFan": 0
}
], - "maxTemp": 68,
- "maxFan": 0
}, - "maxFans": {
- "rigs": [
- {
- "rigName": "string",
- "gpuTemp": 65,
- "gpuFan": 100
}
], - "maxTemp": 65,
- "maxFan": 100
}, - "sysPwrTotal": 1469,
- "hashTotal": 249784987,
- "rigs": [ ],
- "rigCountTotal": 2
}, - "offline": {
- "rigs": [
- "A01",
- "A02"
], - "rigCountTotal": 2
}
}
}
Get Rig Details by ID
id required | integer Example: 1 Rig ID |
curl --location --request GET 'https://api.simplemining.net/rigs/1' \ --header 'X-AUTH-TOKEN: apiKey'
{- "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": {
- "id": 0,
- "name": 0
}, - "rigOc": {
- "id": 0,
- "name": 0
}, - "schedule": {
- "id": 0,
- "name": 0
}, - "userTags": [
- "string"
], - "redisData": null,
- "alerts": [
- "string"
], - "gpuList": [
- {
- "no": 0,
- "model": "string",
- "core": "string",
- "mem": "string",
- "fanspeed": "string",
- "temp": "string",
- "asicTemp": "string",
- "memTemp": "string",
- "gpuPciBus": "string",
- "gpuVramSize": "string",
- "gpuVramType": "string",
- "gpuVramChip": "string",
- "gpuBiosVer": "string",
- "gpuPwrMin": "string",
- "gpuPwrMax": "string",
- "gpuPwrLimit": "string",
- "gpuPwrCur": "string",
- "gpuVddGfx": "string",
- "gpuManufacturer": "string",
- "gpuMvdd": "string",
- "gpuMvddci": "string",
- "hashrate": "string",
- "hashrate2": "string",
- "gpuHash": "string",
- "gpuHash2": "string"
}
]
}
Delete Rig by ID
id required | integer Example: 1 Rig ID |
curl --location --request DELETE 'https://api.simplemining.net/rigs/1' \ --header 'X-AUTH-TOKEN: apiKey'
{- "title": "An error occurred",
- "detail": "Invalid credentials."
}
Get Rig Console by ID
id required | integer Example: 1 Rig ID |
type | string Enum: "debug" "dmesg" Console Type |
curl --location --request GET 'https://api.simplemining.net/rigs/1/console' \ --header 'X-AUTH-TOKEN: apiKey'
{- "console": "string"
}
Change Group Config in Rigs by Rig IDs
Content-Type required | string Example: 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: |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigGroupId": 7,
- "execute": "reload"
}
{ }
Change Group OC in Rigs by Rig IDs
Content-Type required | string Example: 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: |
execute | string Provide execute command: |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 7,
- "action": "link",
- "execute": "reload"
}
{ }
Execute Reboot on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
]
}
{ }
Execute Reload on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
]
}
{ }
Execute Pause on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
]
}
{ }
Execute Resume on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
]
}
{ }
Execute Find Rig on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
]
}
{ }
Execute Find GPU on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
], - "gpuId": 0
}
{ }
Execute Shutdown on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
]
}
{ }
Execute Sleep on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
], - "minutes": 1,
- "hours": 1
}
{ }
Execute Clear Counter on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
]
}
{ }
Execute Delete on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: application/merge-patch+json |
rigIds | Array of arrays Provide Rig IDs to apply change on selected Rigs |
{- "rigIds": [
- 1,
- 2,
- 3
]
}
{ }
Execute Command on Rigs by Rig IDs, Group OC ID or Group Config ID
Content-Type required | string Example: 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 |
{- "rigIds": [
- 1,
- 2,
- 3
], - "rigOcId": 1,
- "rigGroupId": 1,
- "rigGroupIds": [
- 1,
- 2,
- 3
], - "commandId": 7,
- "commandOptions": "string"
}
{ }
Get available Group Configs
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 |
curl --location --request GET 'https://api.simplemining.net/rig-groups/user-list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 7,
- "name": "0-AMD-TRM",
- "description": "string",
- "minerOptions": "string",
- "isDefault": true,
- "isRootMiner": true,
- "minerProgram": [
- {
- "name": "string",
- "createdAt": "2022-01-13T21:25:45+01:00"
}
], - "rigsTotalCount": 40,
- "rigsOnlineCount": 3,
- "createdAt": "2022-01-13T21:25:45+01:00"
}
]
Get available Group OCs
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: |
search | string Filter by name, description |
curl --location --request GET 'https://api.simplemining.net/rig-ocs/user-list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 7,
- "name": "0-AMD-TRM",
- "description": "string",
- "osSeries": "string",
- "ocCore": "string",
- "ocMemory": "string",
- "ocPowerLimit": "string",
- "ocVddc": "string",
- "ocMode": true,
- "ocTempTarget": "string",
- "ocFanSpeedMin": "string",
- "ocMvdd": "string",
- "ocMvddci": "string",
- "isDefault": true,
- "isOcAdvToolsOn": true,
- "isOcDelayed": true,
- "rigsTotalCount": 40,
- "rigsOnlineCount": 3,
- "createdAt": "2022-01-13T21:25:45+01:00"
}
]
curl --location --request GET 'https://api.simplemining.net/rig-commands' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 7,
- "cmd": "cmdBash",
- "name": "Bash",
- "description": "string",
- "isCustom": true,
- "isPublic": true
}
]
Get deposit address by currency code
currency required | string Enum: "BTC" "ETH" "ETC" "ZEC" "LTC" Example: currency=ETH Currency code |
curl --location --request GET 'https://api.simplemining.net/deposits/address?currency=eth' \ --header 'X-AUTH-TOKEN: apiKey'
{- "currency": "ETH",
- "currencyStatus": "online",
- "address": "0x734272hdhduahdufu38748er7wDC"
}
Get deposit summary including balance, service days remaining, etc
curl --location --request GET 'https://api.simplemining.net/deposits/summary' \ --header 'X-AUTH-TOKEN: apiKey'
{- "balanceUsd": "20.002",
- "daysRemaining": 10,
- "isAccountBlocked": false,
- "rates": {
- "BTC": "36458.91",
- "ZEC": "126.91",
- "ETH": "2747.66",
- "LTC": "97.43"
}, - "last24hRigsCount": 2,
- "discountLevel": 0,
- "discountLevelRate": 1,
- "currentPricePerRig": 2
}
Get deposit list with transaction ID, status, etc
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 |
curl --location --request GET 'https://api.simplemining.net/deposits/user-list' \ --header 'X-AUTH-TOKEN: apiKey'
[- {
- "id": 1,
- "txnId": "string",
- "currency": "LTC",
- "amount": "0.00062084",
- "amountUsd": "0.0503",
- "status": 100,
- "createdAt": "2022-01-13T21:25:45+01:00",
- "finishedAt": "2022-01-13T21:25:45+01:00"
}
]