{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "e845e878",
   "metadata": {},
   "source": [
    "# LMP Pricing Data\n",
    "\n",
    "## Support\n",
    "\n",
    "Below are the currently support LMP markets\n",
    "\n",
    "<!-- LMP AVAILABILITY TABLE START -->\n",
    "|                                       | Markets                                                    |\n",
    "|:--------------------------------------|:-----------------------------------------------------------|\n",
    "| Midcontinent ISO                      | `REAL_TIME_5_MIN`, `DAY_AHEAD_HOURLY`                      |\n",
    "| California ISO                        | `REAL_TIME_15_MIN`, `REAL_TIME_HOURLY`, `DAY_AHEAD_HOURLY` |\n",
    "| PJM                                   | `REAL_TIME_5_MIN`, `REAL_TIME_HOURLY`, `DAY_AHEAD_HOURLY`  |\n",
    "| Electric Reliability Council of Texas |                                                            |\n",
    "| Southwest Power Pool                  |                                                            |\n",
    "| New York ISO                          | `REAL_TIME_5_MIN`, `DAY_AHEAD_HOURLY`                      |\n",
    "| ISO New England                       | `REAL_TIME_5_MIN`, `REAL_TIME_HOURLY`, `DAY_AHEAD_HOURLY`  |\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": "6c03bdf4",
   "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>2022-12-02 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>CAPITL</td>\n",
       "      <td>Zone</td>\n",
       "      <td>46.73</td>\n",
       "      <td>35.95</td>\n",
       "      <td>-9.31</td>\n",
       "      <td>1.47</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>2022-12-02 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>CENTRL</td>\n",
       "      <td>Zone</td>\n",
       "      <td>37.72</td>\n",
       "      <td>35.95</td>\n",
       "      <td>-0.84</td>\n",
       "      <td>0.93</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>2022-12-02 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>DUNWOD</td>\n",
       "      <td>Zone</td>\n",
       "      <td>44.12</td>\n",
       "      <td>35.94</td>\n",
       "      <td>-5.48</td>\n",
       "      <td>2.70</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>2022-12-02 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>GENESE</td>\n",
       "      <td>Zone</td>\n",
       "      <td>37.11</td>\n",
       "      <td>35.95</td>\n",
       "      <td>-0.66</td>\n",
       "      <td>0.50</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>2022-12-02 00:05:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>H Q</td>\n",
       "      <td>Zone</td>\n",
       "      <td>35.55</td>\n",
       "      <td>35.94</td>\n",
       "      <td>0.00</td>\n",
       "      <td>-0.39</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>2455</th>\n",
       "      <td>2022-12-02 14:30:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>NORTH</td>\n",
       "      <td>Zone</td>\n",
       "      <td>19.02</td>\n",
       "      <td>19.06</td>\n",
       "      <td>0.00</td>\n",
       "      <td>-0.04</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2456</th>\n",
       "      <td>2022-12-02 14:30:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>NPX</td>\n",
       "      <td>Zone</td>\n",
       "      <td>55.96</td>\n",
       "      <td>19.06</td>\n",
       "      <td>-36.04</td>\n",
       "      <td>0.86</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2457</th>\n",
       "      <td>2022-12-02 14:30:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>O H</td>\n",
       "      <td>Zone</td>\n",
       "      <td>15.72</td>\n",
       "      <td>19.06</td>\n",
       "      <td>3.00</td>\n",
       "      <td>-0.34</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2458</th>\n",
       "      <td>2022-12-02 14:30:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>PJM</td>\n",
       "      <td>Zone</td>\n",
       "      <td>33.94</td>\n",
       "      <td>19.07</td>\n",
       "      <td>-13.96</td>\n",
       "      <td>0.91</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2459</th>\n",
       "      <td>2022-12-02 14:30:00-05:00</td>\n",
       "      <td>REAL_TIME_5_MIN</td>\n",
       "      <td>WEST</td>\n",
       "      <td>Zone</td>\n",
       "      <td>14.80</td>\n",
       "      <td>19.06</td>\n",
       "      <td>4.41</td>\n",
       "      <td>0.15</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>2460 rows × 8 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                          Time           Market Location Location Type    LMP  \\\n",
       "0    2022-12-02 00:05:00-05:00  REAL_TIME_5_MIN   CAPITL          Zone  46.73   \n",
       "1    2022-12-02 00:05:00-05:00  REAL_TIME_5_MIN   CENTRL          Zone  37.72   \n",
       "2    2022-12-02 00:05:00-05:00  REAL_TIME_5_MIN   DUNWOD          Zone  44.12   \n",
       "3    2022-12-02 00:05:00-05:00  REAL_TIME_5_MIN   GENESE          Zone  37.11   \n",
       "4    2022-12-02 00:05:00-05:00  REAL_TIME_5_MIN      H Q          Zone  35.55   \n",
       "...                        ...              ...      ...           ...    ...   \n",
       "2455 2022-12-02 14:30:00-05:00  REAL_TIME_5_MIN    NORTH          Zone  19.02   \n",
       "2456 2022-12-02 14:30:00-05:00  REAL_TIME_5_MIN      NPX          Zone  55.96   \n",
       "2457 2022-12-02 14:30:00-05:00  REAL_TIME_5_MIN      O H          Zone  15.72   \n",
       "2458 2022-12-02 14:30:00-05:00  REAL_TIME_5_MIN      PJM          Zone  33.94   \n",
       "2459 2022-12-02 14:30:00-05:00  REAL_TIME_5_MIN     WEST          Zone  14.80   \n",
       "\n",
       "      Energy  Congestion  Loss  \n",
       "0      35.95       -9.31  1.47  \n",
       "1      35.95       -0.84  0.93  \n",
       "2      35.94       -5.48  2.70  \n",
       "3      35.95       -0.66  0.50  \n",
       "4      35.94        0.00 -0.39  \n",
       "...      ...         ...   ...  \n",
       "2455   19.06        0.00 -0.04  \n",
       "2456   19.06      -36.04  0.86  \n",
       "2457   19.06        3.00 -0.34  \n",
       "2458   19.07      -13.96  0.91  \n",
       "2459   19.06        4.41  0.15  \n",
       "\n",
       "[2460 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": "182c56c9",
   "metadata": {},
   "source": [
    "And here is querying CAISO"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "f947159b",
   "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>2022-12-02 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>158.63934</td>\n",
       "      <td>157.89722</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>0.74212</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>2022-12-02 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>149.32340</td>\n",
       "      <td>157.89722</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-8.57382</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>2022-12-02 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>150.80763</td>\n",
       "      <td>157.89722</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-7.08959</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>2022-12-02 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>151.82687</td>\n",
       "      <td>150.98138</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>0.84550</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>2022-12-02 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>143.08505</td>\n",
       "      <td>150.98138</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-7.89633</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>2022-12-02 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>200.10278</td>\n",
       "      <td>211.40816</td>\n",
       "      <td>-0.31214</td>\n",
       "      <td>-10.99322</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>68</th>\n",
       "      <td>2022-12-02 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>201.34512</td>\n",
       "      <td>211.40816</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-10.06303</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>69</th>\n",
       "      <td>2022-12-02 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>185.92558</td>\n",
       "      <td>185.61005</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>0.31554</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>70</th>\n",
       "      <td>2022-12-02 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>176.38522</td>\n",
       "      <td>185.61005</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-9.22482</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>71</th>\n",
       "      <td>2022-12-02 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>177.44320</td>\n",
       "      <td>185.61005</td>\n",
       "      <td>0.00000</td>\n",
       "      <td>-8.16684</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>72 rows × 8 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                        Time            Market          Location  \\\n",
       "0  2022-12-02 00:00:00-08:00  DAY_AHEAD_HOURLY  TH_NP15_GEN-APND   \n",
       "1  2022-12-02 00:00:00-08:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND   \n",
       "2  2022-12-02 00:00:00-08:00  DAY_AHEAD_HOURLY  TH_ZP26_GEN-APND   \n",
       "3  2022-12-02 01:00:00-08:00  DAY_AHEAD_HOURLY  TH_NP15_GEN-APND   \n",
       "4  2022-12-02 01:00:00-08:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND   \n",
       "..                       ...               ...               ...   \n",
       "67 2022-12-02 22:00:00-08:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND   \n",
       "68 2022-12-02 22:00:00-08:00  DAY_AHEAD_HOURLY  TH_ZP26_GEN-APND   \n",
       "69 2022-12-02 23:00:00-08:00  DAY_AHEAD_HOURLY  TH_NP15_GEN-APND   \n",
       "70 2022-12-02 23:00:00-08:00  DAY_AHEAD_HOURLY  TH_SP15_GEN-APND   \n",
       "71 2022-12-02 23:00:00-08:00  DAY_AHEAD_HOURLY  TH_ZP26_GEN-APND   \n",
       "\n",
       "   Location Type        LMP     Energy  Congestion      Loss  \n",
       "0    Trading Hub  158.63934  157.89722     0.00000   0.74212  \n",
       "1    Trading Hub  149.32340  157.89722     0.00000  -8.57382  \n",
       "2    Trading Hub  150.80763  157.89722     0.00000  -7.08959  \n",
       "3    Trading Hub  151.82687  150.98138     0.00000   0.84550  \n",
       "4    Trading Hub  143.08505  150.98138     0.00000  -7.89633  \n",
       "..           ...        ...        ...         ...       ...  \n",
       "67   Trading Hub  200.10278  211.40816    -0.31214 -10.99322  \n",
       "68   Trading Hub  201.34512  211.40816     0.00000 -10.06303  \n",
       "69   Trading Hub  185.92558  185.61005     0.00000   0.31554  \n",
       "70   Trading Hub  176.38522  185.61005     0.00000  -9.22482  \n",
       "71   Trading Hub  177.44320  185.61005     0.00000  -8.16684  \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": "7df8f5dd",
   "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": "02bac2ba",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[<Markets.REAL_TIME_15_MIN: 'REAL_TIME_15_MIN'>,\n",
       " <Markets.REAL_TIME_HOURLY: 'REAL_TIME_HOURLY'>,\n",
       " <Markets.DAY_AHEAD_HOURLY: 'DAY_AHEAD_HOURLY'>]"
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "caiso.markets"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "71888cf3",
   "metadata": {},
   "source": [
    "The possible lmp query methods are `ISO.get_latest_lmp`, `ISO.get_lmp_today`, and `ISO.get_lmp`."
   ]
  }
 ],
 "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,
   30,
   34,
   38,
   43,
   47,
   49
  ]
 },
 "nbformat": 4,
 "nbformat_minor": 5
}