BZMINER

BZMiner provides a convenient API interface for remote management of the miner. With the API, you can monitor mining status, retrieve device statistics, manage the miner, and fine-tune mining processes.

Enabling and Configuring the API

To activate and configure the API in BZMiner, follow these simple steps:

• Enabling the API
  By default, the API is enabled, but for precise configuration, you need to add a command when starting the miner.
  Example command to enable the API:

bzminer --http_enabled 1

• Enabling the API
  By default, the API is enabled, but for precise configuration, you need to add a command when starting the miner.
  Example command to enable the API:

bzminer --http_address 0.0.0.0 --http_port 4014

1. --http_address: Sets the IP address on which the API will listen. By default, 0.0.0.0 is used, which means access from any IP.
2. --http_port: Sets the port for the API. By default, this is 4014, but you can change it to any available port.

• Setting a Password for API Access
  To limit access to the API and protect the miner from unauthorized access, you can set a password.
  Example command to set a password:

bzminer --http_password YOUR_PASSWORD

Replace YOUR_PASSWORD with your desired password. Without setting a password, the API will be disabled.

• Viewing the API through a browser
  After activating the API, you can open a browser and enter the IP address and port to access miner information. For example, if you configured the API on port 4014, you need to enter the following in the address bar:

http://localhost:4014

• API Data Refresh Rate
  By default, the API data is refreshed every 15 seconds, but you can change this interval using the following command:

bzminer --update_frequency_ms 10000

Here, 10000 is the time in milliseconds (10 seconds). You can adjust the interval as desired.

Main Commands for API Configuration

• --http_enabled: Enables or disables the API (0 — disabled, 1 — enabled).
• --http_address: Sets the IP address for API access (e.g., 0.0.0.0).
• --http_port: Sets the port for API access (e.g., 4014).
• --http_password: Sets the password for API access.
• --update_frequency_ms: Sets the API data refresh interval (in milliseconds).

Example command to start the miner with API:

bzminer -a kawpow -w YOUR_WALLET -p stratum+tcp://rvn.2miners.com:6060 --http_enabled 1 --http_address 0.0.0.0 --http_port 4014 --http_password YOUR_PASSWORD

Now you can remotely monitor and control your miner through the API using a simple browser interface or third-party monitoring applications.