|
|
"""Python interface integration tests for the equity extension.""" |
|
|
|
|
|
from datetime import date, timedelta |
|
|
|
|
|
import pytest |
|
|
from extensions.tests.conftest import parametrize |
|
|
from openbb_core.app.model.obbject import OBBject |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@pytest.fixture(scope="session") |
|
|
def obb(pytestconfig): |
|
|
"""Fixture to setup obb.""" |
|
|
if pytestconfig.getoption("markexpr") != "not integration": |
|
|
import openbb |
|
|
|
|
|
return openbb.obb |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "period": "annual", "limit": 12}), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"period": "quarter", |
|
|
"fiscal_year": 2014, |
|
|
"limit": 2, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "polygon", |
|
|
"include_sources": True, |
|
|
"order": "asc", |
|
|
"sort": "filing_date", |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"limit": 12, |
|
|
"filing_date": "2022-10-27", |
|
|
"filing_date_lt": "2022-11-01", |
|
|
"filing_date_lte": "2022-11-01", |
|
|
"filing_date_gt": "2022-10-10", |
|
|
"filing_date_gte": "2022-10-10", |
|
|
"period_of_report_date": "2022-09-24", |
|
|
"period_of_report_date_lt": "2022-11-01", |
|
|
"period_of_report_date_lte": "2022-11-01", |
|
|
"period_of_report_date_gt": "2022-10-10", |
|
|
"period_of_report_date_gte": "2022-10-10", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"limit": 12, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"limit": 5, |
|
|
"provider": "yfinance", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_balance(params, obb): |
|
|
"""Test the equity fundamental balance endpoint.""" |
|
|
result = obb.equity.fundamental.balance(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "limit": 10, "provider": "fmp", "period": "annual"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_balance_growth(params, obb): |
|
|
"""Test the equity fundamental balance growth endpoint.""" |
|
|
result = obb.equity.fundamental.balance_growth(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"start_date": "2023-11-05", "end_date": "2023-11-10", "provider": "fmp"}), |
|
|
({"start_date": "2023-11-05", "end_date": "2023-11-10", "provider": "nasdaq"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_calendar_dividend(params, obb): |
|
|
"""Test the equity calendar dividend endpoint.""" |
|
|
result = obb.equity.calendar.dividend(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"start_date": "2023-11-05", "end_date": "2023-11-10", "provider": "fmp"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_calendar_splits(params, obb): |
|
|
"""Test the equity calendar splits endpoint.""" |
|
|
result = obb.equity.calendar.splits(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"start_date": "2023-11-09", "end_date": "2023-11-10", "provider": "fmp"}), |
|
|
({"start_date": "2023-11-09", "end_date": "2023-11-10", "provider": "nasdaq"}), |
|
|
({"start_date": "2023-11-09", "end_date": "2023-11-10", "provider": "tmx"}), |
|
|
( |
|
|
{ |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
"provider": "seeking_alpha", |
|
|
"country": "us", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_calendar_earnings(params, obb): |
|
|
"""Test the equity calendar earnings endpoint.""" |
|
|
result = obb.equity.calendar.earnings(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"fiscal_year": None, |
|
|
"limit": 2, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "polygon", |
|
|
"include_sources": True, |
|
|
"order": "asc", |
|
|
"sort": "filing_date", |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"limit": 12, |
|
|
"filing_date": "2022-10-27", |
|
|
"filing_date_lt": "2022-11-01", |
|
|
"filing_date_lte": "2022-11-01", |
|
|
"filing_date_gt": "2022-10-10", |
|
|
"filing_date_gte": "2022-10-10", |
|
|
"period_of_report_date": "2022-09-24", |
|
|
"period_of_report_date_lt": "2022-11-01", |
|
|
"period_of_report_date_lte": "2022-11-01", |
|
|
"period_of_report_date_gt": "2022-10-10", |
|
|
"period_of_report_date_gte": "2022-10-10", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"limit": 12, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"limit": 5, |
|
|
"provider": "yfinance", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_cash(params, obb): |
|
|
"""Test the equity fundamental cash endpoint.""" |
|
|
result = obb.equity.fundamental.cash(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "limit": 10, "provider": "fmp", "period": "annual"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_cash_growth(params, obb): |
|
|
"""Test the equity fundamental cash growth endpoint.""" |
|
|
result = obb.equity.fundamental.cash_growth(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"year": 2022, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"provider": "fmp", |
|
|
"year": None, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,MSFT", |
|
|
"provider": "fmp", |
|
|
"year": None, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_management_compensation(params, obb): |
|
|
"""Test the equity fundamental management compensation endpoint.""" |
|
|
result = obb.equity.fundamental.management_compensation(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "provider": "fmp"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_historical_splits(params, obb): |
|
|
"""Test the equity fundamental historical splits endpoint.""" |
|
|
result = obb.equity.fundamental.historical_splits(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2021-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"limit": 100, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
({"symbol": "RY", "provider": "tmx"}), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2021-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"limit": 3, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2021-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"provider": "nasdaq", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"provider": "yfinance", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_dividends(params, obb): |
|
|
"""Test the equity fundamental dividends endpoint.""" |
|
|
result = obb.equity.fundamental.dividends(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "provider": "fmp"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_employee_count(params, obb): |
|
|
"""Test the equity fundamental employee count endpoint.""" |
|
|
result = obb.equity.fundamental.employee_count(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL,MSFT", "period": "annual", "limit": 30}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_estimates_historical(params, obb): |
|
|
"""Test the equity estimates historical endpoint.""" |
|
|
result = obb.equity.estimates.historical(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "period": "annual", "limit": 12}), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"period": "quarter", |
|
|
"fiscal_year": 2020, |
|
|
"limit": 4, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "polygon", |
|
|
"include_sources": True, |
|
|
"order": "asc", |
|
|
"sort": "filing_date", |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"limit": 12, |
|
|
"filing_date": "2022-10-27", |
|
|
"filing_date_lt": "2022-11-01", |
|
|
"filing_date_lte": "2022-11-01", |
|
|
"filing_date_gt": "2022-10-10", |
|
|
"filing_date_gte": "2022-10-10", |
|
|
"period_of_report_date": "2022-09-24", |
|
|
"period_of_report_date_lt": "2022-11-01", |
|
|
"period_of_report_date_lte": "2022-11-01", |
|
|
"period_of_report_date_gt": "2022-10-10", |
|
|
"period_of_report_date_gte": "2022-10-10", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "fmp", |
|
|
"symbol": "AAPL", |
|
|
"limit": 12, |
|
|
"period": "annual", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "yfinance", |
|
|
"symbol": "AAPL", |
|
|
"limit": 5, |
|
|
"period": "annual", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_income(params, obb): |
|
|
"""Test the equity fundamental income endpoint.""" |
|
|
result = obb.equity.fundamental.income(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"symbol": "AAPL", "limit": 10, "period": "annual", "provider": "fmp"}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_income_growth(params, obb): |
|
|
"""Test the equity fundamental income growth endpoint.""" |
|
|
result = obb.equity.fundamental.income_growth(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "RY", |
|
|
"provider": "tmx", |
|
|
"limit": 0, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "fmp", |
|
|
"symbol": "AAPL", |
|
|
"limit": 10, |
|
|
"transaction_type": None, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"limit": 10, |
|
|
"start_date": "2021-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"ownership_type": None, |
|
|
"sort_by": "updated_on", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "sec", |
|
|
"symbol": "AAPL", |
|
|
"limit": 10, |
|
|
"start_date": "2024-06-30", |
|
|
"end_date": "2024-09-30", |
|
|
"use_cache": True, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_ownership_insider_trading(params, obb): |
|
|
"""Test the equity ownership insider trading endpoint.""" |
|
|
result = obb.equity.ownership.insider_trading(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"include_current_quarter": True, |
|
|
"date": "2021-09-30", |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_ownership_institutional(params, obb): |
|
|
"""Test the equity ownership institutional endpoint.""" |
|
|
result = obb.equity.ownership.institutional(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": None, |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"limit": 100, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-11-01", |
|
|
"status": "priced", |
|
|
"provider": "nasdaq", |
|
|
"is_spo": False, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_calendar_ipo(params, obb): |
|
|
"""Test the equity calendar IPO endpoint.""" |
|
|
result = obb.equity.calendar.ipo(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "period": "annual", "limit": 100}), |
|
|
( |
|
|
{ |
|
|
"provider": "fmp", |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"limit": 100, |
|
|
"with_ttm": False, |
|
|
} |
|
|
), |
|
|
({"provider": "intrinio", "symbol": "AAPL", "limit": 100}), |
|
|
({"provider": "yfinance", "symbol": "AAPL"}), |
|
|
({"provider": "finviz", "symbol": "AAPL,GOOG"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_metrics(params, obb): |
|
|
"""Test the equity fundamental metrics endpoint.""" |
|
|
result = obb.equity.fundamental.metrics(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
if isinstance(result.results, list): |
|
|
assert len(result.results) > 0 |
|
|
else: |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "provider": "fmp"}), |
|
|
({"symbol": "AAPL", "provider": "yfinance"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_management(params, obb): |
|
|
"""Test the equity fundamental management endpoint.""" |
|
|
result = obb.equity.fundamental.management(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "date": "2023-01-01", "page": 1, "provider": "fmp"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_ownership_major_holders(params, obb): |
|
|
"""Test the equity ownership major holders endpoint.""" |
|
|
result = obb.equity.ownership.major_holders(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "limit": 10, "provider": "fmp", "with_grade": True}), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"limit": 10, |
|
|
"provider": "benzinga", |
|
|
|
|
|
"fields": None, |
|
|
"date": None, |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
"importance": None, |
|
|
"updated": None, |
|
|
"action": None, |
|
|
"analyst_ids": None, |
|
|
"firm_ids": None, |
|
|
"page": 0, |
|
|
} |
|
|
), |
|
|
({"symbol": "AAPL", "provider": "finviz"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_estimates_price_target(params, obb): |
|
|
"""Test the equity estimates price target endpoint.""" |
|
|
result = obb.equity.estimates.price_target(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"limit": 10, |
|
|
"provider": "benzinga", |
|
|
|
|
|
"fields": None, |
|
|
"analyst_ids": None, |
|
|
"firm_ids": None, |
|
|
"firm_name": "Barclays", |
|
|
"analyst_name": None, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_estimates_analyst_search(params, obb): |
|
|
"""Test the equity estimates analyst search endpoint.""" |
|
|
result = obb.equity.estimates.analyst_search(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "provider": "fmp"}), |
|
|
({"symbol": "AAPL,AMZN,RELIANCE.NS", "provider": "yfinance"}), |
|
|
({"symbol": "TD:US", "provider": "tmx"}), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,MSFT", |
|
|
"industry_group_number": None, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_estimates_consensus(params, obb): |
|
|
"""Test the equity estimates consensus endpoint.""" |
|
|
result = obb.equity.estimates.consensus(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,MSFT", |
|
|
"fiscal_period": "fy", |
|
|
"fiscal_year": None, |
|
|
"calendar_year": None, |
|
|
"calendar_period": None, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,BAM:CA", |
|
|
"period": "annual", |
|
|
"provider": "seeking_alpha", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_estimates_forward_sales(params, obb): |
|
|
"""Test the equity estimates forward sales endpoint.""" |
|
|
result = obb.equity.estimates.forward_sales(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,MSFT", |
|
|
"fiscal_period": "fy", |
|
|
"fiscal_year": None, |
|
|
"calendar_year": None, |
|
|
"calendar_period": None, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,MSFT", |
|
|
"fiscal_period": "annual", |
|
|
"limit": None, |
|
|
"include_historical": False, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,BAM:CA", |
|
|
"period": "annual", |
|
|
"provider": "seeking_alpha", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_estimates_forward_eps(params, obb): |
|
|
"""Test the equity estimates forward EPS endpoint.""" |
|
|
result = obb.equity.estimates.forward_eps(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,MSFT", |
|
|
"fiscal_period": "quarter", |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,MSFT", |
|
|
"fiscal_period": "annual", |
|
|
"limit": None, |
|
|
"include_historical": False, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_estimates_forward_ebitda(params, obb): |
|
|
"""Test the equity estimates forward EBITDA endpoint.""" |
|
|
result = obb.equity.estimates.forward_ebitda(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "period": "annual", "limit": 12, "provider": "fmp"}), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"period": "ttm", |
|
|
"fiscal_year": None, |
|
|
"limit": 12, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_ratios(params, obb): |
|
|
"""Test the equity fundamental ratios endpoint.""" |
|
|
result = obb.equity.fundamental.ratios(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_revenue_per_geography(params, obb): |
|
|
"""Test the equity fundamental revenue per geography endpoint.""" |
|
|
result = obb.equity.fundamental.revenue_per_geography(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"period": "annual", |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_revenue_per_segment(params, obb): |
|
|
"""Test the equity fundamental revenue per segment endpoint.""" |
|
|
result = obb.equity.fundamental.revenue_per_segment(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"form_type": "144", |
|
|
"limit": 100, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2021-01-01", |
|
|
"end_date": "2023-01-01", |
|
|
"form_type": "4", |
|
|
"limit": 100, |
|
|
"thea_enabled": None, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"limit": 3, |
|
|
"form_type": "8-K", |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
"cik": None, |
|
|
"provider": "sec", |
|
|
"use_cache": False, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"cik": "0001067983", |
|
|
"limit": 3, |
|
|
"form_type": "10-Q", |
|
|
"symbol": None, |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
"provider": "sec", |
|
|
"use_cache": False, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "tmx", |
|
|
"symbol": "IBM:US", |
|
|
"start_date": "2023-09-30", |
|
|
"end_date": "2023-12-31", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "nasdaq", |
|
|
"symbol": "AAPL", |
|
|
"form_group": "annual", |
|
|
"year": 2024, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_filings(params, obb): |
|
|
"""Test the equity fundamental filings endpoint.""" |
|
|
result = obb.equity.fundamental.filings(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "provider": "fmp"}), |
|
|
({"symbol": "AAPL", "provider": "intrinio"}), |
|
|
({"symbol": "AAPL", "provider": "yfinance"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_ownership_share_statistics(params, obb): |
|
|
"""Test the equity ownership share statistics endpoint.""" |
|
|
result = obb.equity.ownership.share_statistics(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "year": 2023}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_transcript(params, obb): |
|
|
"""Test the equity fundamental transcript endpoint.""" |
|
|
result = obb.equity.fundamental.transcript(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_compare_peers(params, obb): |
|
|
"""Test the equity compare peers endpoint.""" |
|
|
result = obb.equity.compare.peers(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"group": "country", "metric": "overview", "provider": "finviz"}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_compare_groups(params, obb): |
|
|
"""Test the equity compare groups endpoint.""" |
|
|
result = obb.equity.compare.groups(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"adjustment": "unadjusted", |
|
|
"extended_hours": True, |
|
|
"provider": "alpha_vantage", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"interval": "15m", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "cboe", |
|
|
"symbol": "AAPL", |
|
|
"start_date": (date.today() - timedelta(days=1)).strftime("%Y-%m-%d"), |
|
|
"end_date": date.today().strftime("%Y-%m-%d"), |
|
|
"interval": "1m", |
|
|
"use_cache": False, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "cboe", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"interval": "1d", |
|
|
"use_cache": False, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "fmp", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"interval": "1d", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"interval": "1h", |
|
|
"provider": "fmp", |
|
|
"symbol": "AAPL,MSFT", |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"timezone": "UTC", |
|
|
"source": "realtime", |
|
|
"start_time": None, |
|
|
"end_time": None, |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-06-01", |
|
|
"end_date": "2023-06-03", |
|
|
"interval": "1h", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"timezone": None, |
|
|
"source": "delayed", |
|
|
"start_time": None, |
|
|
"end_time": None, |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"interval": "1d", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"sort": "desc", |
|
|
"limit": "49999", |
|
|
"adjustment": "unadjusted", |
|
|
"provider": "polygon", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-01-03", |
|
|
"interval": "1m", |
|
|
"extended_hours": False, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"sort": "desc", |
|
|
"limit": "49999", |
|
|
"adjustment": "splits_only", |
|
|
"provider": "polygon", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"interval": "1d", |
|
|
"extended_hours": False, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"extended_hours": False, |
|
|
"include_actions": False, |
|
|
"adjustment": "splits_and_dividends", |
|
|
"provider": "yfinance", |
|
|
"symbol": "AAPL", |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
"interval": "1h", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"extended_hours": False, |
|
|
"include_actions": True, |
|
|
"adjustment": "splits_only", |
|
|
"provider": "yfinance", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"interval": "1d", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "tiingo", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"interval": "1d", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "tiingo", |
|
|
"symbol": "AAPL", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"interval": "1M", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "tradier", |
|
|
"symbol": "AAPL,MSFT", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-06-06", |
|
|
"interval": "1M", |
|
|
"extended_hours": False, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "tradier", |
|
|
"symbol": "AAPL,MSFT", |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
"interval": "15m", |
|
|
"extended_hours": False, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "tmx", |
|
|
"symbol": "AAPL:US", |
|
|
"start_date": "2023-01-01", |
|
|
"end_date": "2023-12-31", |
|
|
"interval": "1d", |
|
|
"adjustment": "splits_only", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_price_historical(params, obb): |
|
|
"""Test the equity price historical endpoint.""" |
|
|
result = obb.equity.price.historical(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "provider": "fmp"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_multiples(params, obb): |
|
|
"""Test the equity fundamental multiples endpoint.""" |
|
|
result = obb.equity.fundamental.multiples(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"query": "ebit", "limit": 100, "provider": "intrinio"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_search_attributes(params, obb): |
|
|
"""Test the equity fundamental search attributes endpoint.""" |
|
|
result = obb.equity.fundamental.search_attributes(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"tag": "ebit", |
|
|
"frequency": "yearly", |
|
|
"limit": 1000, |
|
|
"tag_type": None, |
|
|
"start_date": "2013-01-01", |
|
|
"end_date": "2023-01-01", |
|
|
"sort": "desc", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"tag": "ebit,ebitda,marketcap", |
|
|
"frequency": "yearly", |
|
|
"limit": 1000, |
|
|
"tag_type": None, |
|
|
"start_date": "2013-01-01", |
|
|
"end_date": "2023-01-01", |
|
|
"sort": "desc", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"tag": ["ebit", "ebitda", "marketcap"], |
|
|
"frequency": "yearly", |
|
|
"limit": 1000, |
|
|
"tag_type": None, |
|
|
"start_date": "2013-01-01", |
|
|
"end_date": "2023-01-01", |
|
|
"sort": "desc", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL,MSFT", |
|
|
"tag": "ebit,ebitda,marketcap", |
|
|
"frequency": "yearly", |
|
|
"limit": 1000, |
|
|
"tag_type": None, |
|
|
"start_date": "2013-01-01", |
|
|
"end_date": "2023-01-01", |
|
|
"sort": "desc", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": ["AAPL", "MSFT"], |
|
|
"tag": ["ebit", "ebitda", "marketcap"], |
|
|
"frequency": "yearly", |
|
|
"limit": 1000, |
|
|
"tag_type": None, |
|
|
"start_date": "2013-01-01", |
|
|
"end_date": "2023-01-01", |
|
|
"sort": "desc", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_historical_attributes(params, obb): |
|
|
"""Test the equity fundamental historical attributes endpoint.""" |
|
|
result = obb.equity.fundamental.historical_attributes(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"tag": "ceo", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"tag": "ebitda", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"tag": "ceo,ebitda", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL", |
|
|
"tag": ["ceo", "ebitda"], |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": "AAPL,MSFT", |
|
|
"tag": ["ceo", "ebitda"], |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "intrinio", |
|
|
"symbol": ["MSFT", "AAPL"], |
|
|
"tag": ["ceo", "ebitda"], |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_latest_attributes(params, obb): |
|
|
"""Test the equity fundamental latest attributes endpoint.""" |
|
|
result = obb.equity.fundamental.latest_attributes(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
if isinstance(result.results, list): |
|
|
assert len(result.results) > 0 |
|
|
else: |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"query": "AAPL", "is_symbol": True, "provider": "cboe", "use_cache": False}), |
|
|
({"query": "Apple", "provider": "sec", "use_cache": False, "is_fund": False}), |
|
|
({"query": "", "provider": "nasdaq", "is_etf": True}), |
|
|
({"query": "gold", "provider": "tmx", "use_cache": False}), |
|
|
({"query": "gold", "provider": "tradier", "is_symbol": False}), |
|
|
( |
|
|
{ |
|
|
"query": "gold", |
|
|
"provider": "intrinio", |
|
|
"active": True, |
|
|
"limit": 100, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_search(params, obb): |
|
|
"""Test the equity search endpoint.""" |
|
|
result = obb.equity.search(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"industry": "REIT", |
|
|
"sector": "real_estate", |
|
|
"mktcap_min": None, |
|
|
"mktcap_max": None, |
|
|
"price_min": None, |
|
|
"price_max": None, |
|
|
"volume_min": None, |
|
|
"volume_max": None, |
|
|
"dividend_min": None, |
|
|
"dividend_max": None, |
|
|
"is_active": True, |
|
|
"is_etf": False, |
|
|
"beta_min": None, |
|
|
"beta_max": None, |
|
|
"country": "US", |
|
|
"exchange": "nyse", |
|
|
"limit": None, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"sector": "consumer_staples,consumer_discretionary", |
|
|
"exchange": "all", |
|
|
"exsubcategory": "all", |
|
|
"region": "all", |
|
|
"country": "all", |
|
|
"mktcap": "large", |
|
|
"recommendation": "all", |
|
|
"limit": None, |
|
|
"provider": "nasdaq", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"metric": "overview", |
|
|
"signal": None, |
|
|
"preset": None, |
|
|
"filters_dict": None, |
|
|
"sector": "consumer_defensive", |
|
|
"industry": "grocery_stores", |
|
|
"index": "all", |
|
|
"exchange": "all", |
|
|
"mktcap": "all", |
|
|
"recommendation": "all", |
|
|
"limit": None, |
|
|
"provider": "finviz", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"country": "us", |
|
|
"sector": "consumer_cyclical", |
|
|
"industry": "auto_manufacturers", |
|
|
"exchange": None, |
|
|
"mktcap_min": 60000000000, |
|
|
"mktcap_max": None, |
|
|
"price_min": 10, |
|
|
"price_max": None, |
|
|
"volume_min": 5000000, |
|
|
"volume_max": None, |
|
|
"beta_min": None, |
|
|
"beta_max": None, |
|
|
"provider": "yfinance", |
|
|
"limit": 200, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_screener(params, obb): |
|
|
"""Test the equity screener endpoint.""" |
|
|
result = obb.equity.screener(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL"}), |
|
|
({"source": "iex", "provider": "intrinio", "symbol": "AAPL"}), |
|
|
({"symbol": "AAPL", "provider": "fmp"}), |
|
|
({"symbol": "AAPL", "provider": "cboe", "use_cache": False}), |
|
|
({"symbol": "AAPL", "provider": "yfinance"}), |
|
|
({"symbol": "AAPL:US", "provider": "tmx"}), |
|
|
({"symbol": "AAPL,MSFT", "provider": "tradier"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_price_quote(params, obb): |
|
|
"""Test the equity price quote endpoint.""" |
|
|
result = obb.equity.price.quote(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "MSFT", "provider": "intrinio"}), |
|
|
({"symbol": "AAPL,MSFT", "provider": "intrinio"}), |
|
|
({"symbol": "AAPL,MSFT", "provider": "finviz"}), |
|
|
({"symbol": "AAPL,MSFT", "provider": "yfinance"}), |
|
|
({"symbol": "AAPL,MSFT", "provider": "fmp"}), |
|
|
({"provider": "tmx", "symbol": "AAPL:US"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_profile(params, obb): |
|
|
"""Test the equity profile endpoint.""" |
|
|
result = obb.equity.profile(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
if isinstance(result.results, list): |
|
|
assert len(result.results) > 0 |
|
|
else: |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"sort": "desc", "provider": "yfinance", "limit": 10}), |
|
|
({"provider": "tmx", "category": "52w_high"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_gainers(params, obb): |
|
|
"""Test the equity discovery gainers endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.gainers(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"sort": "desc", "provider": "yfinance", "limit": 10}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_losers(params, obb): |
|
|
"""Test the equity discovery losers endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.losers(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"sort": "desc", "provider": "yfinance", "limit": 10}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_active(params, obb): |
|
|
"""Test the equity discovery active endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.active(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "provider": "fmp"}), |
|
|
({"symbol": "AAPL,MSFT", "provider": "finviz"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_price_performance(params, obb): |
|
|
"""Test the equity price performance endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.price.performance(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"sort": "desc", "provider": "yfinance", "limit": 10}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_undervalued_large_caps(params, obb): |
|
|
"""Test the equity discovery undervalued large caps endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.undervalued_large_caps(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"sort": "desc", "provider": "yfinance", "limit": 10}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_undervalued_growth(params, obb): |
|
|
"""Test the equity discovery undervalued growth endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.undervalued_growth(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"sort": "desc", "provider": "yfinance", "limit": 10}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_aggressive_small_caps(params, obb): |
|
|
"""Test the equity discovery aggressive small caps endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.aggressive_small_caps(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"sort": "desc", "provider": "yfinance", "limit": 10}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_growth_tech(params, obb): |
|
|
"""Test the equity discovery growth tech endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.growth_tech(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"limit": 10, "provider": "nasdaq"}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_top_retail(params, obb): |
|
|
"""Test the equity discovery top retail endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.top_retail(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
"limit": 10, |
|
|
"form_type": "1-A", |
|
|
"is_done": None, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"start_date": "2023-11-06", |
|
|
"end_date": "2023-11-07", |
|
|
"limit": 50, |
|
|
"form_type": "10-Q", |
|
|
"is_done": "true", |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_filings(params, obb): |
|
|
"""Test the equity discovery filings endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.filings(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
if isinstance(result.results, list): |
|
|
assert len(result.results) > 0 |
|
|
else: |
|
|
assert result.results is not None |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL"}), |
|
|
( |
|
|
{ |
|
|
"limit": 24, |
|
|
"provider": "sec", |
|
|
"symbol": "AAPL", |
|
|
"skip_reports": 1, |
|
|
"use_cache": False, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_shorts_fails_to_deliver(params, obb): |
|
|
"""Test the equity shorts fails to deliver endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.shorts.fails_to_deliver(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"symbol": "AAPL", "provider": "stockgrid"}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_shorts_short_volume(params, obb): |
|
|
"""Test the equity shorts short volume endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.shorts.short_volume(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"symbol": "AAPL", "provider": "finra"}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_shorts_short_interest(params, obb): |
|
|
"""Test the equity shorts short interest endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.shorts.short_interest(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "CLOV", |
|
|
"provider": "polygon", |
|
|
"timestamp_gt": "2023-10-26T15:20:00.000000000-04:00", |
|
|
"timestamp_lt": "2023-10-26T15:30:00.000000000-04:00", |
|
|
"limit": 5000, |
|
|
"timestamp_gte": None, |
|
|
"timestamp_lte": None, |
|
|
"date": None, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_price_nbbo(params, obb): |
|
|
"""Test the equity price nbbo endpoint.""" |
|
|
result = obb.equity.price.nbbo(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL"}), |
|
|
({"tier": "T1", "is_ats": True, "provider": "finra", "symbol": "AAPL"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_darkpool_otc(params, obb): |
|
|
"""Test the equity darkpool otc endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.darkpool.otc(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"provider": "fmp", "market": "euronext"}), |
|
|
({"provider": "polygon"}), |
|
|
({"provider": "intrinio", "date": "2022-06-30"}), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_market_snapshots(params, obb): |
|
|
"""Test the equity market snapshots endpoint.""" |
|
|
result = obb.equity.market_snapshots(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
({"symbol": "AAPL", "limit": 5, "provider": "fmp"}), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"period": "quarter", |
|
|
"limit": 5, |
|
|
"provider": "alpha_vantage", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_historical_eps(params, obb): |
|
|
"""Test the equity fundamental historical eps endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.fundamental.historical_eps(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[{"provider": "tiingo", "symbol": "AAPL", "limit": 10}], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_trailing_dividend_yield(params, obb): |
|
|
"""Test the equity fundamental trailing dividend yield endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.fundamental.trailing_dividend_yield(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"statement_type": "income", |
|
|
"period": "quarter", |
|
|
"limit": 5, |
|
|
"fiscal_year": None, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"statement_type": "cash", |
|
|
"period": "annual", |
|
|
"limit": 1, |
|
|
"fiscal_year": 2015, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"statement_type": "balance", |
|
|
"period": "annual", |
|
|
"fiscal_year": None, |
|
|
"limit": 10, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_reported_financials(params, obb): |
|
|
"""Test the equity fundamental reported financials endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.fundamental.reported_financials(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "NVDA", |
|
|
"date": None, |
|
|
"limit": 1, |
|
|
"provider": "sec", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_ownership_form_13f(params, obb): |
|
|
"""Test the equity ownership form 13f endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.ownership.form_13f(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "NVDA,MSFT", |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": None, |
|
|
"provider": "intrinio", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_estimates_forward_pe(params, obb): |
|
|
"""Test the equity estimates forward_pe endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.estimates.forward_pe(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"provider": "sec", |
|
|
"symbol": "NVDA,AAPL,AMZN,MSFT,GOOG,SMCI", |
|
|
"fact": "RevenueFromContractWithCustomerExcludingAssessedTax", |
|
|
"year": 2024, |
|
|
"fiscal_period": None, |
|
|
"instantaneous": False, |
|
|
"use_cache": False, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"provider": "sec", |
|
|
"symbol": None, |
|
|
"fact": None, |
|
|
"year": None, |
|
|
"fiscal_period": None, |
|
|
"instantaneous": False, |
|
|
"use_cache": False, |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_compare_company_facts(params, obb): |
|
|
"""Test the equity compare company_facts endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.compare.company_facts(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,MSFT", |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL,MSFT", |
|
|
"start_date": None, |
|
|
"end_date": None, |
|
|
"provider": "intrinio", |
|
|
"interval": "week", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_historical_market_cap(params, obb): |
|
|
"""Test the equity historical market cap endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.historical_market_cap(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"date": None, |
|
|
"report_type": None, |
|
|
"provider": "sec", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_discovery_latest_financial_reports(params, obb): |
|
|
"""Test the equity discovery latest financial reports endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.discovery.latest_financial_reports(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"chamber": "all", |
|
|
"symbol": "AAPL", |
|
|
"provider": "fmp", |
|
|
"limit": None, |
|
|
} |
|
|
), |
|
|
( |
|
|
{ |
|
|
"symbol": None, |
|
|
"chamber": "all", |
|
|
"limit": 300, |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_ownership_government_trades(params, obb): |
|
|
"""Test the equity ownership government trades endpoint.""" |
|
|
params = {p: v for p, v in params.items() if v} |
|
|
|
|
|
result = obb.equity.ownership.government_trades(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"symbol": "AAPL", |
|
|
"calendar_year": 2024, |
|
|
"calendar_period": "Q2", |
|
|
"wrap_length": 120, |
|
|
"include_tables": False, |
|
|
"use_cache": True, |
|
|
"raw_html": False, |
|
|
"strategy": "trafilatura", |
|
|
"provider": "sec", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_fundamental_management_discussion_analysis(params, obb): |
|
|
"""Test the equity fundamental management discussion analysis endpoint.""" |
|
|
result = obb.equity.fundamental.management_discussion_analysis(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results.content) > 0 |
|
|
|
|
|
|
|
|
@parametrize( |
|
|
"params", |
|
|
[ |
|
|
( |
|
|
{ |
|
|
"start_date": "2024-01-07", |
|
|
"end_date": "2024-01-10", |
|
|
"provider": "fmp", |
|
|
} |
|
|
), |
|
|
], |
|
|
) |
|
|
@pytest.mark.integration |
|
|
def test_equity_calendar_events(params, obb): |
|
|
"""Test the equity calendar events endpoint.""" |
|
|
result = obb.equity.calendar.events(**params) |
|
|
assert result |
|
|
assert isinstance(result, OBBject) |
|
|
assert len(result.results) > 0 |
|
|
|
