File size: 12,723 Bytes
203c118 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
from typing import Literal, Optional, Union
from openbb_core.app.model.field import OpenBBField
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.static.container import Container
from openbb_core.app.static.utils.decorators import exception_handler, validate
from openbb_core.app.static.utils.filters import filter_inputs
from typing_extensions import Annotated
class ROUTER_currency(Container):
"""/currency
/price
search
snapshots
"""
def __repr__(self) -> str:
return self.__doc__ or ""
@property
def price(self):
# pylint: disable=import-outside-toplevel
from . import currency_price
return currency_price.ROUTER_currency_price(command_runner=self._command_runner)
@exception_handler
@validate
def search(
self,
query: Annotated[
Optional[str],
OpenBBField(description="Query to search for currency pairs."),
] = None,
provider: Annotated[
Optional[Literal["fmp", "intrinio", "polygon"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon."
),
] = None,
**kwargs
) -> OBBject:
"""Currency Search.
Search available currency pairs.
Currency pairs are the national currencies from two countries coupled for trading on
the foreign exchange (FX) marketplace.
Both currencies will have exchange rates on which the trade will have its position basis.
All trading within the forex market, whether selling, buying, or trading, will take place through currency pairs.
(ref: Investopedia)
Major currency pairs include pairs such as EUR/USD, USD/JPY, GBP/USD, etc.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, polygon.
query : Optional[str]
Query to search for currency pairs.
Returns
-------
OBBject
results : list[CurrencyPairs]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
CurrencyPairs
-------------
symbol : str
Symbol representing the entity requested in the data.
name : Optional[str]
Name of the currency pair.
currency : Optional[str]
Base currency of the currency pair. (provider: fmp)
stock_exchange : Optional[str]
Stock exchange of the currency pair. (provider: fmp)
exchange_short_name : Optional[str]
Short name of the stock exchange of the currency pair. (provider: fmp)
base_currency : Optional[str]
ISO 4217 currency code of the base currency. (provider: intrinio)
quote_currency : Optional[str]
ISO 4217 currency code of the quote currency. (provider: intrinio)
currency_symbol : Optional[str]
The symbol of the quote currency. (provider: polygon)
base_currency_symbol : Optional[str]
The symbol of the base currency. (provider: polygon)
base_currency_name : Optional[str]
Name of the base currency. (provider: polygon)
market : Optional[str]
Name of the trading market. Always 'fx'. (provider: polygon)
locale : Optional[str]
Locale of the currency pair. (provider: polygon)
last_updated : Optional[date]
The date the reference data was last updated. (provider: polygon)
delisted : Optional[date]
The date the item was delisted. (provider: polygon)
Examples
--------
>>> from openbb import obb
>>> obb.currency.search(provider='fmp')
>>> # Search for 'EUR' currency pair using 'intrinio' as provider.
>>> obb.currency.search(provider='intrinio', query='EUR')
>>> # Search for terms using 'polygon' as provider.
>>> obb.currency.search(provider='polygon', query='EUR')
""" # noqa: E501
return self._run(
"/currency/search",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"currency.search",
("fmp", "intrinio", "polygon"),
)
},
standard_params={
"query": query,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def snapshots(
self,
base: Annotated[
Union[str, list[str]],
OpenBBField(
description="The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon."
),
] = "usd",
quote_type: Annotated[
Literal["direct", "indirect"],
OpenBBField(
description="Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency."
),
] = "indirect",
counter_currencies: Annotated[
Union[str, list[str], None],
OpenBBField(
description="An optional list of counter currency symbols to filter for. None returns all."
),
] = None,
provider: Annotated[
Optional[Literal["fmp", "polygon"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, polygon."
),
] = None,
**kwargs
) -> OBBject:
"""Snapshots of currency exchange rates from an indirect or direct perspective of a base currency.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, polygon.
base : Union[str, list[str]]
The base currency symbol. Multiple comma separated items allowed for provider(s): fmp, polygon.
quote_type : Literal['direct', 'indirect']
Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.
counter_currencies : Union[str, list[str], None]
An optional list of counter currency symbols to filter for. None returns all.
Returns
-------
OBBject
results : list[CurrencySnapshots]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
CurrencySnapshots
-----------------
base_currency : str
The base, or domestic, currency.
counter_currency : str
The counter, or foreign, currency.
last_rate : float
The exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'.
open : Optional[float]
The open price.
high : Optional[float]
The high price.
low : Optional[float]
The low price.
close : Optional[float]
The close price.
volume : Optional[int]
The trading volume.
prev_close : Optional[float]
The previous close price.
change : Optional[float]
The change in the price from the previous close. (provider: fmp, polygon)
change_percent : Optional[float]
The change in the price from the previous close, as a normalized percent. (provider: fmp);
The percentage change in price from the previous day. (provider: polygon)
ma50 : Optional[float]
The 50-day moving average. (provider: fmp)
ma200 : Optional[float]
The 200-day moving average. (provider: fmp)
year_high : Optional[float]
The 52-week high. (provider: fmp)
year_low : Optional[float]
The 52-week low. (provider: fmp)
last_rate_timestamp : Optional[datetime]
The timestamp of the last rate. (provider: fmp)
vwap : Optional[float]
The volume-weighted average price. (provider: polygon)
prev_open : Optional[float]
The previous day's opening price. (provider: polygon)
prev_high : Optional[float]
The previous day's high price. (provider: polygon)
prev_low : Optional[float]
The previous day's low price. (provider: polygon)
prev_volume : Optional[float]
The previous day's volume. (provider: polygon)
prev_vwap : Optional[float]
The previous day's VWAP. (provider: polygon)
bid : Optional[float]
The current bid price. (provider: polygon)
ask : Optional[float]
The current ask price. (provider: polygon)
minute_open : Optional[float]
The open price from the most recent minute bar. (provider: polygon)
minute_high : Optional[float]
The high price from the most recent minute bar. (provider: polygon)
minute_low : Optional[float]
The low price from the most recent minute bar. (provider: polygon)
minute_close : Optional[float]
The close price from the most recent minute bar. (provider: polygon)
minute_volume : Optional[float]
The volume from the most recent minute bar. (provider: polygon)
minute_vwap : Optional[float]
The VWAP from the most recent minute bar. (provider: polygon)
minute_transactions : Optional[float]
The number of transactions in the most recent minute bar. (provider: polygon)
quote_timestamp : Optional[datetime]
The timestamp of the last quote. (provider: polygon)
minute_timestamp : Optional[datetime]
The timestamp for the start of the most recent minute bar. (provider: polygon)
last_updated : Optional[datetime]
The last time the data was updated. (provider: polygon)
Examples
--------
>>> from openbb import obb
>>> obb.currency.snapshots(provider='fmp')
>>> # Get exchange rates from USD and XAU to EUR, JPY, and GBP using 'fmp' as provider.
>>> obb.currency.snapshots(provider='fmp', base='USD,XAU', counter_currencies='EUR,JPY,GBP', quote_type='indirect')
""" # noqa: E501
return self._run(
"/currency/snapshots",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"currency.snapshots",
("fmp", "polygon"),
)
},
standard_params={
"base": base,
"quote_type": quote_type,
"counter_currencies": counter_currencies,
},
extra_params=kwargs,
info={
"base": {
"fmp": {"multiple_items_allowed": True, "choices": None},
"polygon": {"multiple_items_allowed": True, "choices": None},
}
},
)
)
|