FX¶

pyEX.fx.fx.convertFX(symbols=None, amount=None, token='', version='stable', filter='', format='json')[source]

This endpoint performs a conversion from one currency to another for a supplied amount of the base currency. If an amount isn’t provided, the latest exchange rate will be provided and the amount will be null.

https://iexcloud.io/docs/api/#currency-conversion 5pm Sun-4pm Fri UTC

Parameters:	symbols (str) – comma seperated list of symbols amount (float) – amount to convert token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.fx.fx.convertFXDF(symbols=None, amount=None, token='', version='stable', filter='', format='json')[source]

This endpoint performs a conversion from one currency to another for a supplied amount of the base currency. If an amount isn’t provided, the latest exchange rate will be provided and the amount will be null.

https://iexcloud.io/docs/api/#currency-conversion 5pm Sun-4pm Fri UTC

Parameters:	symbols (str) – comma seperated list of symbols amount (float) – amount to convert token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.fx.fx.historicalFX(symbols=None, from_='', to_='', on='', last=0, first=0, token='', version='stable', filter='', format='json')[source]

This endpoint returns a daily value for the desired currency pair.

https://iexcloud.io/docs/api/#historical-daily 1am Mon-Sat UTC

Parameters:	symbols (str) – comma seperated list of symbols from (str or datetime) – Returns data on or after the given from date. Format YYYY-MM-DD to (str or datetime) – Returns data on or before the given to date. Format YYYY-MM-DD on (str or datetime) – Returns data on the given date. Format YYYY-MM-DD last (int) – Returns the latest n number of records in the series first (int) – Returns the first n number of records in the series token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.fx.fx.historicalFXDF(symbols=None, from_='', to_='', on='', last=0, first=0, token='', version='stable', filter='', format='json')[source]

This endpoint returns a daily value for the desired currency pair.

https://iexcloud.io/docs/api/#historical-daily 1am Mon-Sat UTC

Parameters:	symbols (str) – comma seperated list of symbols from (str or datetime) – Returns data on or after the given from date. Format YYYY-MM-DD to (str or datetime) – Returns data on or before the given to date. Format YYYY-MM-DD on (str or datetime) – Returns data on the given date. Format YYYY-MM-DD last (int) – Returns the latest n number of records in the series first (int) – Returns the first n number of records in the series token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.fx.fx.latestFX(symbols=None, token='', version='stable', filter='', format='json')[source]

This endpoint returns real-time foreign currency exchange rates data updated every 250 milliseconds.

https://iexcloud.io/docs/api/#latest-currency-rates 5pm Sun-4pm Fri UTC

Parameters:	symbols (str) – comma seperated list of symbols token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.fx.fx.latestFXDF(symbols=None, token='', version='stable', filter='', format='json')[source]

This endpoint returns real-time foreign currency exchange rates data updated every 250 milliseconds.

https://iexcloud.io/docs/api/#latest-currency-rates 5pm Sun-4pm Fri UTC

Parameters:	symbols (str) – comma seperated list of symbols token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict