Luxor Documentation Hub Logo
Mining Pool/API Documentation/Reporting

Get hashrate history

Returns hashrate and efficiency time series data for a set of subaccounts and a currency type, given a specified time period.

GET
/v1/pool/hashrate-efficiency/{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_namesarray<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"
start_dateRequiredstring

The start date to use for the returned data.

Format: "date"
end_dateRequiredstring

The end date to use for the returned data.

Format: "date"
tick_sizeRequiredstring

The tick size to use for the returned data.

Value in: "5m" | "1h" | "1d" | "1w" | "1M"
page_numbernumber

The page number to use for the returned data.

Minimum: 1
page_sizenumber

The page size to use for the returned data.

Minimum: 1
curl -X GET "https://beta.luxor.tech/api/v1/pool/hashrate-efficiency/BTC?subaccount_names=subaccount_1%2Csubaccount_2&group_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&start_date=2025-01-01&end_date=2025-01-31&tick_size=1d&page_number=1&page_size=10" \
  -H "authorization: <token>"

Default Response

{
  "currency_type": "BTC",
  "subaccounts": [
    {
      "id": 0,
      "name": "subaccount_1"
    }
  ],
  "start_date": "2025-01-01",
  "end_date": "2025-01-31",
  "tick_size": "1d",
  "hashrate_efficiency": [
    {
      "date_time": "2025-01-01T00:00:00Z",
      "hashrate": "1035827914295214",
      "efficiency": 0.9960606098175049
    }
  ],
  "pagination": {
    "page_number": 0,
    "page_size": 0,
    "item_count": 0,
    "previous_page_url": "string",
    "next_page_url": "string"
  }
}