Simplemining.net API (latest )
Download OpenAPI specification :Download
The API is based on REST principles. It supports GET, POST, PUT, PATCH and DELETE requests.
All URLs referenced in the documentation have the following base: https://api.simplemining.net
Get Rig List
Get Rig List for User
Authorizations:
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: |
| 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 |
Responses
Request samples
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/rigs/user-list' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
[
-
{
-
"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
}
]Request samples
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/rigs/filter-list' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
[
-
{
-
"osSeries":
[
-
{
-
"osSeries": "NV"
}
],
-
"rigOc":
[
-
{
-
"id": 1,
-
"name": "string"
}
],
-
"rigGroup":
[
-
{
-
"id": 1,
-
"name": "string"
}
],
-
"userTags":
[
-
{
-
"id": 1,
-
"name": "string",
-
"color": "string"
}
]
}
]Get Rigs Summary
Get Rigs summary details
Authorizations:
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: |
| 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 |
Responses
Request samples
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/rigs/summary' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
{
-
"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
Get Rig Details by ID
Authorizations:
path Parameters
| id
required
|
integer
Example: 1
Rig ID |
Responses
Request samples
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/rigs/1' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
- 404
{
-
"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
Delete Rig by ID
Authorizations:
path Parameters
| id
required
|
integer
Example: 1
Rig ID |
Responses
Request samples
- CLI
- PHP
curl --location --request DELETE 'https://api.simplemining.net/rigs/1' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 401
- 403
- 404
{
-
-
"title": "An error occurred",
-
"detail": "Invalid credentials."
}Get Rig Console
Get Rig Console by ID
Authorizations:
path Parameters
| id
required
|
integer
Example: 1
Rig ID |
query Parameters
| type |
string
Enum: "debug" "dmesg"
Console Type |
Responses
Request samples
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/rigs/1/console' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
- 404
{
-
"console": "string"
}Change Group Config
Change Group Config in Rigs by Rig IDs
Authorizations:
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: |
Responses
Request samples
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigGroupId": 7,
-
"execute": "reload"
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Change Group OC
Change Group OC in Rigs by Rig IDs
Authorizations:
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: |
| execute |
string
Provide execute command: |
Responses
Request samples
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 7,
-
"action": "link",
-
"execute": "reload"
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Reboot
Execute Reboot on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
]
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Reload
Execute Reload on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
]
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Pause
Execute Pause on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
]
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Resume
Execute Resume on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
]
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Find Rig
Execute Find Rig on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
]
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Find GPU
Execute Find GPU on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
],
-
"gpuId": 0
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Shutdown
Execute Shutdown on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
]
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Sleep
Execute Sleep on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
],
-
"minutes": 1,
-
"hours": 1
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Clear Counter
Execute Clear Counter on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
]
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Delete
Execute Delete on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
]
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Execute Command
Execute Command on Rigs by Rig IDs, Group OC ID or Group Config ID
Authorizations:
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
- Payload
- CLI
- PHP
{
-
"rigIds":
[
-
1,
-
2,
-
3
],
-
"rigOcId": 1,
-
"rigGroupId": 1,
-
"rigGroupIds":
[
-
1,
-
2,
-
3
],
-
"commandId": 7,
-
"commandOptions": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
{ }Get available Group Configs
Get available Group Configs
Authorizations:
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
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/rig-groups/user-list' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
[
-
{
-
"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
Get available Group OCs
Authorizations:
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: |
| search |
string
Filter by name, description |
Responses
Request samples
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/rig-ocs/user-list' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
[
-
{
-
"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"
}
]Request samples
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/rig-commands' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
[
-
{
-
"id": 7,
-
"cmd": "cmdBash",
-
"name": "Bash",
-
"description": "string",
-
"isCustom": true,
-
"isPublic": true
}
]Get deposit address
Get deposit address by currency code
Authorizations:
query Parameters
| currency
required
|
string
Enum: "BTC" "ETH" "ETC" "ZEC" "LTC"
Example: currency=ETH
Currency code |
Responses
Request samples
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/deposits/address?currency=eth' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 400
- 401
- 403
{
-
"currency": "ETH",
-
"currencyStatus": "online",
-
"address": "0x734272hdhduahdufu38748er7wDC"
}Get deposit summary
Get deposit summary including balance, service days remaining, etc
Authorizations:
Responses
Request samples
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/deposits/summary' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
{
-
"balanceMining": "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
Get deposit list with transaction ID, status, etc
Authorizations:
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
- CLI
- PHP
curl --location --request GET 'https://api.simplemining.net/deposits/user-list' \ --header 'X-AUTH-TOKEN: apiKey'
Response samples
- 200
- 401
- 403
[
-
{
-
"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"
}
]