tessl/pypi-openbb

Investment research for everyone, anywhere.

—

Pending

Overview

Eval results

Files

Currency and Forex

Name: tessl/pypi-openbb
Author: tessl

Foreign exchange data including currency pairs, exchange rates, and forex market information. The currency module provides access to FX market data and currency analytics.

Capabilities

Foreign Exchange Data

Comprehensive forex market data including currency pairs, exchange rates, and FX market analytics.

def obb.currency.reference_rates(
    provider: str = None,
    **kwargs
) -> ResponseObject:
    """
    Get currency reference rates.
    
    Parameters:
    - provider: Data provider to use
    
    Returns:
    ResponseObject with currency reference rates
    """

def obb.currency.search(
    query: str,
    provider: str = None,
    **kwargs
) -> ResponseObject:
    """
    Search for currency pairs and related information.
    
    Parameters:
    - query: Search term for currency pairs
    - provider: Data provider to use
    
    Returns:
    ResponseObject with matching currency pairs
    """

def obb.currency.snapshots(
    provider: str = None,
    **kwargs
) -> ResponseObject:
    """
    Get currency market snapshots.
    
    Parameters:
    - provider: Data provider to use
    
    Returns:
    ResponseObject with currency market snapshots
    """

def obb.currency.historical(
    symbol: str,
    provider: str = None,
    **kwargs
) -> ResponseObject:
    """
    Get historical currency data.
    
    Parameters:
    - symbol: Currency pair symbol (e.g., "EUR/USD")
    - provider: Data provider to use
    
    Returns:
    ResponseObject with historical currency data
    """

Usage Examples

Basic Forex Data

from openbb import obb

# Get currency reference rates
rates_data = obb.currency.reference_rates()
rates_df = rates_data.to_dataframe()

# Search for currency pairs
search_data = obb.currency.search(query="EUR")
search_df = search_data.to_dataframe()

# Get historical currency data
historical_data = obb.currency.historical(symbol="EUR/USD")
historical_df = historical_data.to_dataframe()

Currency Analysis Workflow

# Retrieve currency pair data
# Analyze exchange rate trends
# Compare multiple currency pairs

Install with Tessl CLI

npx tessl i tessl/pypi-openbb

docs