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

Get workers hashrate history

Returns hashrate, efficiency and estimated revenue time series data for a set of workers and a currency type, given a specified time period. Revenue is provided only for BTC currency, it is an estimate and should not be considered a source of truth for financial settlement.

GET
/v2/pool/workers-hashrate-efficiency/{currency_type}/{subaccount_name}

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"
subaccount_nameRequiredstring

A subaccount name for which to retrieve summary information.

Minimum length: 1

Query Parameters

worker_namesAny properties in string,array<string>

The names of the workers to filter by.

tick_sizeRequiredstring

The tick size defines granularity; only 1d and 1h are supported for workers hashrate efficiency.

Value in: "1d" | "1h"
start_dateRequiredstring
Format: "date"
end_dateRequiredstring
Format: "date"
page_numberinteger
Default: 1Minimum: 1
page_sizeinteger
Default: 10Minimum: 1
curl -X GET "https://app.luxor.tech/api/v2/pool/workers-hashrate-efficiency/BTC/my_subaccount?worker_names=worker_1%2Cworker_2&tick_size=1d&start_date=2025-01-01&end_date=2025-01-31&page_number=1&page_size=10" \
  -H "authorization: <token>"

Default Response

{
  "currency_type": "BTC",
  "start_date": "2025-01-01",
  "end_date": "2025-01-31",
  "tick_size": "1d",
  "hashrate_efficiency_revenue": {
    "property1": [
      {
        "date_time": "2019-08-24T14:15:22Z",
        "hashrate": "1035827914295214",
        "efficiency": 0.9960606098175049,
        "est_revenue": 0.00066154
      }
    ],
    "property2": [
      {
        "date_time": "2019-08-24T14:15:22Z",
        "hashrate": "1035827914295214",
        "efficiency": 0.9960606098175049,
        "est_revenue": 0.00066154
      }
    ]
  },
  "pagination": {
    "page_number": 1,
    "page_size": 1,
    "item_count": 0,
    "previous_page_url": null,
    "next_page_url": null
  }
}

Previous

Get workers

Next

Create site