web3research.Web3Research

class web3research.Web3Research(api_token: str)

Web3Research is the main entry point.

Parameters:

api_token (str)

api_token
eth(backend: str | None = None, database: str = 'ethereum', settings: Dict[str, Any] | None = None, generic_args: Dict[str, Any] | None = None, **kwargs)

Create an EthereumProvider instance. This is a convenience method for creating an EthereumProvider instance.

Args:

backend (str, optional): The Web3Research backend to use. Defaults to None. database (str, optional): The database to use. Defaults to “ethereum”. settings (Dict[str, Any], optional): The Clickhouse settings to use. Defaults to None. generic_args (Dict[str, Any], optional): The Clickhouse generic arguments to use. Defaults to None. **kwargs: Additional Clickhouse keyword arguments.

Returns:

EthereumProvider: An EthereumProvider instance.

Parameters:
  • backend (Optional[str])

  • database (str)

  • settings (Optional[Dict[str, Any]])

  • generic_args (Optional[Dict[str, Any]])

ethereum(backend: str | None = None, database: str = 'ethereum', settings: Dict[str, Any] | None = None, generic_args: Dict[str, Any] | None = None, **kwargs)

Create an EthereumProvider instance. Same as eth().

Args:

backend (str, optional): The Web3Research backend to use. Defaults to None. database (str, optional): The database to use. Defaults to “ethereum”. settings (Dict[str, Any], optional): The Clickhouse settings to use. Defaults to None. generic_args (Dict[str, Any], optional): The Clickhouse generic arguments to use. Defaults to None. **kwargs: Additional Clickhouse keyword arguments.

Returns:

EthereumProvider: An EthereumProvider instance.

Parameters:
  • backend (Optional[str])

  • database (str)

  • settings (Optional[Dict[str, Any]])

  • generic_args (Optional[Dict[str, Any]])

tron(backend: str | None = None, database: str = 'tron', settings: Dict[str, Any] | None = None, generic_args: Dict[str, Any] | None = None, **kwargs)

Create a TronProvider instance. This is a convenience method for creating a TronProvider instance.

Args:

backend (str, optional): The Web3Research backend to use. Defaults to None. database (str, optional): The database to use. Defaults to “tron”. settings (Dict[str, Any], optional): The Clickhouse settings to use. Defaults to None. generic_args (Dict[str, Any], optional): The Clickhouse generic arguments to use. Defaults to None. **kwargs: Additional Clickhouse keyword arguments.

Returns:

TronProvider: A TronProvider instance.

Parameters:
  • backend (Optional[str])

  • database (str)

  • settings (Optional[Dict[str, Any]])

  • generic_args (Optional[Dict[str, Any]])

btc(backend: str | None = None, database: str = 'bitcoin', settings: Dict[str, Any] | None = None, generic_args: Dict[str, Any] | None = None, **kwargs)

Create a BitcoinProvider instance. This is a convenience method for creating a BitcoinProvider instance.

Args:

backend (str, optional): The Web3Research backend to use. Defaults to None. database (str, optional): The database to use. Defaults to “bitcoin”. settings (Dict[str, Any], optional): The Clickhouse settings to use. Defaults to None. generic_args (Dict[str, Any], optional): The Clickhouse generic arguments to use. Defaults to None. **kwargs: Additional Clickhouse keyword arguments.

Returns:

BitcoinProvider: A BitcoinProvider instance.

Parameters:
  • backend (Optional[str])

  • database (str)

  • settings (Optional[Dict[str, Any]])

  • generic_args (Optional[Dict[str, Any]])

bitcoin(backend: str | None = None, database: str = 'bitcoin', settings: Dict[str, Any] | None = None, generic_args: Dict[str, Any] | None = None, **kwargs)

Create a BitcoinProvider instance. Same as btc().

Args:

backend (str, optional): The Web3Research backend to use. Defaults to None. database (str, optional): The database to use. Defaults to “bitcoin”. settings (Dict[str, Any], optional): The Clickhouse settings to use. Defaults to None. generic_args (Dict[str, Any], optional): The Clickhouse generic arguments to use. Defaults to None. **kwargs: Additional Clickhouse keyword arguments.

Returns:

BitcoinProvider: A BitcoinProvider instance.

Parameters:
  • backend (Optional[str])

  • database (str)

  • settings (Optional[Dict[str, Any]])

  • generic_args (Optional[Dict[str, Any]])