Skip to content

Commit

Permalink
Add single widgets public endpoints examples (#6312)
Browse files Browse the repository at this point in the history
* Add single widgets public endpoints examples

* add couple more examples

* imrpove documentation

* update with video
  • Loading branch information
DidierRLopes authored Apr 15, 2024
1 parent 2c1e409 commit 326f239
Show file tree
Hide file tree
Showing 17 changed files with 126 additions and 103 deletions.
2 changes: 1 addition & 1 deletion website/content/pro/advanced-search.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Advanced Search
sidebar_position: 6
sidebar_position: 7
description: Learn about the functionality of the advanced search in OpenBB Terminal
Pro. Discover the six main categories including Securities, Templates, Widgets,
Actions, News, and the All option that enhances research and productivity.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Getting Started
sidebar_position: 0
title: Architecture
sidebar_position: 1
description: Get started with OpenBB Terminal Pro, your comprehensive tool for investment
research. Understand the layout and powerful features that can enhance your research
capabilities.
Expand All @@ -19,7 +19,7 @@ keywords:

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Getting Started | OpenBB Terminal Pro Docs" />
<HeadTitle title="Architecture | OpenBB Terminal Pro Docs" />

Welcome to the OpenBB Terminal Pro, your comprehensive tool for investment research.

Expand Down
6 changes: 3 additions & 3 deletions website/content/pro/copilot/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: OpenBB Copilot
sidebar_position: 7
sidebar_position: 8
description: Learn how to use OpenBB Copilot to interact with the OpenBB Terminal Pro
keywords:
- OpenBB Copilot
Expand Down Expand Up @@ -108,7 +108,7 @@ Sometimes you may wish to focus your analysis and utilize OpenBB Copilot to anal
a specific subset of widgets. For example, you may want to use OpenBB Copilot
is assist you in a deep analysis of an earnings transcript in the "Earnings
Transcript" widget, without retrieving data from the rest of the dashboard.

To achieve this, you can chat with specifically selected widgets by clicking on
the "Add widgets as context" button on each widget you wish to use while
querying OpenBB Copilot. Selecting a widget in this manner will make that
Expand Down Expand Up @@ -139,4 +139,4 @@ filenames that are descriptive of the data that they contain. For example, given
a PDF file containing a technical report from TSLA released in 2024, a good
filename would be `tsla_technical_report_2024.pdf`.

:::
:::
4 changes: 2 additions & 2 deletions website/content/pro/dashboards/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Dashboards",
"position": 5
}
"position": 6
}
2 changes: 1 addition & 1 deletion website/content/pro/data-connectors/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Data Connectors",
"position": 3
"position": 4
}
23 changes: 23 additions & 0 deletions website/content/pro/data-connectors/single-widget/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Endpoint Examples
sidebar_position: 1
description: Public API endpoints that can be used as single widget for Terminal Pro
keywords:
- Single Widget
- Data Connectors
- API Endpoints
- JSON
- Bring your own data
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Endpoint Examples | OpenBB Terminal Pro Docs" />

| Widget title | Public URL | Category | Subcategory | Source | Description |
| -------- | ------- | -------- | ------- | -------- | ------- |
| Protocols | https://api.llama.fi/v2/protocols | DeFi | TVL | DefiLLama | List of all protocols on DefiLlama along with their TVL |
| Historical Chain TVL | https://api.llama.fi/v2/historicalChainTvl | DeFi | TVL | DefiLLama | Get historical TVL (excludes liquid staking and double counted tvl) on DeFi on all chains |
| Chains | https://api.llama.fi/v2/chains | DeFi | TVL | DefiLLama | Get current TVL of all chains |
| Stablecoins | https://api.llama.fi/v2/stablecoins | DeFi | coins | DefiLLama | List all stablecoins along with their circulating amounts |
| TAO stats | https://taostats.io/data.json | Crypto | | Tao | Latest $TAO token and subnet information |
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Single widget
sidebar_position: 1
sidebar_position: 0
description: Learn how to use the Single Widget of OpenBB Terminal Pro for seamless
integration with your API Endpoints, enabling custom data to be fetched and displayed
in an accessible format. Includes features like additional headers and addressing
Expand Down
4 changes: 0 additions & 4 deletions website/content/pro/getting-started/_category_.json

This file was deleted.

41 changes: 0 additions & 41 deletions website/content/pro/getting-started/free-trial.md

This file was deleted.

49 changes: 5 additions & 44 deletions website/content/pro/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,66 +25,27 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="OpenBB Terminal Pro Docs" />

Discover the superior investment research capabilities of the OpenBB Terminal Pro. Built on top of the open-source OpenBB Terminal, our platform provides a sleek graphical interface that is intuitive and fully customizable, making it easier for you to access and analyze financial information with ease.
Investment research tech is stuck in the 80s and limits what you can do. With the Terminal Pro, you can bring your own data and use AI to quickly extract insights from it.

<div className="flex-grow flex items-center justify-center mt-5">
<a href="https://my.openbb.co/app/pro">
<a href="https://pro.openbb.co/register">
<button
className="bg-grey-200 hover:bg-grey-400 dark:bg-[#303038] dark:hover:bg-grey-600 text-grey-900 dark:text-grey-200 text-sm font-medium py-2 px-4 rounded"
>
Join Terminal Pro waitlist
TRY IT TODAY
</button>
</a>
</div>

Plus, with built-in access to high-quality financial data curated from official partnerships with data providers, you can conduct comprehensive analysis and gain valuable insights that inform your investment decisions.
Gain an edge in the market, start the 3-week free trial now. No credit cards required.

<div style={{position: 'relative', paddingBottom: '56.25%', height: '0', overflow: 'hidden', maxWidth: '100%'}}>
<iframe
style={{position: 'absolute', top: '0', left: '0', width: '100%', height: '100%', display: 'block', margin: '0 auto'}}
src="https://www.youtube.com/embed/hz12c9HuQvc?si=S12Qkt1PN506NZpj"
src="https://www.youtube.com/embed/AnyQH0HkZ2M?si=5knf2RYD4CuqZkW8"
title="YouTube video player"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen>
</iframe>
</div>


---

- **Improved User Experience**

We've focused on improving the user experience (UX) of the OpenBB Terminal Pro based on feedback from dozens of users. The platform features a better user interface that is visually appealing, while keeping the keyboard-centric workflow of the OpenBB Terminal for quick and efficient information access.

- **Customizable and Collaborative**

Unlike traditional investment research dashboards, the OpenBB Terminal Pro is a fully integrated and customizable environment that allows you to optimize your workflow to your preferences. Plus, take advantage of advanced collaboration features to share insights, exchange ideas, and make informed decisions with your team in real time.

- **Built-in access to high-quality financial data**

The OpenBB Terminal Pro is powered by an extensive data marketplace that allows you to make use of any dataset that exists. With an abundance of data at your fingertips, you can conduct a comprehensive analysis and gain valuable insights that inform your investment decisions. You can subscribe to only the datasets you need and access the raw data for deeper analysis, whether you're looking for financial, economic, or market data.

---

## Features

### Bring your own data

The OpenBB Terminal Pro allows professionals to bring any data into their research environment. Whether that is a .csv file, a private endpoint, a RSS feed or even embed a SEC filing directly. The only limit is the user's creativity.

### Your terminal, your whiteboard

The OpenBB Terminal Pro is the most flexible investment research platform. It allows users to create their preferred dashboards with their preferred widgets. Never be limited again by what a platform allows you to create.

### Generative AI to summarize content

Our most popular feature includes chatting with financial data through state-of-the-art large language models (LLMs). For instance, instead of spending minutes reading news articles or hours reading earnings transcripts, create a summary in seconds and ask how that impacts your investments.

### Build investment research reports in seconds

The OpenBB Terminal Pro allows to add notes next to each widget and render the tab into a custom report that can be used to share with the team or manager., share with team

### Create charts from raw data

The OpenBB Terminal Pro allows to create charts directly from raw data in seconds. This effectively increases user efficiency by 10x, as visual insights are much more powerful.
4 changes: 4 additions & 0 deletions website/content/pro/templates/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Templates",
"position": 3
}
28 changes: 28 additions & 0 deletions website/content/pro/templates/excel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Excel Templates
sidebar_position: 2
description: Download Excel templates that OpenBB makes available
to your organization so you can fully automate your workflow.
keywords:
- Excel Add-In
- Automation
- Workflow
- Download
- Modeling
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Excel Templates | OpenBB Terminal Pro Docs" />

When navigating to the Templates page and clicking on the Excel tab, this is what the user will be able to see. As you can see from the image below, the user will be able to see a list of Excel templates that have been created by the OpenBB team and that leverage our Add-in for Excel to automate financial workflows.

<img className="pro-border-gradient" width="800" alt="charting" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/cd3cc552-8102-43d1-9af6-e9775b257c23" />

Once clicking on "Download Template" (e.g. for "Equity Analysis"), users will be able to access an Excel spreadsheet like the one shown below.

If you have your OpenBB Add-in for Excel installed (instructions [here](/excel/getting-started/installation)) you will be able to change a ticker on the spreadsheet and all the values are automatically updated.

<img className="pro-border-gradient" width="800" alt="charting" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/80253a0f-7673-4f26-a713-9807d518d4e3" />

More templates will be added in the next few weeks.
34 changes: 34 additions & 0 deletions website/content/pro/templates/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Templates
sidebar_position: 0
description: This page allows users to manage their Terminal Pro and Excel templates.
keywords:
- Templates
- Terminal Pro
- Excel Add-in
- Automated
- Download
---

<!-- markdownlint-disable MD012 MD031 MD033 -->
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Templates | OpenBB Terminal Pro Docs" />

import NewReferenceCard from "@site/src/components/General/NewReferenceCard";

<ul className="grid grid-cols-1 gap-4 -ml-6">

<NewReferenceCard
title="Create a custom report"
description="In this guide, learn how to create a custom report using OpenBB Terminal Pro, including creating a new dashboard, adding widgets, creating a group, and exporting to PDF."
url="/pro/templates/pro"
/>

<NewReferenceCard
title="Layouts and Watchlist"
description="In this workflow you will create a new dashboard from the analyst template, add a new ticker to the Watchlist and then change the selection to the newly added ticker."
url="/pro/templates/excel"
/>

</ul>
18 changes: 18 additions & 0 deletions website/content/pro/templates/pro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Terminal Pro Templates
sidebar_position: 1
description: Manage your organization's Terminal Pro templates
from this page.
keywords:
- Terminal Pro
- Templates
- Dashboard
- Widgets
- Sharing
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Terminal Pro Templates | OpenBB Terminal Pro Docs" />

Coming soon.
2 changes: 1 addition & 1 deletion website/content/pro/tutorials/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Tutorials",
"position": 10
"position": 0
}
2 changes: 1 addition & 1 deletion website/content/pro/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Tutorials
sidebar_position: 0
sidebar_position: -1
description: Learn about common workflows that you can do with the OpenBB Terminal Pro.
keywords:
- workflows
Expand Down
2 changes: 1 addition & 1 deletion website/content/pro/widgets/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Widgets",
"position": 4
"position": 5
}

0 comments on commit 326f239

Please sign in to comment.