Get workers

Returns a summary of all workers associated with one or more 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

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

statusstring

The status of the worker to filter by.

Value in: "ACTIVE" | "INACTIVE"

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/workers/BTC?page_number=1&page_size=10&status=ACTIVE&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"
    }
  ],
  "total_inactive": 10,
  "total_active": 10,
  "workers": [
    {
      "id": "string",
      "currency_type": "BTC",
      "subaccount_name": "subaccount_1",
      "name": "worker-1",
      "firmware": "1.0.0",
      "hashrate": 0.00066154,
      "efficiency": 0.9960606098175049,
      "stale_shares": 0.00066154,
      "rejected_shares": 0.00066154,
      "last_share_time": "2025-01-01T00:00:00Z",
      "status": "ACTIVE"
    }
  ],
  "pagination": {
    "page_number": 0,
    "page_size": 0,
    "item_count": 0,
    "previous_page_url": "string",
    "next_page_url": "string"
  }
}

Get workers

Authorization

Path Parameters

Query Parameters

Response

TypeScript