jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 16:02:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/gov/contracts.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

2.4 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
contracts This documentation contains the details of two functions, 'contracts' and 'contracts_chart', that are used to retrieve trading data of U.S. government contracts for specific ticker from 'quiverquant.com'. It explains the parameters and return type of the functions, and provides links to the source code.
contracts
contracts_chart
quiverquant.com
government contracts
trading data
parameters

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

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Get government contracts for ticker [Source: quiverquant.com]

Source Code: [link]

openbb.stocks.gov.contracts(symbol: str, past_transaction_days: int = 10)

Parameters

Name Type Description Default Optional
symbol str Ticker to get congress trading data from None False
past_transaction_days int Number of days to get transactions for 10 True

Returns

Type Description
pd.DataFrame Most recent transactions by members of U.S. Congress

Show government contracts for ticker [Source: quiverquant.com]

Source Code: [link]

openbb.stocks.gov.contracts_chart(symbol: str, past_transaction_days: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Ticker to get congress trading data from None False
past_transaction_days int Number of days to get transactions for 10 True
raw bool Flag to display raw data False True
export str Format to export data True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything