Spp
========================

.. py:module:: gridstatus.spp


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

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

.. autoapisummary::

   gridstatus.spp.SPP





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

.. autoapisummary::

   gridstatus.spp.FILE_BROWSER_API_URL
   gridstatus.spp.FS_DAM_LMP_BY_LOCATION
   gridstatus.spp.FS_RTBM_LMP_BY_LOCATION
   gridstatus.spp.LOCATION_TYPE_HUB
   gridstatus.spp.LOCATION_TYPE_INTERFACE
   gridstatus.spp.LOCATION_TYPE_SETTLEMENT_LOCATION
   gridstatus.spp.MARKETPLACE_BASE_URL
   gridstatus.spp.QUERY_RTM5_HUBS_URL
   gridstatus.spp.QUERY_RTM5_INTERFACES_URL


Contents
~~~~~~~~~~~~~~~~~~~
.. py:data:: FILE_BROWSER_API_URL
   :annotation: = https://marketplace.spp.org/file-browser-api/

   

.. py:data:: FS_DAM_LMP_BY_LOCATION
   :annotation: = da-lmp-by-location

   

.. py:data:: FS_RTBM_LMP_BY_LOCATION
   :annotation: = rtbm-lmp-by-location

   

.. py:data:: LOCATION_TYPE_HUB
   :annotation: = HUB

   

.. py:data:: LOCATION_TYPE_INTERFACE
   :annotation: = INTERFACE

   

.. py:data:: LOCATION_TYPE_SETTLEMENT_LOCATION
   :annotation: = SETTLEMENT_LOCATION

   

.. py:data:: MARKETPLACE_BASE_URL
   :annotation: = https://marketplace.spp.org

   

.. py:data:: QUERY_RTM5_HUBS_URL
   :annotation: = https://pricecontourmap.spp.org/arcgis/rest/services/MarketMaps/RTBM_FeatureData/MapServer/1/query

   

.. py:data:: QUERY_RTM5_INTERFACES_URL
   :annotation: = https://pricecontourmap.spp.org/arcgis/rest/services/MarketMaps/RTBM_FeatureData/MapServer/2/query

   

.. py:class:: SPP

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

   Southwest Power Pool (SPP)


   **Attributes**

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

      * - **default_timezone**
        - US/Central
      * - **interconnection_homepage**
        - https://www.spp.org/engineering/generator-interconnection/
      * - **iso_id**
        - spp
      * - **location_types**
        - None
      * - **markets**
        - None
      * - **name**
        - Southwest Power Pool
      * - **status_homepage**
        - https://www.spp.org/markets-operations/current-grid-conditions/


   **Methods**

   .. autoapisummary::
      :nosignatures:

      gridstatus.spp.SPP.get_fuel_mix
      gridstatus.spp.SPP.get_interconnection_queue
      gridstatus.spp.SPP.get_lmp
      gridstatus.spp.SPP.get_load
      gridstatus.spp.SPP.get_load_forecast
      gridstatus.spp.SPP.get_status

   .. py:method:: get_fuel_mix(date, 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_interconnection_queue(verbose=False)

      Get interconnection queue

      Returns:
          pd.DataFrame: Interconnection queue




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

      Get LMP data

      Supported Markets: REAL_TIME_5_MIN, DAY_AHEAD_HOURLY

      Supported Location Types: "hub", "interface", "settlement_location"


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

      Returns load for last 24hrs in 5 minute intervals


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

      type (str): MID_TERM is hourly for next 7 days or SHORT_TERM is every five minutes for a few hours


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