Complete rebranding of all components: - Core miner: xmrig -> miner (binary, version.h, CMakeLists.txt) - Proxy: xmrig-proxy -> miner-proxy - CUDA plugin: xmrig-cuda -> miner-cuda - Heatmap: xmrig-nonces-heatmap -> miner-nonces-heatmap - Go CLI wrapper: miner-cli -> miner-ctrl Vendored XMRig ecosystem into miner/ directory: - miner/core - XMRig CPU/GPU miner - miner/proxy - Stratum proxy - miner/cuda - NVIDIA CUDA plugin - miner/heatmap - Nonce visualization tool - miner/config - Configuration UI - miner/deps - Pre-built dependencies Updated dev fee to use project wallet with opt-out (kMinimumDonateLevel=0) Updated branding to Lethean (domain, copyright, version 0.1.0) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2.3 KiB
HTTP API
If you want use HTTP API you need enable it ("enabled": true,) then choice port and optionaly host. API not available if miner built without HTTP support (-DWITH_HTTP=OFF).
Offical HTTP client for API: http://workers.xmrig.info/
Example configuration:
"api": {
"id": null,
"worker-id": null,
},
"http": {
"enabled": false,
"host": "127.0.0.1",
"port": 0,
"access-token": null,
"restricted": true
}
Global API options
- id Miner ID, if not set created automatically.
- worker-id Optional worker name, if not set will be detected automatically.
HTTP API options,
- enabled Enable (
true) or disable (false) HTTP API. - host Host for incoming connections
http://<host>:<port>, to allow connections from all interfaces use0.0.0.0(IPv4) or::(IPv4+IPv6). - port Port for incoming connections
http://<host>:<port>, zero port is valid option and means random port. - access-token Bearer access token to secure access to API. Miner support this token only via
Authorizationheader. - restricted Use
falseto allow remote configuration.
If you prefer use command line options instead of config file, you can use options: --api-id, --api-worker-id, --http-enabled, --http-host, --http-access-token, --http-port, --http-no-restricted.
Versions before 2.15 was use another options for API https://github.com/xmrig/xmrig/issues/1007
Endpoints
GET /1/summary
Get miner summary information. Example.
GET /1/threads
Get detailed information about miner threads. Example.
Restricted endpoints
All API endpoints below allow access to sensitive information and remote configure miner. You should set access-token and allow unrestricted access ("restricted": false).
GET /1/config
Get current miner configuration. Example.
PUT /1/config
Update current miner configuration. Common use case, get current configuration, make changes, and upload it to miner.
Curl example:
curl -v --data-binary @config.json -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer SECRET" http://127.0.0.1:44444/1/config