Source code for pyEX.refdata.exchanges

# *****************************************************************************
#
# Copyright (c) 2020, the pyEX authors.
#
# This file is part of the pyEX library, distributed under the terms of
# the Apache License 2.0.  The full license can be found in the LICENSE file.
#
from functools import wraps

import pandas as pd

from ..common import _expire, _get


@_expire(hour=8)
def exchanges(token="", version="stable", filter="", format="json"):
    """Returns an array of U.S. exchanges.

    https://iexcloud.io/docs/api/#u-s-exchanges
    8am, 9am, 12pm, 1pm UTC daily

    Args:
        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:
        dict or DataFrame: result
    """
    return _get(
        "ref-data/market/us/exchanges",
        token=token,
        version=version,
        filter=filter,
        format=format,
    )


@wraps(exchanges)
def exchangesDF(*args, **kwargs):
    return pd.DataFrame(exchanges(*args, **kwargs))


@_expire(hour=8)
def internationalExchanges(token="", version="stable", filter="", format="json"):
    """Returns an array of exchanges.

    https://iexcloud.io/docs/api/#international-exchanges
    8am, 9am, 12pm, 1pm UTC daily

    Args:
        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:
        dict or DataFrame: result
    """
    return _get(
        "ref-data/exchanges", token=token, version=version, filter=filter, format=format
    )


@wraps(internationalExchanges)
def internationalExchangesDF(*args, **kwargs):
    return pd.DataFrame(internationalExchanges(*args, **kwargs))