Market Sentiment App User Guide
Overview
Welcome to the Market Sentiment Application – your comprehensive tool for tracking stock tickers, analyzing market sentiment, managing watchlists/portfolios, and staying informed with real-time news articles. This guide covers all major features and user flows available in the application.
Key Features
- Trending Content: View trending tickers and topics from the current week
- Market Sentiment Analysis: Track positive/negative/neutral sentiment across tickers and articles
- Watchlist Management: Create, edit, and manage personalized portfolios of tickers you follow
- News Feed: Browse filtered news articles by date, sentiment, sector, industry, and more
- Notifications: Stay updated with alerts about your watchlists and market activity
Main User Flows
1. Viewing Trending Content
Purpose: Discover the most discussed tickers and topics in the market over the last week.
Steps:
- Launch the application to land on the Trending screen by default
- Scroll through the list of TRENDING TICKERS (e.g., COHR, WTI, BBY)
- View sentiment indicators (Positive/Negative) for each ticker
- Browse TRENDING TOPICS such as "Depreciation Amortization GAAP Tax" or "Pepsi Consumers Marketing Restaurant"
- Tap "Show more >" to expand the list of trending items
Notes:
- Trending data reflects tickers appearing most frequently in articles over the last week
- Sentiment indicators provide quick visual cues about market perception
2. Managing Watchlists (Portfolios)
Purpose: Create and manage personalized lists of tickers you want to track.
Steps:
- Navigate to Watchlists from the main menu or bottom navigation bar
- If no watchlists exist, tap the "+" icon to create a new portfolio
- On the New Watchlist screen: - Enter a name (e.g., "My favourite tickers") - Optionally add a description
- Tap "Create" to save your new watchlist
- To edit an existing watchlist: - Tap the pencil icon on the portfolio header - Modify the name or description as needed
- To delete a watchlist: - Open the watchlist details - Tap "Delete Watchlist" button
Prerequisites:
- User must be logged in to create/edit portfolios
3. Adding Tickers to Watchlists
Purpose: Add specific stock tickers to your personalized watchlists.
Steps:
- Open a watchlist (e.g., "Portfolio1") from the Watchlists screen
- Tap the "+" button or "Add Ticker" action
- On the Ticker Search Results screen: - Use the search bar to find tickers by symbol or name - Browse available tickers (e.g., "Tesla", "TSLA")
- Select a ticker from the results list
- Tap "Add to the watchlist" button with the "+" icon
Alternative Method:
- Search for tickers directly in the Watchlists screen using the search bar
- Tap on a ticker result and select your desired portfolio
4. Reading News Articles with Filters
Purpose: Browse and filter news articles based on multiple criteria.
Steps:
- Navigate to News from the bottom navigation bar
- The default view shows recent articles (e.g., "China Gifts", "Dianhong tea")
- Tap "Open Menu" or access the filter options
- On the Articles Filter screen, configure filters: - DATE FROM: Set start date for article range - DATE TO: Set end date for article range - SENTIMENT: Select Positive/Negative/Neutral - TICKERS: Choose specific tickers to filter by - SECTORS: Filter by sector (e.g., Technology, Energy) - INDUSTRIES: Filter by industry classification - SOURCE: Filter by news source/domain
- Tap "Clear" to reset all filters
- Browse the filtered article feed
Notes:
- All filter parameters use "AND" logic when combined
- Filters are optional; leave empty for full feed results
5. Checking Notifications
Purpose: View and manage notifications about your watchlists, market updates, and app activity.
Steps:
- Tap the Notifications Bell Icon from any screen or bottom navigation
- Review the list of received notifications
- To mark a notification as read: - Open the notification details - Use the appropriate action to update status (if available)
- Navigate back using the "Back" button
Empty State:
- If no notifications exist, you will see: "No received notifications yet"
6. Analyzing Market Sentiment
Purpose: View sentiment analysis across tickers and articles.
Steps:
- From any screen, tap on a ticker (e.g., COHR) to view its details
- Scroll to the COHR RELATED ARTICLES section
- Review article summaries with sentiment indicators (POSITIVE/NEUTRAL)
- Tap "Trending" tab to see trending tickers with sentiment breakdowns
Sentiment Filter Screen:
- Access via filter menu or dedicated sentiment view
- Select sentiment type: Positive, Negative, or Neutral
- Tap "Cancel" to exit without applying filters
7. Creating and Editing Portfolios
Purpose: Manage multiple watchlists with different purposes (e.g., "My favourite tickers", sector-specific lists).
Steps for Creation:
- Go to Watchlists screen
- Tap the "+" icon in the top right corner
- On New Watchlist screen: - Enter a descriptive name - Add optional description (e.g., "My favourite tickers")
- Tap "Create" button
Steps for Editing:
- Open an existing portfolio from the list
- Tap the pencil icon (Edit Portfolio) on the header
- Modify watchlist name or description
- Tap "Save" to confirm changes
Steps for Deletion:
- Open the portfolio you want to remove
- Scroll to find and tap "Delete Watchlist" button
- Confirm deletion if prompted
Screen Reference
Trending
Purpose: Display trending tickers and topics from the current week with sentiment indicators.
| Category | Details |
|---|---|
| Visible Information | TRENDING TICKERS list, Sentiment (Positive/Negative), TRENDING TOPICS section |
| Input Fields | None (read-only display) |
| Available Actions | Show more >, Notifications bell icon |
| Related API Endpoints | - GET /tickers/trend – Fetches trending tickers list- GET /topics/ – Retrieves current week topics |
Market Sentiment - Positive Tab
Purpose: View positive sentiment tickers and their related articles.
| Category | Details |
|---|---|
| Visible Information | POSITIVE TICKERS list, Related articles with timestamps (e.g., "8 hours ago") |
| Input Fields | None (read-only display) |
| Available Actions | Show more >, Notifications bell icon, Tab navigation (Trending/News/Watchlist/Profile) |
| Related API Endpoints | - GET /tickers/trend – Loads trending tickers filtered by sentiment- GET /tickers/trend/articles – Fetches related articles for each ticker |
Notifications
Purpose: Display all notifications received by the user.
| Category | Details |
|---|---|
| Visible Information | Notification list, Empty state message ("No received notifications yet") |
| Input Fields | None (read-only display) |
| Available Actions | Back button to return to previous screen |
| Related API Endpoints | - GET /notifications/ – Retrieves all user notifications- GET /notifications/unread – Gets count of unread notifications- PATCH /notifications/{notification_id} – Marks notification as read/unread |
Portfolio1 (Watchlist Detail)
Purpose: View and manage a specific watchlist/portfolio with its tickers.
| Category | Details |
|---|---|
| Visible Information | Watchlist name, Tickers list (e.g., "TSLA", "Tesla, Inc."), Sentiment tabs, Article sections |
| Input Fields | None (read-only display) |
| Available Actions | Edit Portfolio, Add Ticker, Tab navigation (Mentions/Articles/Socials/Trending/News/Watchlist/Profile) |
| Related API Endpoints | - GET /tickers/portfolios/{portfolio_id} – Fetches portfolio details- PUT /tickers/portfolios/{portfolio_id} – Updates portfolio information- DELETE /tickers/portfolios/{portfolio_id} – Deletes the portfolio |
Add Ticker
Purpose: Search for and select tickers to add to a watchlist.
| Category | Details |
|---|---|
| Visible Information | Search bar with placeholder "Search tickers" |
| Input Fields | Search tickers (text input) |
| Available Actions | Back button, Search icon |
| Related API Endpoints | - GET /tickers/ – Populates search results with available tickers |
News
Purpose: Browse news articles with category tabs and sentiment indicators.
| Category | Details |
|---|---|
| Visible Information | Articles list, Categories (Articles/Analysis/Earnings/Socials), Sentiment badges (POSITIVE/NEUTRAL) |
| Input Fields | None (read-only display) |
| Available Actions | Open Menu button for filter access |
| Related API Endpoints | - GET /articles/ – Retrieves articles feed- GET /rapid-api/articles/{id}/summary – Gets article sentiment summary |
Articles Filter
Purpose: Configure filtering options for the news feed.
| Category | Details |
|---|---|
| Visible Information | Filter fields: DATE FROM, DATE TO, SENTIMENT, TICKERS, SECTORS, INDUSTRIES, SOURCE |
| Input Fields | All filter fields (selectable dropdowns/text inputs) |
| Available Actions | Clear button, Add (+) button to expand more options |
| Related API Endpoints | - GET /articles/ – Fetches filtered articles feed- GET /tickers/ – Populates TICKERS filter options- GET /sectors/ – Populates SECTORS filter options- GET /industries/ – Populates INDUSTRIES filter options- GET /sentiment/ – Provides sentiment values for filter |
Sentiment (Filter Screen)
Purpose: Select sentiment type for filtering articles or tickers.
| Category | Details |
|---|---|
| Visible Information | Sentiment options: Positive, Negative, Neutral |
| Input Fields | None (selection buttons only) |
| Available Actions | Cancel button to exit without applying filter |
| Related API Endpoints | - GET /sentiment/ – Retrieves sentiment list with chronological counts |
Watchlists (List View)
Purpose: Display all created watchlists/portfolios and create new ones.
| Category | Details |
|---|---|
| Visible Information | List of portfolios, Empty state message ("Add your first watchlist"), Search bar |
| Input Fields | Search tickers (for adding to existing portfolio) |
| Available Actions | Create new portfolio (+), Watchlist navigation buttons |
| Related API Endpoints | - GET /tickers/portfolios – Retrieves all user portfolios- POST /tickers/portfolios – Creates a new portfolio- GET /tickers/ – Populates search bar for ticker selection |
New Watchlist (Create Screen)
Purpose: Create a new watchlist/portfolio.
| Category | Details |
|---|---|
| Visible Information | Input fields: Watchlist name, Description (optional) |
| Input Fields | Watchlist name (required), Description (optional text input) |
| Available Actions | Close button, Create button to save new portfolio |
| Related API Endpoints | - POST /tickers/portfolios – Creates the new portfolio with provided details |
Portfolio1_2 (Watchlist with Tickers)
Purpose: View a populated watchlist with ticker information.
| Category | Details |
|---|---|
| Visible Information | Watchlist name, Tickers list (e.g., "TSLA", "Tesla, Inc."), Sentiment tabs, Article sections |
| Input Fields | None (read-only display) |
| Available Actions | Edit Watchlist, Add Ticker, Tab navigation |
| Related API Endpoints | - GET /tickers/portfolios/{portfolio_id} – Retrieves portfolio details- GET /tickers/portfolios/tickers-list – Fetches tickers in the portfolio- PUT /tickers/portfolios/{portfolio_id} – Updates watchlist details |
Edit Portfolio1
Purpose: Modify an existing watchlist's name and description.
| Category | Details |
|---|---|
| Visible Information | Current watchlist name, Description field, Tickers list |
| Input Fields | Watchlist name (editable), Description (optional text input) |
| Available Actions | Save button, Delete Watchlist button, Minus icon, Menu icon |
| Related API Endpoints | - GET /tickers/portfolios/{portfolio_id} – Loads current portfolio data- PUT /tickers/portfolios/{portfolio_id} – Saves updated information- DELETE /tickers/portfolios/{portfolio_id} – Removes the watchlist |
Ticker Search Results
Purpose: Display search results when looking for tickers to add.
| Category | Details |
|---|---|
| Visible Information | List of ticker symbols and names (e.g., "Tesla") |
| Input Fields | None (read-only display) |
| Available Actions | Cancel button to exit search |
| Related API Endpoints | - GET /tickers/ – Fetches the list of available tickers for selection |
Add to the Watchlist
Purpose: Confirm adding a ticker to a selected watchlist.
| Category | Details |
|---|---|
| Visible Information | Ticker information, Portfolio name (e.g., "Portfolio1") |
| Input Fields | None (read-only display) |
| Available Actions | Add (+) button to confirm addition, Back button to return |
| Related API Endpoints | - GET /tickers/portfolios – Loads portfolio list for selection- PUT /tickers/portfolios/{portfolio_id} – Updates portfolio state with added ticker |
Profile
Purpose: Access user account settings and preferences.
| Category | Details |
|---|---|
| Visible Information | User profile section, Account options (Change password, Delete account, Log out) |
| Input Fields | None (read-only display) |
| Available Actions | Settings, Feedback, About app, Change password, Delete account, Log out |
| Related API Endpoints | No matching endpoints found in candidate list for Profile/Settings actions. These may be handled via backend services not exposed through the public API. |
Settings
Purpose: Configure application preferences including color mode.
| Category | Details |
|---|---|
| Visible Information | COLOR MODE options (System/Light/Dark), Navigation tabs |
| Input Fields | None (selection buttons only) |
| Available Actions | Back navigation, Tab switching (Trending/News/Watchlist/Profile) |
| Related API Endpoints | No matching endpoint found for Settings/Color Mode update in candidate list. This feature may be handled via local storage or backend services not exposed through the public API. |
Glossary
| Term | Definition |
|---|---|
| Ticker | A stock symbol representing a publicly traded company (e.g., TSLA, COHR) |
| Portfolio/Watchlist | A user-created collection of tickers for tracking purposes |
| Sentiment | Market sentiment classification: Positive, Negative, or Neutral based on article analysis |
| Articles Feed | Curated news articles about tickers with associated metadata and sentiment scores |
| Topics | Current trending discussion themes from the past week (e.g., "Depreciation Amortization GAAP Tax") |
| Mentions | Articles that reference a specific ticker in their content |
Limitations / Notes
-
API Endpoint Availability: Some screen actions (Profile settings, Color Mode) do not have corresponding public API endpoints. These features may be handled through local storage or backend services not exposed via the documented API.
-
Filter Logic: All filter parameters in article feeds use "AND" logic when multiple filters are applied simultaneously.
-
Trending Data: Trending tickers and topics reflect activity from the last week only. Historical trending data is not available through the current endpoints.
-
Portfolio Management: Creating, editing, or deleting portfolios requires user authentication. Unauthenticated users will not be able to access portfolio management features.
-
Sentiment Analysis: Sentiment scores are calculated based on article content analysis and may vary as new articles are published.
-
Export Functionality: The application supports background export of sentiment time series data via
POST /tickers/sentiment/export. This returns an export_id immediately for later retrieval. -
Pagination: List endpoints support pagination through
pageandlimitquery parameters where applicable.