Get active workers

Returns Active Workers for one or more subaccounts. Accepts either a list of subaccounts or an entire subaccount group. Can only be computed for tick sizes 5m, 1h and 1d.

Authorization

authorization<token>

Use your API key here.

In: header

Path Parameters

currency_typeRequiredstring

Which currency to query, e.g. BTC or DOGE.

Value in: "BTC" | "LTC_DOGE" | "SC" | "ZEC" | "ZEN" | "LTC" | "DOGE"

Query Parameters

start_dateRequiredstring

The start date to use for the returned data.

Format: "date"

end_dateRequiredstring

The end date to use for the returned data. Will be transformed to include the last second of the day (23:59:59.999) or current time if in the future.

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_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

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/active-workers/BTC?start_date=2025-01-01&end_date=2025-01-31&tick_size=1d&page_number=1&page_size=10&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"
    }
  ],
  "start_date": "2025-01-01",
  "end_date": "2025-01-31",
  "tick_size": "1d",
  "active_workers": [
    {
      "date_time": "2025-01-01T00:00:00Z",
      "active_workers": 10
    }
  ],
  "pagination": {
    "page_number": 0,
    "page_size": 0,
    "item_count": 0,
    "previous_page_url": "string",
    "next_page_url": "string"
  }
}

Get active workers

Authorization

Path Parameters

Query Parameters

Response

TypeScript