Nyiso
==========================

.. py:module:: gridstatus.nyiso


Module Contents
---------------

Classes Summary
~~~~~~~~~~~~~~~

.. autoapisummary::

   gridstatus.nyiso.NYISO





Attributes Summary
~~~~~~~~~~~~~~~~~~~

.. autoapisummary::

   gridstatus.nyiso.GENERATOR
   gridstatus.nyiso.ZONE


Contents
~~~~~~~~~~~~~~~~~~~
.. py:data:: GENERATOR
   :annotation: = generator

   NYISO offers LMP data at two locational granularities: load zone and point of generator interconnection


.. py:class:: NYISO

   Bases: :py:obj:`gridstatus.base.ISOBase`

   New York Independent System Operator (NYISO)


   **Attributes**

   .. list-table::
      :widths: 15 85
      :header-rows: 0

      * - **default_timezone**
        - US/Eastern
      * - **iso_id**
        - nyiso
      * - **markets**
        - None
      * - **name**
        - New York ISO
      * - **status_homepage**
        - https://www.nyiso.com/system-conditions


   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.nyiso.NYISO.get_fuel_mix
      gridstatus.nyiso.NYISO.get_lmp
      gridstatus.nyiso.NYISO.get_load
      gridstatus.nyiso.NYISO.get_load_forecast
      gridstatus.nyiso.NYISO.get_status
      gridstatus.nyiso.NYISO.get_supply

   .. py:method:: get_fuel_mix(date, end=None, verbose=False)

      Get fuel mix in 5 minute intervals for a provided day

      Arguments:
          date (datetime or str): "latest", "today", or an object that can be parsed as a datetime for the day to return data.

          start (datetime or str): start of date range to return. alias for `date` parameter. Only specify one of `date` or `start`.

          end (datetime or str): "today" or an object that can be parsed as a datetime for the day to return data. Only used if requesting a range of dates.

          verbose (bool): print verbose output. Defaults to False.


      Returns:
          pd.Dataframe: dataframe with columns: Time and columns for each fuel type


   .. py:method:: get_lmp(date, end=None, market: str = None, locations: list = None, location_type: str = None)

      Supported Markets: REAL_TIME_5_MIN, DAY_AHEAD_HOURLY

      Supported Location Types: "zone", "generator"


   .. py:method:: get_load(date, end=None, verbose=False)

      Returns load at a previous date in 5 minute intervals


   .. py:method:: get_load_forecast(date, end=None, verbose=False)

      Get load forecast for a date in 1 hour intervals


   .. py:method:: get_status(date, end=None, verbose=False)


   .. py:method:: get_supply(date, end=None, verbose=False)

      Get supply for a date or date range in hourly intervals



.. py:data:: ZONE
   :annotation: = zone