🔌 REST API base URL: api.cudominer.com — authenticate with your API key from Settings → API Access.
HomeAdvancedAutomation & Plugins
Power User Guide

CudoMiner Automation & Plugins — REST API, OC Profiles & Integrations

How CudoMiner algorithm plugins work under the hood, how auto-overclocking profiles are selected per coin, and how to build custom dashboards and automation using the REST API.

Plugin Architecture

How CudoMiner Algorithm Plugins Work

CudoMiner is not a single miner binary — it is an orchestration layer that manages a collection of specialised algorithm plugins. Each plugin is an optimised miner for a specific proof-of-work algorithm, bundled and updated automatically by CudoMiner.

1

Profitability Engine Selects Best Coin

Every 5 minutes, CudoMiner queries live coin prices, network difficulty and pool data to calculate expected earnings for your specific GPU. If a better option exists, the switch begins.

2

Plugin is Loaded for the Target Algorithm

CudoMiner identifies which plugin handles the target algorithm (e.g. autolykos2 for Ergo), checks it is current, and starts the plugin process. If the plugin needs updating, it downloads silently in the background first.

3

OC Profile is Applied Automatically

Before the plugin starts mining, CudoMiner looks up the optimal overclocking profile for your exact GPU model on that algorithm and applies it via the GPU driver API. Memory clock, core clock and power limit are all set simultaneously.

4

Mining Begins — Earnings Route to Vault

The plugin connects to the optimal pool, begins submitting shares, and reports hashrate back to CudoMiner. All earnings accumulate in your Vault, regardless of which plugin is active.

Installed Plugins — What Each One Does

kawpow
KawPow algorithm
Ravencoin (RVN), Neoxa (NEOX)
🔷
autolykos2
Autolykos v2
Ergo (ERG)
🧠
randomx
RandomX (CPU)
Monero (XMR), Zephyr (ZEPH)
💎
etcminer
Ethash / Etchash
Ethereum Classic (ETC)
kheavyhash
kHeavyHash
Kaspa (KAS)
🌊
zelHash
ZelHash
Flux (FLUX)
🔵
blake3-aleph
Blake3 Alephium
Alephium (ALPH)
equihash
Equihash
Bitcoin Gold (BTG), ZEN
Auto-Overclocking

Automatic OC Profiles Per Algorithm — How It Works

Different mining algorithms stress GPU hardware in different ways. Memory-intensive algorithms (Ethash, Autolykos) benefit from high memory clocks. Compute-intensive algorithms (KawPow) benefit from high core clocks. CudoMiner applies the correct balance automatically for every GPU/algorithm combination.

GPUAlgorithmCore ClockMem ClockPowerEst. Hashrate Gain
RTX 4070 Autolykos2 (Ergo) +150 MHz +900 MHz 80% +18% vs default
RTX 4070 KawPow (RVN) +200 MHz +400 MHz 85% +14% vs default
RTX 3070 Autolykos2 (Ergo) +130 MHz +800 MHz 78% +20% vs default
RTX 3060 Ethash (ETC) +100 MHz +1100 MHz 70% +24% vs default
RX 6700 XT Autolykos2 (Ergo) −100 MHz +1100 MHz 75% +22% vs default
RX 6600 XT Ethash (ETC) −50 MHz +900 MHz 70% +19% vs default
ℹ️
All OC profiles are applied per GPU model per algorithm. When CudoMiner switches from Ergo to KawPow on an RTX 4070, it simultaneously changes the memory clock from +900 to +400 and the core clock from +150 to +200 — in a single atomic operation before the new plugin process starts.
REST API

CudoMiner REST API — Endpoints & Authentication

The CudoMiner REST API lets you pull live mining data into any tool — custom dashboards, Grafana, spreadsheets, Slack bots, alerting systems or home automation platforms. Get your API key from Settings → API Access in the web console.

HTTPAuthentication header
# All requests require API key in Authorization header
GET https://api.cudominer.com/v1/workers
Authorization: Bearer YOUR_API_KEY_HERE
Content-Type: application/json
EndpointMethodReturns
/v1/workersGETAll workers with status, hashrate, temperature, current algorithm
/v1/workers/{id}GETSingle worker detail with full hardware metrics
/v1/workers/{id}/startPOSTStart mining on a specific worker remotely
/v1/workers/{id}/stopPOSTStop mining on a specific worker remotely
/v1/vault/balanceGETCurrent Vault balance per coin
/v1/earningsGETEarnings history with optional date range filter
/v1/earnings/todayGETToday's total earnings across all workers
/v1/pluginsGETInstalled plugins with versions and algorithms

Example API Response — /v1/workers

JSONGET /v1/workers response
{
  "workers": [
    {
      "id": "wrk_a1b2c3",
      "name": "Office Desktop",
      "status": "mining",
      "gpu": "NVIDIA RTX 4070",
      "algorithm": "autolykos2",
      "coin": "ERG",
      "hashrate_mhs": 132.4,
      "temperature_c": 68,
      "power_watts": 145,
      "earnings_usd_today": 1.38,
      "plugin_version": "autolykos2-v3.2.1"
    }
  ],
  "total_workers": 3,
  "online_workers": 3
}
Integrations

CudoMiner Automation Integrations

📊 Grafana Dashboard

Poll /v1/workers every 60 seconds via a Prometheus exporter or InfluxDB writer. Create panels for hashrate, temperature, earnings and worker status. Set threshold alerts directly in Grafana for GPU temperature over 80°C or hashrate drops below baseline.

💬 Slack / Discord Alerts

Write a Python or Node.js script that polls /v1/workers and checks for offline status or hashrate anomalies. POST to a Slack or Discord webhook when an alert condition is met. Run via cron every 5 minutes for near-real-time alerting with zero additional infrastructure.

📊 Google Sheets Integration

Use Google Apps Script to call /v1/earnings daily at midnight and log earnings to a spreadsheet. Track per-worker profitability, calculate monthly totals and compare against electricity costs — all in a spreadsheet you already know how to use.

🏠 Home Automation

Integrate with Home Assistant or Node-RED via the REST API. Trigger mining to start or stop based on electricity tariff schedules, solar generation data, or peak demand events. Use /v1/workers/{id}/start and /stop endpoints for programmatic control.

Slack Alert Script — Python Example

PythonOffline worker alert via Slack webhook
# cudominer_alert.py — run via cron every 5 minutes
import requests

API_KEY     = "YOUR_CUDOMINER_API_KEY"
SLACK_HOOK  = "https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK"
API_BASE    = "https://api.cudominer.com/v1"

headers = {"Authorization": f"Bearer {API_KEY}"}
workers = requests.get(f"{API_BASE}/workers", headers=headers).json()

for w in workers["workers"]:
    if w["status"] != "mining":
        msg = f"🔴 CudoMiner: {w['name']} is OFFLINE"
        requests.post(SLACK_HOOK, json={"text": msg})

# Schedule: */5 * * * * python3 /path/to/cudominer_alert.py
FAQ

Automation & Plugins FAQ

How do CudoMiner algorithm plugins work?

CudoMiner algorithm plugins are separate optimised miner binaries for each supported proof-of-work algorithm — for example, a T-Rex binary for KawPow, a custom binary for Autolykos2, and XMRig for RandomX. CudoMiner manages these plugins automatically: it downloads, updates and invokes the correct binary when switching to that algorithm. Each plugin includes GPU-specific overclocking profiles that CudoMiner applies automatically.

Does CudoMiner have a REST API?

Yes. CudoMiner provides a REST API accessible via your web console account. The API exposes endpoints for worker status, real-time hashrate, earnings per worker, Vault balance, algorithm currently mining, and device health metrics. Authenticate with your account API key from Settings → API Access. The base URL is api.cudominer.com.

Can I integrate CudoMiner with Grafana?

Yes. Using the CudoMiner REST API, you can build a Grafana dashboard by configuring a JSON datasource plugin pointing to the API endpoints. Poll worker hashrate, earnings and temperature data into InfluxDB or Prometheus, then visualise in Grafana panels. Many farm operators use this setup for real-time mining operations monitoring on a dedicated display.

Can CudoMiner send Slack or Discord alerts when a worker goes offline?

Yes. CudoMiner has built-in alert configuration in the web console under Settings → Alerts. You can configure email alerts natively. For Slack or Discord, use the REST API with a simple webhook script: poll the /workers endpoint every minute, check for offline status, and POST to your Slack or Discord webhook URL if any worker is down. A sample Python script for this integration is available in the CudoMiner community documentation.

How does CudoMiner automatically apply overclocking when switching algorithms?

CudoMiner stores a library of overclocking profiles indexed by GPU model and algorithm. When the auto-switcher selects a new coin, it simultaneously looks up the optimal memory clock, core clock and power limit for your specific GPU on that algorithm, and applies those settings via the GPU driver API before starting the new miner process. This means your GPU is always at peak efficiency for whatever it is mining — without any manual tuning.

🌐 🌐 EN 🇨🇦 CA 🇺🇸 US 🇫🇷 FR 🇩🇪 DE 🇪🇸 ES 🇨🇳 CN 🇯🇵 JP