API Docs
Available Commands

All commands

This is the full list of available commands on the LUXminer API:

CommandNotes
addgroupAdd a new group with a given name and quota.
addpool *Add a new pool to the first group.
ascShows the details of a single ASIC board.
asccountNumber of ASIC boards.
atmDisplay ATM configuration.
atmset **Change ATM configuration.
checkCheck if a command exists and if it is available.
coinAlways zeros; exists only for compatibility.
configList temperature configuration.
curtail **Execute the curtailment action.
devdetails ***Shows hardware information about the connected devices.
devsDetailed report of the ASIC boards.
disablepool *Disable a pool.
edevsSame as devs.
enablepool *Enable a pool.
estatsShowsavariety of miner stats.
fansDisplay fan statistics.
fanset * **Set the speed of the fans.
frequencygetReturns the frequency of one or all chips of a given board.
frequencyset ** ****Set a target frequency for one or more chips of a given board.
frequencystop **Stops the frequency change of a frequencyset command.
groupquota *Set the quota of a group to the specified value.
healthchipgetReturns the health information of the entire board, or only a specific chip.
healthchipset **Sets a chip as the next healthcheck target.
healthctrlReturns the current health check configuration.
healthctrlset * **Change the healthcheck configuration.
killKill the current active session and record this occurence in the log file.
lcdAlways zeros; exists only for compatibility.
limitsReturns miner parameter limits.
logoff **If the session is active, drop it.
logonCreates a new session and return its ID.
netset **Update network configuration.
pools ***List all the pools, in order, and their statistics.
powerReturns the estimated power usage, in watts.
profilenew **Create a new profile.
profilerem **Remove an existing profile.
profilesList the available profiles.
profileset * **Assigns a profile to a given board.
reboot **Schedules a reboot for a given board.
rebootdevice **Reboot the mining rig.
removegroupRemove a group, and all of it's pools.
resetminer **Reset the miner application.
removepool * ***Remove a pool from the first group.
sessionReturns the ID of the the active session.
tempctrlset *Set the temperature control values.
statsShows a variety of miner stats.
summaryThe summary of all miner stats.
switchpool * ***Switches a given pool to the top priority.
tempctrlDisplay temperature control.
tempsShows temperature data.
updaterun **Manually run the autoupdate.
updateset **Change autoupdate configuration.
versionPrint the API and application version.
voltagegetReturns the current voltage of a given board.
CategoryDescription
*autosavehis command triggers the autosave of the config file.
**sessionThis command requires a valid session.
***quirkcsThis command has extra fields or optional parameters on luxminer. See the command page for details.
****profileThis command triggers a profile change.