Luxor Documentation Hub Logo
Mining Pool/API Documentation/V2/Reporting

Get summary

Returns a list of all summary associated to a Workspace.

GET
/v2/pool/summary/{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 Any properties in string,array<string>,array<string>
site_idAny properties in string,string
curl -X GET "https://app.luxor.tech/api/v2/pool/summary/BTC?subaccount_names=my_subaccount%2Canother_subaccount&site_id=b0a5fad8-0e09-4f10-ac20-ccd80fb2d138" \
  -H "authorization: <token>"

Default Response

{
  "currency_type": "BTC",
  "subaccounts": [
    {
      "id": 0,
      "name": "my_subaccount",
      "site_id": "b0a5fad8-0e09-4f10-ac20-ccd80fb2d138",
      "created_at": "2019-08-24T14:15:22Z",
      "url": "string"
    }
  ],
  "hashrate_5m": "1035827914295214",
  "hashrate_24h": "1035827914295214",
  "efficiency_5m": 0.9960606098175049,
  "uptime_24h": 0.9960606098175049,
  "active_miners": 124332,
  "revenue_24h": [
    {
      "currency_type": "BTC",
      "revenue_type": "MINING",
      "revenue": 0.00066154
    }
  ],
  "revenue_all_time": [
    {
      "currency_type": "BTC",
      "revenue_type": "MINING",
      "revenue": 0.00066154
    }
  ],
  "hashprice": [
    {
      "currency_type": "BTC",
      "value": 0.00059629
    }
  ],
  "balance": [
    {
      "currency_type": "BTC",
      "revenue": 0.00059629
    }
  ]
}

Previous

Get revenue

Next

Get uptime