Source code for pyEX.commodities.commodities

# *****************************************************************************
#
# 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 enum import Enum
from functools import lru_cache

from ..points import points


[docs]class CommoditiesPoints(Enum):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    Attributes:
        WTI; Crude oil West Texas Intermediate - in dollars per barrel, not seasonally adjusted
        BRENT; Crude oil Brent Europe - in dollars per barrel, not seasonally adjusted
        NATGAS; Henry Hub Natural Gas Spot Price - in dollars per million BTU, not seasonally adjusted
        HEATOIL; No. 2 Heating Oil New York Harbor - in dollars per gallon, not seasonally adjusted
        JET; Kerosense Type Jet Fuel US Gulf Coast - in dollars per gallon, not seasonally adjusted
        DIESEL; US Diesel Sales Price - in dollars per gallon, not seasonally adjusted
        GASREG; US Regular Conventional Gas Price - in dollars per gallon, not seasonally adjusted
        GASMID; US Midgrade Conventional Gas Price - in dollars per gallon, not seasonally adjusted
        GASPRM; US Premium Conventional Gas Price - in dollars per gallon, not seasonally adjusted
        PROPANE; Propane Prices Mont Belvieu Texas - in dollars per gallon, not seasonally adjusted
    """

    WTI = "DCOILWTICO"
    BRENT = "DCOILBRENTEU"
    NATGAS = "DHHNGSP"
    HEATOIL = "DHOILNYH"
    JET = "DJFUELUSGULF"
    DIESEL = "GASDESW"
    GASREG = "GASREGCOVW"
    GASMID = "GASMIDCOVW"
    GASPRM = "GASPRMCOVW"
    PROPANE = "DPROPANEMBTX"

    @staticmethod
    @lru_cache(1)
    def options():
        """Return a list of the available commodities points options"""
        return list(map(lambda c: c.value, CommoditiesPoints))


[docs]def wti(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    WTI; Crude oil West Texas Intermediate - in dollars per barrel, not seasonally adjusted
    """
    return points("DCOILWTICO", token=token, version=version)


[docs]def brent(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    BRENT; Crude oil Brent Europe - in dollars per barrel, not seasonally adjusted
    """
    return points("DCOILBRENTEU", token=token, version=version)


[docs]def natgas(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    NATGAS; Henry Hub Natural Gas Spot Price - in dollars per million BTU, not seasonally adjusted
    """
    return points("DHHNGSP", token=token, version=version)


[docs]def heatoil(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    HEATOIL; No. 2 Heating Oil New York Harbor - in dollars per gallon, not seasonally adjusted
    """
    return points("DHOILNYH", token=token, version=version)


[docs]def jet(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    JET; Kerosense Type Jet Fuel US Gulf Coast - in dollars per gallon, not seasonally adjusted
    """
    return points("DJFUELUSGULF", token=token, version=version)


[docs]def diesel(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    DIESEL; US Diesel Sales Price - in dollars per gallon, not seasonally adjusted
    """
    return points("GASDESW", token=token, version=version)


[docs]def gasreg(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    GASREG; US Regular Conventional Gas Price - in dollars per gallon, not seasonally adjusted
    """
    return points("GASREGCOVW", token=token, version=version)


[docs]def gasmid(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    GASMID; US Midgrade Conventional Gas Price - in dollars per gallon, not seasonally adjusted
    """
    return points("GASMIDCOVW", token=token, version=version)


[docs]def gasprm(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    GASPRM; US Premium Conventional Gas Price - in dollars per gallon, not seasonally adjusted
    """
    return points("GASPRMCOVW", token=token, version=version)


[docs]def propane(token="", version="stable"):
    """Commodities data points

    https://iexcloud.io/docs/api/#commodities

    PROPANE; Propane Prices Mont Belvieu Texas - in dollars per gallon, not seasonally adjusted
    """
    return points("DPROPANEMBTX", token=token, version=version)