Vyfin Documentation

Quick Start

1. Launch the app and sign in. A starter watchlist titled Starter Watchlist is already available.

2. Click Load beside this watchlist. The network will render using two default filters: Market Cap and Beta. These metrics provide a balanced view of company size and volatility.

3. Explore the sidebar on the left to see all companies that meet the criteria. Selecting a name highlights its node and opens the tooltip.

4. Press the Chart button in the tooltip to examine recent price action along with RSI, MACD, and 50‑, 100‑, and 200‑day moving averages. Use these indicators to gauge momentum before deciding whether to modify your watchlist.

5. Adjust thresholds or add additional metrics using the filter controls. Hit Update Visualization to refresh the network, then choose Add Watchlist to preserve your configuration.

This quick start flow demonstrates how the base watchlist acts as a jumping-off point. From here you can expand to sector‑specific lists or more advanced screening strategies, all while keeping the chart and sidebar tools at your fingertips.

Overview

Welcome to the Vyfin documentation. This guide explains how market data is transformed into interactive networks and how to navigate the interface. The following sections walk through the full workflow so new users can understand both the concepts and the controls used in the platform.

Vyfin blends traditional fundamentals with network science. Data that would typically sit isolated on a balance sheet is converted into connections and communities, allowing investors to see which companies resemble one another and where clusters form. Exploring these connections begins with understanding how the application gathers information and how it surfaces that information in the browser.

Data Pipeline

Company fundamentals are aggregated from our databases and served through REST endpoints. The application requests available metrics from /columns and metric ranges from /column-data/<metric>. These endpoints fuel every visualization. When a user adds a filter for Market Cap or Beta, the client pulls historical minimums, maximums, and percentile breakpoints to populate the form fields automatically.

Behind the scenes, a scheduled job refreshes these metrics so the ranges stay current with the most recent filings. Each time a visualization is requested the backend assembles a data set that respects the user’s filters before handing the results to the network generator.

Network Generation

Nodes represent companies and related entities. Links are created when entities share relationships derived from the underlying data. Communities are detected algorithmically and used to color nodes. The force‑directed layout positions highly connected firms near the center while sparsely connected names sit toward the perimeter.

The community assignments are produced by a modularity‑based algorithm that clusters firms with similar fundamentals. Each company receives a numerical community id that maps to a color on the graph.

The accompanying sidebar lists every company rendered in the graph. Clicking a name in this list highlights the corresponding node and dims unrelated firms, making it easy to focus on one entity at a time. Hovering over nodes also triggers a detailed tooltip that contains descriptive statistics and the chart button.

Color Legend

Each community is assigned a distinct color. These shades help identify clusters within the market. Non-company nodes use a neutral gray tone. Because communities are calculated dynamically, the palette provides a quick visual hint about which companies share similar characteristics. Exploring how colors group can reveal potential sector rotations or emerging themes in the market.

Purple nodes fall into communities at the high end of the scale, typically representing tightly connected clusters. Blue tones mark lower indexed groups that often sit on the periphery or bridge between larger clusters. Orange nodes occupy the lowest range of the scale. As filters change, communities and their colors update to reflect the new landscape.

Filter Fields

Every filter contains four numeric fields:

• Small Threshold – lower bound for the small category.
• Medium Threshold – upper bound for medium sized results.
• Min Value – minimum value permitted.
• Max Value – maximum value permitted.

Default values are auto-filled using historical ranges (minimum, one‑third, two‑thirds and maximum) for the chosen metric. Users can freely adjust these numbers to tighten or broaden their search. After applying a set of filters, the Update Visualization button redraws the network to reflect the new criteria.

User Interactions

Left click a node to highlight it and view its details. Right click also focuses the node. Ctrl + click opens the company’s Yahoo Finance page in a new tab. Clicking the background clears the selection. The tooltip that appears when a company is selected includes a Chart button. Pressing it launches an expanded price chart populated with RSI, MACD, and three moving averages so that technical context is available without leaving the page.

The tooltip behaves like a miniature sidebar. It is anchored within the network so it does not drift over the watchlist when the page is scrolled. This design keeps the primary controls focused on the visualization while still offering quick access to key details.

Managing Watchlists

Above the watchlist table use Add Watchlist to create a new list based on the currently applied filters. Each row shows how many companies satisfy the saved criteria. Selecting Load on any row re-applies its filters and redraws the network. The Share option copies a JSON representation of the watchlist so it can be sent to another user.