-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add single widgets public endpoints examples (#6312)
* Add single widgets public endpoints examples * add couple more examples * imrpove documentation * update with video
- Loading branch information
1 parent
2c1e409
commit 326f239
Showing
17 changed files
with
126 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{ | ||
"label": "Dashboards", | ||
"position": 5 | ||
} | ||
"position": 6 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
23
website/content/pro/data-connectors/single-widget/examples.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | |
2 changes: 1 addition & 1 deletion
2
...tent/pro/data-connectors/single-widget.md → ...ro/data-connectors/single-widget/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Templates", | ||
"position": 3 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{ | ||
"label": "Tutorials", | ||
"position": 10 | ||
"position": 0 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{ | ||
"label": "Widgets", | ||
"position": 4 | ||
"position": 5 | ||
} |