Forex¶
Bases: API
Client to fetch forex data from DataMaxi+ API.
Parameters:
-
api_key(str, default:None) –The DataMaxi+ API key
-
**kwargs(Any, default:{}) –Keyword arguments used by
datamaxi.api.API.
__call__
¶
__call__(
symbol: str, pandas: bool = True
) -> Union[Dict, pd.DataFrame]
Fetch forex data
GET /api/v1/forex
https://docs.datamaxiplus.com/rest/forex/forex
Parameters:
-
symbol(str) –Symbol name
-
pandas(bool, default:True) –Return data as pandas DataFrame
Returns:
-
Union[Dict, DataFrame]–Forex data in pandas DataFrame
symbols
¶
symbols() -> List[str]
Fetch supported symbols accepted by datamaxi.Forex.get API.
GET /api/v1/forex/symbols
https://docs.datamaxiplus.com/rest/forex/symbols
Returns:
-
List[str]–List of supported symbols