positionbook
- Model
- Chart
Request position book data for plotting.
Source Code: [link]
openbb.forex.oanda.positionbook(instrument: Optional[str] = None, accountID: str = "REPLACE_ME")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| instrument | Union[str, None] | The loaded currency pair, by default None | None | True |
| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True |
Returns
| Type | Description |
|---|---|
| Union[pd.DataFrame, bool] | Position book data or False |
Plot a position book for an instrument if Oanda provides one.
Source Code: [link]
openbb.forex.oanda.positionbook_chart(accountID: str, instrument: str = "", external_axes: bool = False)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| accountID | str | Oanda user account ID | None | False |
| instrument | str | The loaded currency pair | True | |
| external_axes | bool | Whether to return the figure object or not, by default False | False | True |
Returns
This function does not return anything