test_tickers.py

from polygon.rest.models import (
    Ticker,
    TickerDetails,
    TickerNews,
    TickerTypes,
    TickerChangeEvent,
    TickerChangeResults,
    Publisher,
    Branding,
    CompanyAddress,
)
from base import BaseTest


class TickersTest(BaseTest):
    def test_list_tickers(self):
        tickers = [t for t in self.c.list_tickers()]
        expected = [
            Ticker(
                active=True,
                cik="0001090872",
                composite_figi="BBG000C2V3D6",
                currency_name="usd",
                currency_symbol=None,
                base_currency_symbol=None,
                base_currency_name=None,
                delisted_utc=None,
                last_updated_utc="2022-04-27T00:00:00Z",
                locale="us",
                market="stocks",
                name="Agilent Technologies Inc.",
                primary_exchange="XNYS",
                share_class_figi="BBG001SCTQY4",
                ticker="A",
                type="CS",
            ),
            Ticker(
                active=True,
                cik="0001675149",
                composite_figi="BBG00B3T3HD3",
                currency_name="usd",
                currency_symbol=None,
                base_currency_symbol=None,
                base_currency_name=None,
                delisted_utc=None,
                last_updated_utc="2022-04-27T00:00:00Z",
                locale="us",
                market="stocks",
                name="Alcoa Corporation",
                primary_exchange="XNYS",
                share_class_figi="BBG00B3T3HF1",
                ticker="AA",
                type="CS",
            ),
            Ticker(
                active=True,
                cik=None,
                composite_figi="BBG00X5FSP48",
                currency_name="usd",
                currency_symbol=None,
                base_currency_symbol=None,
                base_currency_name=None,
                delisted_utc=None,
                last_updated_utc="2022-04-27T00:00:00Z",
                locale="us",
                market="stocks",
                name="AAF First Priority CLO Bond ETF",
                primary_exchange="ARCX",
                share_class_figi="BBG00X5FSPZ4",
                ticker="AAA",
                type="ETF",
            ),
            Ticker(
                active=True,
                cik="0001708646",
                composite_figi="BBG00LPXX872",
                currency_name="usd",
                currency_symbol=None,
                base_currency_symbol=None,
                base_currency_name=None,
                delisted_utc=None,
                last_updated_utc="2022-04-27T00:00:00Z",
                locale="us",
                market="stocks",
                name="Goldman Sachs Physical Gold ETF Shares",
                primary_exchange="BATS",
                share_class_figi="BBG00LPXX8Z1",
                ticker="AAAU",
                type="ETF",
            ),
        ]
        self.assertEqual(tickers, expected)

    def test_get_ticker_details(self):
        details = self.c.get_ticker_details("AAPL")
        expected = TickerDetails(
            active=True,
            address=CompanyAddress(
                address1="ONE APPLE PARK WAY",
                city="CUPERTINO",
                state="CA",
                postal_code="95014",
            ),
            branding=Branding(
                icon_url="https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-05-01_icon.png",
                logo_url="https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-05-01_logo.svg",
            ),
            cik="0000320193",
            composite_figi="BBG000B9XRY4",
            currency_name="usd",
            delisted_utc=None,
            description="Apple designs a wide variety of consumer electronic devices, including smartphones (iPhone), tablets (iPad), PCs (Mac), smartwatches (Apple Watch), AirPods, and TV boxes (Apple TV), among others. The iPhone makes up the majority of Apple's total revenue. In addition, Apple offers its customers a variety of services such as Apple Music, iCloud, Apple Care, Apple TV+, Apple Arcade, Apple Card, and Apple Pay, among others. Apple's products run internally developed software and semiconductors, and the firm is well known for its integration of hardware, software and services. Apple's products are distributed online as well as through company-owned stores and third-party retailers. The company generates roughly 40% of its revenue from the Americas, with the remainder earned internationally.",
            ticker_root="AAPL",
            homepage_url="https://www.apple.com",
            list_date="1980-12-12",
            locale="us",
            market="stocks",
            market_cap=2488795282370,
            name="Apple Inc.",
            phone_number="(408) 996-1010",
            primary_exchange="XNAS",
            share_class_figi="BBG001S5N8V8",
            share_class_shares_outstanding=16319440000,
            sic_code="3571",
            sic_description="ELECTRONIC COMPUTERS",
            ticker="AAPL",
            total_employees=154000,
            type="CS",
            weighted_shares_outstanding=16185181000,
        )
        self.assertEqual(details, expected)

        expected.market_cap = 1916103105630
        details = self.c.get_ticker_details("AAPL", date="2020-10-01")

        self.assertEqual(details, expected)

    def test_list_ticker_news(self):
        news = [t for t in self.c.list_ticker_news("NFLX")]
        expected = [
            TickerNews(
                amp_url="https://www.marketwatch.com/amp/story/theres-a-big-hole-in-the-feds-theory-of-inflationincomes-are-falling-at-a-record-10-9-rate-11651165705",
                article_url="https://www.marketwatch.com/story/theres-a-big-hole-in-the-feds-theory-of-inflationincomes-are-falling-at-a-record-10-9-rate-11651165705",
                author="MarketWatch",
                description="If inflation is all due to an overly generous federal government giving its people too much money, then our inflation problem is about to go away.",
                id="JeJEhAVoKaqJ2zF9nzQYMg07UlEeWlis6Dsop33TPQY",
                image_url="https://images.mktw.net/im-533637/social",
                keywords=None,
                published_utc="2022-04-28T17:08:00Z",
                publisher=Publisher(
                    favicon_url="https://s3.polygon.io/public/assets/news/favicons/marketwatch.ico",
                    homepage_url="https://www.marketwatch.com/",
                    logo_url="https://s3.polygon.io/public/assets/news/logos/marketwatch.svg",
                    name="MarketWatch",
                ),
                tickers=["MSFT", "TSN", "NFLX", "AMZN"],
                title="Theres a big hole in the Feds theory of inflation—incomes are falling at a record 10.9 rate",
            )
        ]
        self.assertEqual(news, expected)

    def test_get_ticker_types(self):
        types = self.c.get_ticker_types("stocks")
        expected = [
            TickerTypes(
                asset_class="stocks", code="CS", description="Common Stock", locale="us"
            ),
            TickerTypes(
                asset_class="stocks",
                code="PFD",
                description="Preferred Stock",
                locale="us",
            ),
            TickerTypes(
                asset_class="stocks", code="WARRANT", description="Warrant", locale="us"
            ),
            TickerTypes(
                asset_class="stocks", code="RIGHT", description="Rights", locale="us"
            ),
            TickerTypes(
                asset_class="stocks",
                code="BOND",
                description="Corporate Bond",
                locale="us",
            ),
            TickerTypes(
                asset_class="stocks",
                code="ETF",
                description="Exchange Traded Fund",
                locale="us",
            ),
            TickerTypes(
                asset_class="stocks",
                code="ETN",
                description="Exchange Traded Note",
                locale="us",
            ),
            TickerTypes(
                asset_class="stocks",
                code="SP",
                description="Structured Product",
                locale="us",
            ),
            TickerTypes(
                asset_class="stocks",
                code="ADRC",
                description="American Depository Receipt Common",
                locale="us",
            ),
            TickerTypes(
                asset_class="stocks",
                code="ADRW",
                description="American Depository Receipt Warrants",
                locale="us",
            ),
            TickerTypes(
                asset_class="stocks",
                code="ADRR",
                description="American Depository Receipt Rights",
                locale="us",
            ),
            TickerTypes(
                asset_class="stocks", code="FUND", description="Fund", locale="us"
            ),
            TickerTypes(
                asset_class="stocks", code="BASKET", description="Basket", locale="us"
            ),
            TickerTypes(
                asset_class="stocks", code="UNIT", description="Unit", locale="us"
            ),
            TickerTypes(
                asset_class="stocks",
                code="LT",
                description="Liquidating Trust",
                locale="us",
            ),
        ]

        self.assertEqual(types, expected)

    def test_get_ticker_events_ticker_change(self):
        events = self.c.get_ticker_events(ticker="META", types="ticker_change")
        expected = TickerChangeResults(
            name="Meta Platforms, Inc. Class A Common Stock",
            composite_figi="BBG000MM2P62",
            cik="0001326801",
            events=[
                {
                    "ticker_change": {"ticker": "META"},
                    "type": "ticker_change",
                    "date": "2022-06-11",
                },
                {
                    "ticker_change": {"ticker": "FB"},
                    "type": "ticker_change",
                    "date": "2012-05-18",
                },
            ],
        )

        self.assertEqual(expected, events)