statistics_client

This client enables to obtain statistical information from the subgraph.

Code Example

from human_protocol_sdk.constants import ChainId
from human_protocol_sdk.statistics import StatisticsClient

statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)

Module

class human_protocol_sdk.statistics.statistics_client.DailyEscrowData(timestamp, escrows_total, escrows_pending, escrows_solved, escrows_paid, escrows_cancelled)

Bases: object

A class used to specify daily escrow data.

__init__(timestamp, escrows_total, escrows_pending, escrows_solved, escrows_paid, escrows_cancelled)

Initializes a DailyEscrowData instance.

• Parameters:

  • timestamp (datetime) – Timestamp

  • escrows_total (int) – Total escrows

  • escrows_pending (int) – Pending escrows

  • escrows_solved (int) – Solved escrows

  • escrows_paid (int) – Paid escrows

  • escrows_cancelled (int) – Cancelled escrows

class human_protocol_sdk.statistics.statistics_client.DailyHMTData(timestamp, total_transaction_amount, total_transaction_count, daily_unique_senders, daily_unique_receivers)

Bases: object

A class used to specify daily HMT data.

__init__(timestamp, total_transaction_amount, total_transaction_count, daily_unique_senders, daily_unique_receivers)

Initializes a DailyHMTData instance.

• Parameters:

  • timestamp (datetime) – Timestamp

  • total_transaction_amount (int) – Total transaction amount

  • total_transaction_count (int) – Total transaction count

  • daily_unique_senders (int) – Total unique senders

  • daily_unique_receivers (int) – Total unique receivers

class human_protocol_sdk.statistics.statistics_client.DailyPaymentData(timestamp, total_amount_paid, total_count, average_amount_per_worker)

Bases: object

A class used to specify daily payment data.

__init__(timestamp, total_amount_paid, total_count, average_amount_per_worker)

Initializes a DailyPaymentData instance.

• Parameters:

  • timestamp (datetime) – Timestamp

  • total_amount_paid (int) – Total amount paid

  • total_count (int) – Total count

  • average_amount_per_worker (int) – Average amount per worker

class human_protocol_sdk.statistics.statistics_client.DailyWorkerData(timestamp, active_workers)

Bases: object

A class used to specify daily worker data.

__init__(timestamp, active_workers)

Initializes a DailyWorkerData instance.

• Parameters:

  • timestamp (datetime) – Timestamp

  • active_workers (int) – Active workers

class human_protocol_sdk.statistics.statistics_client.EscrowStatistics(total_escrows, daily_escrows_data)

Bases: object

A class used to specify escrow statistics.

__init__(total_escrows, daily_escrows_data)

Initializes a EscrowStatistics instance.

• Parameters:

  • total_escrows (int) – Total escrows

  • daily_escrows_data (List[DailyEscrowData]) – Daily escrows data

class human_protocol_sdk.statistics.statistics_client.HMTHolder(address, balance)

Bases: object

A class used to specify HMT holder.

__init__(address, balance)

Initializes a HMTHolder instance.

• Parameters:

  • address (str) – Holder address

  • balance (int) – Holder balance

class human_protocol_sdk.statistics.statistics_client.HMTHoldersParam(address=None, order_direction='asc')

Bases: object

A class used to specify parameters for querying HMT holders.

__init__(address=None, order_direction='asc')

Initializes a HMTHoldersParam instance.

• Parameters:

  • address (Optional[str]) – Filter by holder’s address

  • order_direction (str) – Optional. Direction of sorting (‘asc’ for ascending, ‘desc’ for descending)

class human_protocol_sdk.statistics.statistics_client.HMTStatistics(total_transfer_amount, total_transfer_count, total_holders)

Bases: object

A class used to specify HMT statistics.

__init__(total_transfer_amount, total_transfer_count, total_holders)

Initializes a HMTStatistics instance.

• Parameters:

  • total_transfer_amount (int) – Total transfer amount

  • total_transfer_count (int) – Total transfer count

  • total_holders (int) – Total holders

class human_protocol_sdk.statistics.statistics_client.PaymentStatistics(daily_payments_data)

Bases: object

A class used to specify payment statistics.

__init__(daily_payments_data)

Initializes a PaymentStatistics instance.

• Parameters: daily_payments_data (List[DailyPaymentData]) – Daily payments data

class human_protocol_sdk.statistics.statistics_client.StatisticsClient(chain_id=ChainId.POLYGON_AMOY)

Bases: object

A client used to get statistical data.

__init__(chain_id=ChainId.POLYGON_AMOY)

Initializes a Statistics instance

• Parameters: chain_id (ChainId) – Chain ID to get statistical data from

get_escrow_statistics(filter=<human_protocol_sdk.filter.StatisticsFilter object>, options=None)

Get escrow statistics data for the given date range.

• Parameters:

  • filter (StatisticsFilter) – Object containing the date range

  • options (Optional[SubgraphOptions]) – Optional config for subgraph requests

• Return type: EscrowStatistics

• Returns: Escrow statistics data

• Example:

  from human_protocol_sdk.constants import ChainId
  from human_protocol_sdk.statistics import StatisticsClient
  from human_protocol_sdk.filter import StatisticsFilter
  
  statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
  
  print(statistics_client.get_escrow_statistics())
  print(
      statistics_client.get_escrow_statistics(
          StatisticsFilter(
              date_from=datetime.datetime(2023, 5, 8),
              date_to=datetime.datetime(2023, 6, 8),
          )
      )
  )

get_hmt_daily_data(filter=<human_protocol_sdk.filter.StatisticsFilter object>, options=None)

Get HMT daily statistics data for the given date range.

• Parameters:

  • filter (StatisticsFilter) – Object containing the date range

  • options (Optional[SubgraphOptions]) – Optional config for subgraph requests

• Return type: List[DailyHMTData]

• Returns: HMT statistics data

• Example:

  from human_protocol_sdk.constants import ChainId
  from human_protocol_sdk.statistics import StatisticsClient, StatisticsFilter
  
  statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
  
  print(statistics_client.get_hmt_daily_data())
  print(
      statistics_client.get_hmt_daily_data(
          StatisticsFilter(
              date_from=datetime.datetime(2023, 5, 8),
              date_to=datetime.datetime(2023, 6, 8),
          )
      )
  )

get_hmt_holders(param=<human_protocol_sdk.statistics.statistics_client.HMTHoldersParam object>, options=None)

Get HMT holders data with optional filters and ordering.

• Parameters:

  • param (HMTHoldersParam) – Object containing filter and order parameters

  • options (Optional[SubgraphOptions]) – Optional config for subgraph requests

• Return type: List[HMTHolder]

• Returns: List of HMT holders

• Example:

  from human_protocol_sdk.constants import ChainId
  from human_protocol_sdk.statistics import StatisticsClient, HMTHoldersParam
  
  statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
  
  print(statistics_client.get_hmt_holders())
  print(
      statistics_client.get_hmt_holders(
          HMTHoldersParam(
              address="0x123...",
              order_direction="asc",
          )
      )
  )

get_hmt_statistics(options=None)

Get HMT statistics data.

• Parameters: options (Optional[SubgraphOptions]) – Optional config for subgraph requests

• Return type: HMTStatistics

• Returns: HMT statistics data

• Example:

  from human_protocol_sdk.constants import ChainId
  from human_protocol_sdk.statistics import StatisticsClient
  
  statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
  
  print(statistics_client.get_hmt_statistics())

get_payment_statistics(filter=<human_protocol_sdk.filter.StatisticsFilter object>, options=None)

Get payment statistics data for the given date range.

• Parameters:

  • filter (StatisticsFilter) – Object containing the date range

  • options (Optional[SubgraphOptions]) – Optional config for subgraph requests

• Return type: PaymentStatistics

• Returns: Payment statistics data

• Example:

  from human_protocol_sdk.constants import ChainId
  from human_protocol_sdk.statistics import StatisticsClient
  from human_protocol_sdk.filter import StatisticsFilter
  
  statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
  
  print(statistics_client.get_payment_statistics())
  print(
      statistics_client.get_payment_statistics(
          StatisticsFilter(
              date_from=datetime.datetime(2023, 5, 8),
              date_to=datetime.datetime(2023, 6, 8),
          )
      )
  )

get_worker_statistics(filter=<human_protocol_sdk.filter.StatisticsFilter object>, options=None)

Get worker statistics data for the given date range.

• Parameters:

  • filter (StatisticsFilter) – Object containing the date range

  • options (Optional[SubgraphOptions]) – Optional config for subgraph requests

• Return type: WorkerStatistics

• Returns: Worker statistics data

• Example:

  from human_protocol_sdk.constants import ChainId
  from human_protocol_sdk.statistics import StatisticsClient
  from human_protocol_sdk.filter import StatisticsFilter
  
  statistics_client = StatisticsClient(ChainId.POLYGON_AMOY)
  
  print(statistics_client.get_worker_statistics())
  print(
      statistics_client.get_worker_statistics(
          StatisticsFilter(
              date_from=datetime.datetime(2023, 5, 8),
              date_to=datetime.datetime(2023, 6, 8),
          )
      )
  )

exception human_protocol_sdk.statistics.statistics_client.StatisticsClientError

Bases: Exception

Raises when some error happens when getting data from subgraph.

class human_protocol_sdk.statistics.statistics_client.WorkerStatistics(daily_workers_data)

Bases: object

A class used to specify worker statistics.

__init__(daily_workers_data)

Initializes a WorkerStatistics instance.

• Parameters: daily_workers_data (List[DailyWorkerData]) – Daily workers data