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

Get active workers

Returns a list of all active workers associated to a Workspace.

GET
/v2/pool/active-workers/{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" | "LTC" | "DOGE"

Query Parameters

subaccount_namesAny properties in Any properties in string,array<string>,array<string>
site_idAny properties in string,string
start_dateRequiredstring
Format: "date"
end_dateRequiredstring
Format: "date"
tick_sizeRequiredstring

The tick size defines granularity for active workers; only 5m, 1h, and 1d are supported. 5m returns up to last complete week, 1h up to last complete month, and 1d supports the entire history.

Value in: "5m" | "1h" | "1d"
page_numberinteger
Default: 1Minimum: 1
page_sizeinteger
Default: 10Minimum: 1
curl -X GET "https://app.luxor.tech/api/v2/pool/active-workers/BTC?subaccount_names=my_subaccount%2Canother_subaccount&site_id=b0a5fad8-0e09-4f10-ac20-ccd80fb2d138&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",
  "start_date": "2025-01-01",
  "end_date": "2025-01-31",
  "tick_size": "1d",
  "subaccounts": [
    {
      "id": 0,
      "name": "my_subaccount",
      "site_id": "b0a5fad8-0e09-4f10-ac20-ccd80fb2d138",
      "created_at": "2019-08-24T14:15:22Z",
      "url": "string"
    }
  ],
  "active_workers": [
    {
      "date_time": "2019-08-24T14:15:22Z",
      "active_workers": 10
    }
  ],
  "pagination": {
    "page_number": 1,
    "page_size": 1,
    "item_count": 0,
    "previous_page_url": null,
    "next_page_url": null
  }
}

Previous

Put permissions

Next

Get developer fee