tessl/pypi-openbb

Investment research for everyone, anywhere.

—

Pending

Overview

Eval results

Files

Cryptocurrency Data

Name: tessl/pypi-openbb
Author: tessl

Cryptocurrency market data including historical prices, market information, and trading pair discovery across major exchanges. The crypto module provides unified access to cryptocurrency data from multiple sources and exchanges.

Capabilities

Price Data

Historical and real-time cryptocurrency price data including OHLCV data across major trading pairs.

def obb.crypto.price.historical(
    symbol: str,
    start_date: str = None,
    end_date: str = None,
    interval: str = "1d",
    provider: str = None,
    **kwargs
) -> ResponseObject:
    """
    Get historical cryptocurrency price data.
    
    Parameters:
    - symbol: Cryptocurrency trading pair (e.g., "BTC-USD", "ETH-BTC")
    - start_date: Start date in YYYY-MM-DD format
    - end_date: End date in YYYY-MM-DD format  
    - interval: Data interval ("1m", "5m", "15m", "30m", "1h", "1d", "1wk", "1mo")
    - provider: Data provider to use
    
    Returns:
    ResponseObject with historical crypto price data including open, high, low, close, volume
    """

Cryptocurrency Search and Discovery

Tools for discovering cryptocurrency trading pairs and market information.

def obb.crypto.search(
    query: str,
    provider: str = None,
    **kwargs
) -> ResponseObject:
    """
    Search for cryptocurrency trading pairs.
    
    Parameters:
    - query: Search term (cryptocurrency name or symbol like "BTC", "Bitcoin")
    - provider: Data provider to use
    
    Returns:
    ResponseObject with matching cryptocurrency pairs and their symbols
    """

Usage Examples

Basic Cryptocurrency Data

from openbb import obb

# Get Bitcoin historical data
btc_data = obb.crypto.price.historical(
    symbol="BTC-USD",
    start_date="2024-01-01",
    end_date="2024-12-31"
)
btc_df = btc_data.to_dataframe()

# Get Ethereum data  
eth_data = obb.crypto.price.historical("ETH-USD")
eth_df = eth_data.to_dataframe()

Cryptocurrency Discovery

# Search for Bitcoin-related pairs
btc_pairs = obb.crypto.search("BTC")
pairs_df = btc_pairs.to_dataframe()

# Search for specific cryptocurrency
ethereum_info = obb.crypto.search("Ethereum")
eth_info_df = ethereum_info.to_dataframe()

Multi-Exchange Data Access

# Access cryptocurrency data from different providers/exchanges
# Provider-specific features while maintaining consistent interface
crypto_data = obb.crypto.price.historical(
    symbol="BTC-USD",
    provider="polygon"  # or other supported crypto data providers
)

Install with Tessl CLI