Ercot
==========================

.. py:module:: gridstatus.ercot


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

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

.. autoapisummary::

   gridstatus.ercot.Ercot





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

.. autoapisummary::

   gridstatus.ercot.iso


Contents
~~~~~~~~~~~~~~~~~~~
.. py:class:: Ercot

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

   Electric Reliability Council of Texas (ERCOT)


   **Attributes**

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

      * - **ACTUAL_LOADS_URL_FORMAT**
        - https://www.ercot.com/content/cdr/html/{timestamp}_actual_loads_of_forecast_zones.html
      * - **BASE**
        - https://www.ercot.com/api/1/services/read/dashboards
      * - **default_timezone**
        - US/Central
      * - **interconnection_homepage**
        - http://mis.ercot.com/misapp/GetReports.do?reportTypeId=15933
      * - **iso_id**
        - ercot
      * - **LOAD_HISTORICAL_MAX_DAYS**
        - 14
      * - **name**
        - Electric Reliability Council of Texas
      * - **status_homepage**
        - https://www.ercot.com/gridmktinfo/dashboards/gridconditions


   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.ercot.Ercot.get_as_prices
      gridstatus.ercot.Ercot.get_fuel_mix
      gridstatus.ercot.Ercot.get_interconnection_queue
      gridstatus.ercot.Ercot.get_load
      gridstatus.ercot.Ercot.get_load_forecast
      gridstatus.ercot.Ercot.get_rtm_spp
      gridstatus.ercot.Ercot.get_status

   .. py:method:: get_as_prices(date, verbose=False)

      Get ancillary service clearing prices in hourly intervals in Day Ahead Market

      Arguments:
          date(datetime or str): date of delivery for AS services
          verbose(bool): print verbose output. Defaults to False.

      Returns:
          pd.Dataframe: dataframe with prices for "Non-Spinning Reserves", "Regulation Up", "Regulation Down", "Responsive Reserves",



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

      Get fuel mix 5 minute intervals

      Arguments:
          date(datetime or str): "latest", "today". historical data currently not supported

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

      Returns:
          pd.Dataframe: dataframe with columns: Time and columns for each fuel type (solar and wind)


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

      Get interconnection queue for ERCOT

      Monthly historical data available here: http: // mis.ercot.com/misapp/GetReports.do?reportTypeId = 15933 & reportTitle = GIS % 20Report & showHTMLView = &mimicKey


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


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

      Returns load forecast

      Currently only supports today's forecast


   .. py:method:: get_rtm_spp(year)

      Get Historical RTM Settlement Point Prices(SPPs) for each of the Hubs and Load Zones

      Arguments:
          year(int): year to get data for

      Source: https: // www.ercot.com/mp/data-products/data-product-details?id = NP6-785-ER


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

      Returns status of grid



.. py:data:: iso