# MultiPoolMiner API (version 0.98)

API data is available at http://localhost:[API port]/<resource> The default MPM API port is 3999. It can be changed with parameter '-APIPort nnnn' (see README)

## File and Scripts

Anything other than the resources listed below will be looked for in the web directory and sent if it exists.

Any .ps1 files in the web directory will be run and their output sent. They get passed a $Parameters object with keys and values from the URL string. Test it with this demo: /scripts/demo.ps1?message=Hello%20world! This feature can be used to gather data that the API doesn't expose directly.

## Resources

### Active Miners

/activeminers

Shows data about all miners that are enabled.

### Algorithms

/algorithms

Shows all algorithms that can be mined with at least one pool

### All Devices

/alldevices

Dump of the $AllDevices variable, used only for debugging. Shows information about all found mining devices, used only for debugging.

### All Miners

/allminers

Dump of the $AllMiners variable, used only for debugging. Shows information about all found miners, used only for debugging.

### All Pools

/allpools

Dump of the $AllPools variable

### All Rates

/rates

Shows the exchange rates of all currencies

### APIVersion

/apiversion

Returns the version number of MultiPoolMiner API.

### Best Miners

/bestminers

Returns bestminers information.

### Best Miners Comparison

/bestminers_comparison

Returns bestminers_comparison information.

### Best Miners Combos

/bestminers_combos

Returns bestminers_combos information.

### Best Miners Combos Comparison

/bestminers_combos_comparison

Returns bestminers_combos_comparison information.

### Best Miners Combos

/bestminers_combo

Returns bestminers_combo information.

### Best Miners Combo Comparison

/bestminers_combo_comparison

Returns bestminers_combo_comparison information.

### Balances Jobs

/balances_jobs

Returns pool balances jobs information.

### BTC rate of first currency

/btcratefirstcurrency

Returns the BTC exchange rate for the first configured currency.

### Current Earning

/currentearning

Shows the cumulated earnings of all miners

### Current Profit

/currentprofit

Shows the cumulated profit (earning - power cost) of all miners

### Config

/config

Shows the full configuration for the running script, after all variable substitution and pool entries are added

### Debug

/debug

Shows all data added to the $API hashtable, used only for debugging.

### Devices

/devices

Dump of the $Devices variable, used only for debugging. Shows information about all active mining devices, used only for debugging.

### All Rates

/exchangerates

Shows the exchange rates for the configured currencies

### Failed Miners

/failedminers

Shows data about all miners that are failed.

### Filtered Miners

/filteredminers

Shows data about all miners that are filtered out.

### Intervals

/intervals

Collection of intervals (StartStart & StartEnd)

### Miners

/miners

Dump of the $Miners variable

### MiningCosts

/miningcosts

Current mining cost in Currency[0]

### MiningEarning

/miningearning

Current mining earning (MiningEarning - MiningCosts) in Currency[0]

### MiningProfit

/miningprofit

Current mining profit in Currency[0]

### Miners needing Benchmark

/minersneedingbenchmark

Shows data about all miners that need benchmarking.

### NewPools

/newpools

Dump of the $NewPools variable

### NewPools_Jobs

/newpools_jobs

Returns pool NewPools jobs information.

### Pool Balances

/balances

Shows the balances at the pools

### Pools

/pools

Dump of the $Pools variable

### Running Miners

/runningminers

Shows data about the miners that are currently running.

### Stats

/stats

Dump of the $Stats variable, used only for debugging. Stats data is used for internal MPM calculations.

### Stop

/stop

Tells the script to stop running.

### Unprofitable Algorithms

/unprofitablealgorithms

Returns the list of unprofitable algorithms.

### Version

/version

Returns the version number of MultiPoolMiner.

### WatchdogTimers

/watchdogtimers

Dump of the $WatchdogTimers variable, used only for debugging. WatchdogTimers data is used for internal MPM calculations.

MultiPoolMiner.io