OpenBB/openbb_terminal/common/behavioural_analysis/stocktwits_model.py

"""Stocktwits Model"""
__docformat__ = "numpy"

import logging
from typing import Any, Dict, List, Tuple

import pandas as pd
import requests

from openbb_terminal.decorators import log_start_end

logger = logging.getLogger(__name__)


@log_start_end(log=logger)
def get_bullbear(symbol: str) -> Tuple[int, int, int, int]:
    """Gets bullbear sentiment for ticker [Source: stocktwits].

    Parameters
    ----------
    symbol : str
        Ticker symbol to look at

    Returns
    -------
    Tuple[int, int, int, int]
        Watchlist count,
        Number of cases found for ticker,
        Number of bullish statements,
        Number of bearish statements,
    """
    result = requests.get(
        f"https://api.stocktwits.com/api/2/streams/symbol/{symbol}.json"
    )
    if result.status_code == 200:
        result_json = result.json()
        watchlist_count = result_json["symbol"]["watchlist_count"]
        n_cases = 0
        n_bull = 0
        n_bear = 0
        for message in result_json["messages"]:
            if message["entities"]["sentiment"]:
                n_cases += 1
                n_bull += message["entities"]["sentiment"]["basic"] == "Bullish"
                n_bear += message["entities"]["sentiment"]["basic"] == "Bearish"

        return watchlist_count, n_cases, n_bull, n_bear
    return 0, 0, 0, 0


@log_start_end(log=logger)
def get_messages(symbol: str, limit: int = 30) -> pd.DataFrame:
    """Get last messages for a given ticker [Source: stocktwits].

    Parameters
    ----------
    symbol : str
        Stock ticker symbol
    limit : int
        Number of messages to get

    Returns
    -------
    pd.DataFrame
        Dataframe of messages
    """
    result = requests.get(
        f"https://api.stocktwits.com/api/2/streams/symbol/{symbol}.json"
    )
    if result.status_code == 200:
        return pd.DataFrame(
            [message["body"] for message in result.json()["messages"][:limit]]
        )

    return pd.DataFrame()


@log_start_end(log=logger)
def get_trending() -> pd.DataFrame:
    """Get trending tickers from stocktwits [Source: stocktwits].

    Returns
    -------
    pd.DataFrame
        Dataframe of trending tickers and watchlist count
    """
    result = requests.get("https://api.stocktwits.com/api/2/trending/symbols.json")
    if result.status_code == 200:
        l_symbols = [
            [symbol["symbol"], symbol["watchlist_count"], symbol["title"]]
            for symbol in result.json()["symbols"]
        ]

        df_trending = pd.DataFrame(
            l_symbols, columns=["Ticker", "Watchlist Count", "Name"]
        )
        return df_trending

    return pd.DataFrame()


@log_start_end(log=logger)
def get_stalker(user: str, limit: int = 30) -> List[Dict[str, Any]]:
    """Gets messages from given user [Source: stocktwits].

    Parameters
    ----------
    user : str
        User to get posts for
    limit : int, optional
        Number of posts to get, by default 30

    Returns
    -------
    List[Dict[str, Any]]
        List of posts
    """
    result = requests.get(f"https://api.stocktwits.com/api/2/streams/user/{user}.json")
    if result.status_code == 200:
        return list(result.json()["messages"][:limit])

    return []