API Reference

One-time setup. Store the returned apiKey — it will not be shown again.

curl -s -X POST https://awfulwafflemining.com/api/v1/agents/register \
  -H "Content-Type: application/json" \
  -d '{"name":"MyTradingAgent","contactEmail":"[email protected]"}'

{
  "agentId": "abc123...",
  "apiKey":  "awm_abc123def456...",
  "message": "Store this API key — it won't be shown again.",
  "usage":   "Authorization: Bearer awm_abc123def456..."
}

See which chains are live and how much hashrate is available. No API key needed.

curl -s https://awfulwafflemining.com/api/v1/hashrate/available

{
  "available": true,
  "totalThs": 18.4,
  "minerCount": 3,
  "pricing": {
    "rateUsdPerThsPerHour": 0.10,
    "bchPriceUsd": 312.50
  },
  "chains": {
    "BCH": { "totalThs": 18.4, "port": 4444, "available": true, "rateUsdPerThsPerHour": 0.10 },
    "DGB": { "totalThs": 18.4, "port": 3402, "available": false, "note": "DGB node syncing — check back soon" }
  },
  "stratumEndpoint": "stratum.awfulwafflemining.com"
}

Price out your rental before placing the order. Quotes are valid for 5 minutes. No API key needed.

curl -s -X POST https://awfulwafflemining.com/api/v1/hashrate/quote \
  -H "Content-Type: application/json" \
  -d '{"chain":"BCH","ths":5,"durationMinutes":60,"payoutAddress":"bitcoincash:qYOURADDRESS"}'

{
  "chain": "BCH",
  "ths": 5,
  "durationMinutes": 60,
  "price": {
    "usd": 0.5000,
    "bch": 0.00160000,
    "sats": 160000,
    "bchPrice": 312.50
  },
  "available": true,
  "availableThs": 18.4,
  "stratumPort": 4444,
  "quoteExpiresAt": 1716000300000
}

For DGB, the response includes additional dgbPrice and a note that payment is still in BCH.

Creates the order and returns payment instructions. Send the exact BCH amount to the returned payment.address. AUTH REQUIRED

curl -s -X POST https://awfulwafflemining.com/api/v1/hashrate/order \
  -H "Authorization: Bearer awm_YOURAPIKEY" \
  -H "Content-Type: application/json" \
  -d '{
    "chain": "BCH",
    "ths": 5,
    "durationMinutes": 60,
    "payoutAddress": "bitcoincash:qYOURADDRESS",
    "webhookUrl": "https://myagent.example.com/webhooks/awm",
    "webhookSecret": "my-hmac-secret"
  }'

{
  "orderId": "550e8400-e29b-41d4-a716-446655440000",
  "token":   "a1b2c3d4e5f6...",
  "status":  "awaiting_payment",
  "payment": {
    "method":     "onchain_bch",
    "address":    "bitcoincash:qq3aja2cmxyazrc94wkxl3cc...",
    "amountBch":  0.00160000,
    "amountSats": 160000,
    "amountUsd":  0.5000,
    "memo":       "AWM-550e8400",
    "expiresAt":  1716003900000
  },
  "statusUrl":  "/api/v1/hashrate/order/550e8400-...",
  "confirmUrl": "/api/v1/hashrate/order/550e8400-.../confirm"
}

After sending BCH, call confirm with the transaction ID. The API verifies on-chain (via Blockchair) and triggers miner reconfiguration. AUTH REQUIRED

curl -s -X POST https://awfulwafflemining.com/api/v1/hashrate/order/ORDER_ID/confirm \
  -H "Authorization: Bearer awm_YOURAPIKEY" \
  -H "Content-Type: application/json" \
  -d '{"txid":"YOUR_BCH_TXID"}'

{
  "orderId": "550e8400-...",
  "status":  "active",
  "stratum": {
    "url":      "stratum.awfulwafflemining.com",
    "port":     4444,
    "user":     "bitcoincash:qYOURADDRESS.a1b2c3d4",
    "password": "x",
    "endpoint": "stratum+tcp://stratum.awfulwafflemining.com:4444"
  },
  "minersAssigned":  3,
  "assignedThs":    18.4,
  "durationMinutes": 60,
  "expiresAt":      1716003900000,
  "message": "Miners reconfigured. Point your worker at the stratum endpoint."
}

Use the stratum credentials from the confirm response to configure your pool software (ckpool, cpuminer, etc.):

Example for cgminer / BFGminer:

--url  stratum+tcp://stratum.awfulwafflemining.com:4444
--user bitcoincash:qYOURADDRESS.a1b2c3d4
--pass x

Poll order status to see live hashrate, shares accepted, and time remaining. AUTH REQUIRED

# Single order
curl -s https://awfulwafflemining.com/api/v1/hashrate/order/ORDER_ID \
  -H "Authorization: Bearer awm_YOURAPIKEY"

# All orders for your account
curl -s https://awfulwafflemining.com/api/v1/hashrate/orders \
  -H "Authorization: Bearer awm_YOURAPIKEY"

{
  "orderId": "550e8400-...",
  "status":  "active",
  "chain":   "BCH",
  "ths":     5,
  "stratum": { /* full credentials */ },
  "clockStartedAt":  1716000000000,
  "expiresAt":       1716003600000,
  "timeRemainingMs": 3421000,
  "live": {
    "hashrateGhs":    4980.50,
    "hashrateThs":    4.9805,
    "sharesAccepted": 142,
    "blockFound":     false
  }
}

When expiresAt is reached, the platform automatically restores all miners to their default pool configuration. Your stratum credentials stop receiving work. No action needed on your end — the order status transitions to expired and is visible in your order history.

Use webhooks (next section) to receive rental.expiring (5 min warning) and rental.expired events instead of polling.