Get mining summary

Returns a summary of short-term operational and business KPIs given a set of subaccounts and a currency type.

Authorization

authorization<token>

Use your API key here.

In: header

Path Parameters

currency_typeRequiredstring

Which currency to query, e.g. BTC or ZEN.

Value in: "BTC" | "LTC_DOGE" | "SC" | "ZEC" | "ZEN"

Query Parameters

subaccount_namesAny properties in string,array<string>

An array of subaccount names for which to retrieve summary information.

group_idstring

An alternate shortcut for specifying subaccounts. Can be used in place of subaccount_names

Format: "uuid"

curl -X GET "https://app.luxor.tech/api/v1/pool/summary/BTC?subaccount_names=subaccount_1%2Csubaccount_2&group_id=497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "authorization: <token>"

Default Response

{
  "currency_type": "BTC",
  "subaccounts": [
    {
      "id": 0,
      "name": "subaccount_1"
    }
  ],
  "hashrate_5m": "1035827914295214",
  "hashrate_24h": "1035827914295214",
  "efficiency_5m": 0.9960606098175049,
  "uptime_24h": 0.9960606098175049,
  "revenue_24h": [
    {
      "currency_type": "BTC",
      "revenue_type": "MINING",
      "revenue": 0.00066154
    }
  ],
  "revenue_all_time": [
    {
      "currency_type": "BTC",
      "revenue_type": "MINING",
      "revenue": 0.00066154
    }
  ],
  "active_miners": 10,
  "hashprice": [
    {
      "currency_type": "BTC",
      "value": 0.00059629
    }
  ],
  "balance": [
    {
      "currency_type": "BTC",
      "revenue": 0.26944885
    }
  ]
}

Get mining summary

Authorization

Path Parameters

Query Parameters

Response

TypeScript