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

.. py:module:: gridstatus.nyiso


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

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

.. autoapisummary::

   gridstatus.nyiso.NYISO





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

.. autoapisummary::

   gridstatus.nyiso.dataset_interval_map
   gridstatus.nyiso.GENERATOR
   gridstatus.nyiso.ZONE


Contents
~~~~~~~~~~~~~~~~~~~
.. py:data:: dataset_interval_map

   

.. py:data:: GENERATOR
   :value: 'generator'

   load zone and point of generator interconnection

   :type: NYISO offers LMP data at two locational granularities

.. 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
      * - **interconnection_homepage**
        - https://www.nyiso.com/interconnections
      * - **iso_id**
        - nyiso
      * - **markets**
        - None
      * - **name**
        - New York ISO
      * - **status_homepage**
        - https://www.nyiso.com/system-conditions


   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.nyiso.NYISO.get_btm_solar
      gridstatus.nyiso.NYISO.get_btm_solar_forecast
      gridstatus.nyiso.NYISO.get_capacity_prices
      gridstatus.nyiso.NYISO.get_fuel_mix
      gridstatus.nyiso.NYISO.get_generators
      gridstatus.nyiso.NYISO.get_interconnection_queue
      gridstatus.nyiso.NYISO.get_lmp
      gridstatus.nyiso.NYISO.get_load
      gridstatus.nyiso.NYISO.get_load_forecast
      gridstatus.nyiso.NYISO.get_loads
      gridstatus.nyiso.NYISO.get_status

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

      Returns estimated BTM solar generation at a previous date in hourly
          intervals for system and each zone.

          Available ~8 hours after the end of the operating day.

      :param date: Date to get load for.
                   Can be "latest", "today", or a date
      :type date: str, pd.Timestamp, datetime.datetime
      :param end: End date for date range.
                  Optional.
      :type end: str, pd.Timestamp, datetime.datetime
      :param verbose: Whether to print verbose output. Optional.
      :type verbose: bool

      :returns: BTM solar data for NYISO system and each zone
      :rtype: pandas.DataFrame


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


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

      Pull the most recent capacity market report's market clearing prices

      :param date: date that will be used to pull latest capacity
                   report (will refer to month and year)
      :type date: pandas.Timestamp
      :param verbose: print out requested url. Defaults to False.
      :type verbose: bool, optional

      :returns: a DataFrame of monthly capacity prices (all three auctions) for                 each of the four capacity localities within NYISO


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


   .. py:method:: get_generators(verbose=False)

      Get a list of generators in NYISO

      When possible return capacity and fuel type information

      :param verbose: print out requested url. Defaults to False.
      :type verbose: bool, optional

      :returns: a DataFrame of generators and locations

                **Possible Columns**

                * Generator Name
                * PTID
                * Subzone
                * Zone
                * Latitude
                * Longitude
                * Owner, Operator, and / or Billing Organization
                * Station Unit
                * Town
                * County
                * State
                * In-Service Date
                * Name Plate Rating (V) MW
                * 2022 CRIS MW Summer
                * 2022 CRIS MW Winter
                * 2022 Capability MW Summer
                * 2022 Capability MW Winter
                * Is Dual Fuel
                * Unit Type
                * Fuel Type 1
                * Fuel Type 2
                * 2021 Net Energy GWh
                * Notes
                * Generator Type
      :rtype: pandas.DataFrame


   .. py:method:: get_interconnection_queue(verbose=False)

      Return NYISO interconnection queue

      Additional Non-NYISO queue info: https://www3.dps.ny.gov/W/PSCWeb.nsf/All/286D2C179E9A5A8385257FBF003F1F7E?OpenDocument

      :returns: Interconnection queue containing, active, withdrawn,                 and completed project
      :rtype: pandas.DataFrame


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

      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 for
        each zone and total load

      :param date: Date to get load for. Can be "latest", "today", or
                   a date in the format YYYY-MM-DD
      :type date: str
      :param end: End date for date range. Optional.
      :type end: str
      :param verbose: Whether to print verbose output. Optional.
      :type verbose: bool

      :returns: Load data for NYISO and each zone
      :rtype: pandas.DataFrame


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

      Get load forecast for a date in 1 hour intervals


   .. py:method:: get_loads(verbose=False)

      Get a list of loads in NYISO

      :param verbose: print out requested url. Defaults to False.
      :type verbose: bool, optional

      :returns: a DataFrame of loads and locations
      :rtype: pandas.DataFrame


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



.. py:data:: ZONE
   :value: 'zone'