Skip to content

Commit

Permalink
some style things and prevent page from exceeding 30
Browse files Browse the repository at this point in the history
  • Loading branch information
deeleeramone committed Dec 7, 2024
1 parent 68e4231 commit 017e0e6
Show file tree
Hide file tree
Showing 3 changed files with 157 additions and 83 deletions.
28 changes: 18 additions & 10 deletions openbb_platform/openbb/assets/reference.json
Original file line number Diff line number Diff line change
Expand Up @@ -28335,8 +28335,8 @@
"standard": [
{
"name": "symbol",
"type": "str",
"description": "Symbol to get data for.",
"type": "Union[str, List[str]]",
"description": "Symbol to get data for. Multiple items allowed for provider(s): fmp.",
"default": null,
"optional": true,
"choices": null
Expand Down Expand Up @@ -28395,8 +28395,8 @@
"name": "symbol",
"type": "str",
"description": "Symbol representing the entity requested in the data.",
"default": "",
"optional": false,
"default": null,
"optional": true,
"choices": null
},
{
Expand Down Expand Up @@ -28426,11 +28426,11 @@
],
"fmp": [
{
"name": "link",
"type": "str",
"description": "Link to the transaction document.",
"default": null,
"optional": true,
"name": "chamber",
"type": "Literal['house', 'senate']",
"description": "Government Chamber - House or Senate.",
"default": "",
"optional": false,
"choices": null
},
{
Expand Down Expand Up @@ -28458,7 +28458,7 @@
"choices": null
},
{
"name": "type",
"name": "transaction_type",
"type": "str",
"description": "Type of transaction (e.g., Sale, Purchase).",
"default": null,
Expand All @@ -28480,6 +28480,14 @@
"default": null,
"optional": true,
"choices": null
},
{
"name": "url",
"type": "str",
"description": "Link to the transaction document.",
"default": null,
"optional": true,
"choices": null
}
]
},
Expand Down
20 changes: 14 additions & 6 deletions openbb_platform/openbb/package/equity_ownership.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,10 @@ def form_13f(
def government_trades(
self,
symbol: Annotated[
Optional[str], OpenBBField(description="Symbol to get data for.")
Union[str, None, List[Optional[str]]],
OpenBBField(
description="Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp."
),
] = None,
chamber: Annotated[
Literal["house", "senate", "all"],
Expand All @@ -179,8 +182,8 @@ def government_trades(
Parameters
----------
symbol : Optional[str]
Symbol to get data for.
symbol : Union[str, None, List[Optional[str]]]
Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp.
chamber : Literal['house', 'senate', 'all']
Government Chamber.
limit : Optional[Annotated[int, Ge(ge=0)]]
Expand Down Expand Up @@ -212,20 +215,22 @@ def government_trades(
Date of Transaction.
representative : Optional[str]
Name of Representative.
link : Optional[str]
Link to the transaction document. (provider: fmp)
chamber : Optional[Literal['house', 'senate']]
Government Chamber - House or Senate. (provider: fmp)
owner : Optional[str]
Ownership status (e.g., Spouse, Joint). (provider: fmp)
asset_type : Optional[str]
Type of asset involved in the transaction. (provider: fmp)
asset_description : Optional[str]
Description of the asset. (provider: fmp)
type : Optional[str]
transaction_type : Optional[str]
Type of transaction (e.g., Sale, Purchase). (provider: fmp)
amount : Optional[str]
Transaction amount range. (provider: fmp)
comment : Optional[str]
Additional comments on the transaction. (provider: fmp)
url : Optional[str]
Link to the transaction document. (provider: fmp)
Examples
--------
Expand All @@ -250,6 +255,9 @@ def government_trades(
"limit": limit,
},
extra_params=kwargs,
info={
"symbol": {"fmp": {"multiple_items_allowed": True, "choices": None}}
},
)
)

Expand Down
Loading

0 comments on commit 017e0e6

Please sign in to comment.