Get revenue history

Allows querying revenue for subaccounts. Returns daily results (fixed tick size at 1_DAY).

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

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"

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/revenue/BTC?start_date=2025-01-01&end_date=2025-01-31&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",
  "revenue": [
    {
      "date_time": "2025-01-01T00:00:00Z",
      "revenue": {
        "currency_type": "BTC",
        "revenue_type": "MINING",
        "revenue": 0.00066154
      }
    }
  ]
}

Get revenue history

Authorization

Path Parameters

Query Parameters

Response

TypeScript