{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "bb5274a6",
   "metadata": {},
   "source": [
    "# LMP Pricing Data\n",
    "\n",
    "## Support\n",
    "\n",
    "Below are the currently supported LMP markets\n",
    "\n",
    "<!-- LMP AVAILABILITY TABLE START -->\n",
    "|       | Method    | REAL_TIME_5_MIN           | DAY_AHEAD_HOURLY          | REAL_TIME_15_MIN          | REAL_TIME_HOURLY          |\n",
    "|:------|:----------|:--------------------------|:--------------------------|:--------------------------|:--------------------------|\n",
    "| CAISO | `get_lmp` | latest, today, historical | latest, today, historical | latest, today, historical | -                         |\n",
    "| Ercot | `get_spp` | -                         | latest, today, historical | latest, today, historical | -                         |\n",
    "| ISONE | `get_lmp` | latest, today, historical | today, historical         | -                         | latest, today, historical |\n",
    "| MISO  | `get_lmp` | latest                    | latest                    | -                         | -                         |\n",
    "| NYISO | `get_lmp` | latest, today, historical | latest, today, historical | -                         | -                         |\n",
    "| PJM   | `get_lmp` | today, historical         | latest, today, historical | -                         | today, historical         |\n",
    "| SPP   | `get_lmp` | latest, today, historical | latest, today, historical | -                         | -                         |\n",
    "\n",
    "<!-- LMP AVAILABILITY TABLE END -->\n",
    "\n",
    "\n",
    "## How to use\n",
    "\n",
    "We are currently adding Locational Marginal Price (LMP). Even though each BA offers different markets, but you can query them with a standardized API"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "7395fe8d",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>Time</th>\n",
       "      <th>Market</th>\n",
       "      <th>Location</th>\n",
       "      <th>Location Type</th>\n",
       "      <th>LMP</th>\n",
       "      <th>Energy</th>\n",
       "      <th>Congestion</th>\n",
       "      <th>Loss</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>2023-01-27 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>CAPITL</td>\n",
       "      <td>Zone</td>\n",
       "      <td>30.63</td>\n",
       "      <td>29.06</td>\n",
       "      <td>0.00</td>\n",
       "      <td>1.57</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>2023-01-27 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>CENTRL</td>\n",
       "      <td>Zone</td>\n",
       "      <td>29.12</td>\n",
       "      <td>29.06</td>\n",
       "      <td>0.00</td>\n",
       "      <td>0.06</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>2023-01-27 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>DUNWOD</td>\n",
       "      <td>Zone</td>\n",
       "      <td>31.13</td>\n",
       "      <td>29.07</td>\n",
       "      <td>0.00</td>\n",
       "      <td>2.06</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>2023-01-27 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>GENESE</td>\n",
       "      <td>Zone</td>\n",
       "      <td>28.37</td>\n",
       "      <td>29.07</td>\n",
       "      <td>0.00</td>\n",
       "      <td>-0.70</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>2023-01-27 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>H Q</td>\n",
       "      <td>Zone</td>\n",
       "      <td>28.72</td>\n",
       "      <td>29.07</td>\n",
       "      <td>0.00</td>\n",
       "      <td>-0.35</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2320</th>\n",
       "      <td>2023-01-27 14:15:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>NORTH</td>\n",
       "      <td>Zone</td>\n",
       "      <td>30.88</td>\n",
       "      <td>30.94</td>\n",
       "      <td>0.00</td>\n",
       "      <td>-0.06</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2321</th>\n",
       "      <td>2023-01-27 14:15:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>NPX</td>\n",
       "      <td>Zone</td>\n",
       "      <td>32.70</td>\n",
       "      <td>30.94</td>\n",
       "      <td>0.00</td>\n",
       "      <td>1.76</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2322</th>\n",
       "      <td>2023-01-27 14:15:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>O H</td>\n",
       "      <td>Zone</td>\n",
       "      <td>20.28</td>\n",
       "      <td>30.94</td>\n",
       "      <td>8.80</td>\n",
       "      <td>-1.86</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2323</th>\n",
       "      <td>2023-01-27 14:15:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>PJM</td>\n",
       "      <td>Zone</td>\n",
       "      <td>29.13</td>\n",
       "      <td>30.94</td>\n",
       "      <td>2.61</td>\n",
       "      <td>0.80</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2324</th>\n",
       "      <td>2023-01-27 14:15:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>WEST</td>\n",
       "      <td>Zone</td>\n",
       "      <td>19.54</td>\n",
       "      <td>30.93</td>\n",
       "      <td>10.62</td>\n",
       "      <td>-0.77</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>2325 rows × 8 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                          Time           Market Location Location Type    LMP  \\\n",
       "0    2023-01-27 00:05:00-05:00  REAL_TIME_5_MIN   CAPITL          Zone  30.63   \n",
       "1    2023-01-27 00:05:00-05:00  REAL_TIME_5_MIN   CENTRL          Zone  29.12   \n",
       "2    2023-01-27 00:05:00-05:00  REAL_TIME_5_MIN   DUNWOD          Zone  31.13   \n",
       "3    2023-01-27 00:05:00-05:00  REAL_TIME_5_MIN   GENESE          Zone  28.37   \n",
       "4    2023-01-27 00:05:00-05:00  REAL_TIME_5_MIN      H Q          Zone  28.72   \n",
       "...                        ...              ...      ...           ...    ...   \n",
       "2320 2023-01-27 14:15:00-05:00  REAL_TIME_5_MIN    NORTH          Zone  30.88   \n",
       "2321 2023-01-27 14:15:00-05:00  REAL_TIME_5_MIN      NPX          Zone  32.70   \n",
       "2322 2023-01-27 14:15:00-05:00  REAL_TIME_5_MIN      O H          Zone  20.28   \n",
       "2323 2023-01-27 14:15:00-05:00  REAL_TIME_5_MIN      PJM          Zone  29.13   \n",
       "2324 2023-01-27 14:15:00-05:00  REAL_TIME_5_MIN     WEST          Zone  19.54   \n",
       "\n",
       "      Energy  Congestion  Loss  \n",
       "0      29.06        0.00  1.57  \n",
       "1      29.06        0.00  0.06  \n",
       "2      29.07        0.00  2.06  \n",
       "3      29.07        0.00 -0.70  \n",
       "4      29.07        0.00 -0.35  \n",
       "...      ...         ...   ...  \n",
       "2320   30.94        0.00 -0.06  \n",
       "2321   30.94        0.00  1.76  \n",
       "2322   30.94        8.80 -1.86  \n",
       "2323   30.94        2.61  0.80  \n",
       "2324   30.93       10.62 -0.77  \n",
       "\n",
       "[2325 rows x 8 columns]"
      ]
     },
     "execution_count": 1,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "import gridstatus\n",
    "nyiso = gridstatus.NYISO()\n",
    "nyiso.get_lmp(date=\"today\", market=\"REAL_TIME_5_MIN\", locations=\"ALL\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "2f688c80",
   "metadata": {},
   "source": [
    "And here is querying CAISO"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "f22ad670",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>Time</th>\n",
       "      <th>Market</th>\n",
       "      <th>Location</th>\n",
       "      <th>Location Type</th>\n",
       "      <th>LMP</th>\n",
       "      <th>Energy</th>\n",
       "      <th>Congestion</th>\n",
       "      <th>Loss</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>2023-01-27 00:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_NP15_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>81.22371</td>\n",
       "      <td>84.51999</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-3.29628</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>2023-01-27 00:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_SP15_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>82.89720</td>\n",
       "      <td>84.51999</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-1.62278</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>2023-01-27 00:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_ZP26_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>81.37584</td>\n",
       "      <td>84.51999</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-3.14414</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>2023-01-27 01:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_NP15_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>76.61670</td>\n",
       "      <td>79.51915</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-2.90245</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>2023-01-27 01:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_SP15_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>77.98443</td>\n",
       "      <td>79.51915</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-1.53472</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>67</th>\n",
       "      <td>2023-01-27 22:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_SP15_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>82.58601</td>\n",
       "      <td>83.98008</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-1.39407</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>68</th>\n",
       "      <td>2023-01-27 22:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_ZP26_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>80.09180</td>\n",
       "      <td>83.98008</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-3.88828</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>69</th>\n",
       "      <td>2023-01-27 23:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_NP15_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>76.05842</td>\n",
       "      <td>80.02967</td>\n",
       "      <td>-0.00178</td>\n",
       "      <td>-3.96947</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>70</th>\n",
       "      <td>2023-01-27 23:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_SP15_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>78.66116</td>\n",
       "      <td>80.02967</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-1.36851</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>71</th>\n",
       "      <td>2023-01-27 23:00:00-08:00</td>\n",
       "      <td>DAY_AHEAD_HOURLY</td>\n",
       "      <td>TH_ZP26_GEN-APND</td>\n",
       "      <td>Trading Hub</td>\n",
       "      <td>76.41233</td>\n",
       "      <td>80.02967</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-3.61734</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>72 rows × 8 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                        Time            Market          Location  \\\n",
       "0  2023-01-27 00:00:00-08:00  DAY_AHEAD_HOURLY  TH_NP15_GEN-APND   \n",
       "1  2023-01-27 00:00:00-08:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND   \n",
       "2  2023-01-27 00:00:00-08:00  DAY_AHEAD_HOURLY  TH_ZP26_GEN-APND   \n",
       "3  2023-01-27 01:00:00-08:00  DAY_AHEAD_HOURLY  TH_NP15_GEN-APND   \n",
       "4  2023-01-27 01:00:00-08:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND   \n",
       "..                       ...               ...               ...   \n",
       "67 2023-01-27 22:00:00-08:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND   \n",
       "68 2023-01-27 22:00:00-08:00  DAY_AHEAD_HOURLY  TH_ZP26_GEN-APND   \n",
       "69 2023-01-27 23:00:00-08:00  DAY_AHEAD_HOURLY  TH_NP15_GEN-APND   \n",
       "70 2023-01-27 23:00:00-08:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND   \n",
       "71 2023-01-27 23:00:00-08:00  DAY_AHEAD_HOURLY  TH_ZP26_GEN-APND   \n",
       "\n",
       "   Location Type       LMP    Energy  Congestion     Loss  \n",
       "0    Trading Hub  81.22371  84.51999     0.00000 -3.29628  \n",
       "1    Trading Hub  82.89720  84.51999     0.00000 -1.62278  \n",
       "2    Trading Hub  81.37584  84.51999     0.00000 -3.14414  \n",
       "3    Trading Hub  76.61670  79.51915     0.00000 -2.90245  \n",
       "4    Trading Hub  77.98443  79.51915     0.00000 -1.53472  \n",
       "..           ...       ...       ...         ...      ...  \n",
       "67   Trading Hub  82.58601  83.98008     0.00000 -1.39407  \n",
       "68   Trading Hub  80.09180  83.98008     0.00000 -3.88828  \n",
       "69   Trading Hub  76.05842  80.02967    -0.00178 -3.96947  \n",
       "70   Trading Hub  78.66116  80.02967     0.00000 -1.36851  \n",
       "71   Trading Hub  76.41233  80.02967     0.00000 -3.61734  \n",
       "\n",
       "[72 rows x 8 columns]"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "import gridstatus\n",
    "caiso = gridstatus.CAISO()\n",
    "locations = [\"TH_NP15_GEN-APND\", \"TH_SP15_GEN-APND\", \"TH_ZP26_GEN-APND\"]\n",
    "caiso.get_lmp(date=\"today\", market='DAY_AHEAD_HOURLY', locations=locations)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "79b54efb",
   "metadata": {},
   "source": [
    "You can see what markets are available by accessing the `markets` property of an iso. For, example"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "0b24716a",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[<Markets.REAL_TIME_5_MIN: 'REAL_TIME_5_MIN'>,\n",
       " <Markets.REAL_TIME_15_MIN: 'REAL_TIME_15_MIN'>,\n",
       " <Markets.DAY_AHEAD_HOURLY: 'DAY_AHEAD_HOURLY'>]"
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "caiso.markets"
   ]
  }
 ],
 "metadata": {
  "file_format": "mystnb",
  "kernelspec": {
   "display_name": "python3",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.8"
  },
  "source_map": [
   5,
   31,
   35,
   39,
   44,
   48
  ]
 },
 "nbformat": 4,
 "nbformat_minor": 5
}