{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Run Asset Pool 1"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Connecting engine server -&gt; <span style=\"color: #0000ff; text-decoration-color: #0000ff; text-decoration: underline\">https://absbox.org/api/dev</span>\n",
       "</pre>\n"
      ],
      "text/plain": [
       "Connecting engine server -> \u001b[4;94mhttps://absbox.org/api/dev\u001b[0m\n"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "/home/xiaoyu/repo/AbsBox/lib/python3.13/site-packages/urllib3/connectionpool.py:1097: InsecureRequestWarning: Unverified HTTPS request is being made to host 'absbox.org'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#tls-warnings\n",
      "  warnings.warn(\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">✅Connected, local li<span style=\"color: #00ff00; text-decoration-color: #00ff00; font-weight: bold\">b:0</span>.<span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">46.5</span>, server:<span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">0.50</span>.<span style=\"color: #008080; text-decoration-color: #008080; font-weight: bold\">1</span>\n",
       "</pre>\n"
      ],
      "text/plain": [
       "✅Connected, local li\u001b[1;92mb:0\u001b[0m.\u001b[1;36m46.5\u001b[0m, server:\u001b[1;36m0.50\u001b[0m.\u001b[1;36m1\u001b[0m\n"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "from absbox import API,EnginePath\n",
    "\n",
    "localAPI = API(EnginePath.DEV, lang='english',check=False)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Pool\n",
    "\n",
    "In `Pool` , it will have a field named `assets` ,which contains a list of `assets`"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "mortgage1 = [\"Mortgage\"\n",
    "            ,{\"originBalance\": 12000.0\n",
    "            ,\"originRate\": [\"fix\",0.045]\n",
    "            ,\"originTerm\": 40\n",
    "            ,\"freq\": \"monthly\"\n",
    "            ,\"type\": \"level\"\n",
    "            ,\"originDate\": \"2021-02-01\"}\n",
    "            ,{\"currentBalance\": 10000.0\n",
    "            ,\"currentRate\": 0.075\n",
    "            ,\"remainTerm\": 30\n",
    "            ,\"status\": \"current\"}]\n",
    "\n",
    "mortgage2 = [\"Mortgage\"\n",
    "            ,{\"originBalance\": 800.0\n",
    "            ,\"originRate\": [\"fix\",0.045]\n",
    "            ,\"originTerm\": 25\n",
    "            ,\"freq\": \"monthly\"\n",
    "            ,\"type\": \"level\"\n",
    "            ,\"originDate\": \"2021-02-01\"}\n",
    "            ,{\"currentBalance\": 600.0\n",
    "            ,\"currentRate\": 0.075\n",
    "            ,\"remainTerm\": 15\n",
    "            ,\"status\": \"current\"}]\n",
    "\n",
    "myPool = {'assets':[ mortgage1, mortgage2  ],\n",
    "         'cutoffDate':\"2022-03-01\"}"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "/home/xiaoyu/repo/AbsBox/lib/python3.13/site-packages/urllib3/connectionpool.py:1097: InsecureRequestWarning: Unverified HTTPS request is being made to host 'absbox.org'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#tls-warnings\n",
      "  warnings.warn(\n"
     ]
    },
    {
     "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>Balance</th>\n",
       "      <th>Principal</th>\n",
       "      <th>Interest</th>\n",
       "      <th>Prepayment</th>\n",
       "      <th>Default</th>\n",
       "      <th>Recovery</th>\n",
       "      <th>Loss</th>\n",
       "      <th>WAC</th>\n",
       "      <th>BorrowerNum</th>\n",
       "      <th>PrepayPenalty</th>\n",
       "      <th>CumPrincipal</th>\n",
       "      <th>CumPrepay</th>\n",
       "      <th>CumDelinq</th>\n",
       "      <th>CumDefault</th>\n",
       "      <th>CumRecovery</th>\n",
       "      <th>CumLoss</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>Date</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>2022-03-01</th>\n",
       "      <td>9542.79</td>\n",
       "      <td>345.80</td>\n",
       "      <td>61.80</td>\n",
       "      <td>0</td>\n",
       "      <td>7.62</td>\n",
       "      <td>0</td>\n",
       "      <td>7.62</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>345.80</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>7.62</td>\n",
       "      <td>0</td>\n",
       "      <td>7.62</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-04-01</th>\n",
       "      <td>9186.98</td>\n",
       "      <td>347.68</td>\n",
       "      <td>59.58</td>\n",
       "      <td>0</td>\n",
       "      <td>8.13</td>\n",
       "      <td>0</td>\n",
       "      <td>8.13</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>693.48</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>15.75</td>\n",
       "      <td>0</td>\n",
       "      <td>15.75</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-05-01</th>\n",
       "      <td>8829.85</td>\n",
       "      <td>349.56</td>\n",
       "      <td>57.36</td>\n",
       "      <td>0</td>\n",
       "      <td>7.57</td>\n",
       "      <td>0</td>\n",
       "      <td>7.57</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1043.04</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>23.32</td>\n",
       "      <td>0</td>\n",
       "      <td>23.32</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-06-01</th>\n",
       "      <td>8470.88</td>\n",
       "      <td>351.45</td>\n",
       "      <td>55.13</td>\n",
       "      <td>0</td>\n",
       "      <td>7.52</td>\n",
       "      <td>0</td>\n",
       "      <td>7.52</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1394.49</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>30.84</td>\n",
       "      <td>0</td>\n",
       "      <td>30.84</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-07-01</th>\n",
       "      <td>8110.54</td>\n",
       "      <td>353.35</td>\n",
       "      <td>52.89</td>\n",
       "      <td>0</td>\n",
       "      <td>6.99</td>\n",
       "      <td>0</td>\n",
       "      <td>6.99</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1747.84</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>37.83</td>\n",
       "      <td>0</td>\n",
       "      <td>37.83</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "            Balance  Principal  Interest  Prepayment  Default  Recovery  Loss  \\\n",
       "Date                                                                            \n",
       "2022-03-01  9542.79     345.80     61.80           0     7.62         0  7.62   \n",
       "2022-04-01  9186.98     347.68     59.58           0     8.13         0  8.13   \n",
       "2022-05-01  8829.85     349.56     57.36           0     7.57         0  7.57   \n",
       "2022-06-01  8470.88     351.45     55.13           0     7.52         0  7.52   \n",
       "2022-07-01  8110.54     353.35     52.89           0     6.99         0  6.99   \n",
       "\n",
       "              WAC BorrowerNum PrepayPenalty  CumPrincipal  CumPrepay  \\\n",
       "Date                                                                   \n",
       "2022-03-01  0.075        None          None        345.80          0   \n",
       "2022-04-01  0.075        None          None        693.48          0   \n",
       "2022-05-01  0.075        None          None       1043.04          0   \n",
       "2022-06-01  0.075        None          None       1394.49          0   \n",
       "2022-07-01  0.075        None          None       1747.84          0   \n",
       "\n",
       "            CumDelinq  CumDefault  CumRecovery  CumLoss  \n",
       "Date                                                     \n",
       "2022-03-01          0        7.62            0     7.62  \n",
       "2022-04-01          0       15.75            0    15.75  \n",
       "2022-05-01          0       23.32            0    23.32  \n",
       "2022-06-01          0       30.84            0    30.84  \n",
       "2022-07-01          0       37.83            0    37.83  "
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "r = localAPI.runPool(myPool\n",
    "                  ,poolAssump=(\"Pool\",(\"Mortgage\",{\"CDR\":0.01},None,None,None)\n",
    "                                    ,None\n",
    "                                    ,None)\n",
    "                  ,read=True)\n",
    "\n",
    "r['PoolConsol']['flow'].head(5)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Cutoff day\n",
    "\n",
    "`Cutoff day` means the day after which assets's cashflow belongs to the pool"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "/home/xiaoyu/repo/AbsBox/lib/python3.13/site-packages/urllib3/connectionpool.py:1097: InsecureRequestWarning: Unverified HTTPS request is being made to host 'absbox.org'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#tls-warnings\n",
      "  warnings.warn(\n"
     ]
    },
    {
     "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>Balance</th>\n",
       "      <th>Principal</th>\n",
       "      <th>Interest</th>\n",
       "      <th>Prepayment</th>\n",
       "      <th>Default</th>\n",
       "      <th>Recovery</th>\n",
       "      <th>Loss</th>\n",
       "      <th>WAC</th>\n",
       "      <th>BorrowerNum</th>\n",
       "      <th>PrepayPenalty</th>\n",
       "      <th>CumPrincipal</th>\n",
       "      <th>CumPrepay</th>\n",
       "      <th>CumDelinq</th>\n",
       "      <th>CumDefault</th>\n",
       "      <th>CumRecovery</th>\n",
       "      <th>CumLoss</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>Date</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>2023-03-01</th>\n",
       "      <td>5168.39</td>\n",
       "      <td>368.94</td>\n",
       "      <td>34.60</td>\n",
       "      <td>0</td>\n",
       "      <td>4.26</td>\n",
       "      <td>0</td>\n",
       "      <td>4.26</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>368.94</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>4.26</td>\n",
       "      <td>0</td>\n",
       "      <td>4.26</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2023-04-01</th>\n",
       "      <td>4834.54</td>\n",
       "      <td>329.45</td>\n",
       "      <td>32.27</td>\n",
       "      <td>0</td>\n",
       "      <td>4.40</td>\n",
       "      <td>0</td>\n",
       "      <td>4.40</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>698.39</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>8.66</td>\n",
       "      <td>0</td>\n",
       "      <td>8.66</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2023-05-01</th>\n",
       "      <td>4499.31</td>\n",
       "      <td>331.24</td>\n",
       "      <td>30.19</td>\n",
       "      <td>0</td>\n",
       "      <td>3.99</td>\n",
       "      <td>0</td>\n",
       "      <td>3.99</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1029.63</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>12.65</td>\n",
       "      <td>0</td>\n",
       "      <td>12.65</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2023-06-01</th>\n",
       "      <td>4162.45</td>\n",
       "      <td>333.03</td>\n",
       "      <td>28.09</td>\n",
       "      <td>0</td>\n",
       "      <td>3.83</td>\n",
       "      <td>0</td>\n",
       "      <td>3.83</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1362.66</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>16.48</td>\n",
       "      <td>0</td>\n",
       "      <td>16.48</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2023-07-01</th>\n",
       "      <td>3824.19</td>\n",
       "      <td>334.83</td>\n",
       "      <td>25.99</td>\n",
       "      <td>0</td>\n",
       "      <td>3.43</td>\n",
       "      <td>0</td>\n",
       "      <td>3.43</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1697.49</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>19.91</td>\n",
       "      <td>0</td>\n",
       "      <td>19.91</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "            Balance  Principal  Interest  Prepayment  Default  Recovery  Loss  \\\n",
       "Date                                                                            \n",
       "2023-03-01  5168.39     368.94     34.60           0     4.26         0  4.26   \n",
       "2023-04-01  4834.54     329.45     32.27           0     4.40         0  4.40   \n",
       "2023-05-01  4499.31     331.24     30.19           0     3.99         0  3.99   \n",
       "2023-06-01  4162.45     333.03     28.09           0     3.83         0  3.83   \n",
       "2023-07-01  3824.19     334.83     25.99           0     3.43         0  3.43   \n",
       "\n",
       "              WAC BorrowerNum PrepayPenalty  CumPrincipal  CumPrepay  \\\n",
       "Date                                                                   \n",
       "2023-03-01  0.075        None          None        368.94          0   \n",
       "2023-04-01  0.075        None          None        698.39          0   \n",
       "2023-05-01  0.075        None          None       1029.63          0   \n",
       "2023-06-01  0.075        None          None       1362.66          0   \n",
       "2023-07-01  0.075        None          None       1697.49          0   \n",
       "\n",
       "            CumDelinq  CumDefault  CumRecovery  CumLoss  \n",
       "Date                                                     \n",
       "2023-03-01          0        4.26            0     4.26  \n",
       "2023-04-01          0        8.66            0     8.66  \n",
       "2023-05-01          0       12.65            0    12.65  \n",
       "2023-06-01          0       16.48            0    16.48  \n",
       "2023-07-01          0       19.91            0    19.91  "
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "myPool = {'assets':[ mortgage1, mortgage2  ],\n",
    "         'cutoffDate':\"2023-03-01\"}\n",
    "\n",
    "r = localAPI.runPool(myPool\n",
    "                  ,poolAssump=(\"Pool\",(\"Mortgage\",{\"CDR\":0.01},None,None,None)\n",
    "                                    ,None\n",
    "                                    ,None)\n",
    "                  ,read=True)\n",
    "\n",
    "r['PoolConsol']['flow'].head()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Mixed Asset Pool\n",
    "\n",
    "User can build multiple pools with different asset type"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [],
   "source": [
    "receivable1 = [\"Invoice\"\n",
    "                  ,{\"start\":\"2024-04-01\",\"originBalance\":2000\n",
    "                    ,\"originAdvance\":1500,\"dueDate\":\"2024-06-01\"}\n",
    "                  ,{\"status\":\"Current\"}]\n",
    "\n",
    "myMixedPool = {\"invoicePool\": {'assets':[receivable1],}\n",
    "              ,\"mortgagePool\": {'assets':[mortgage1]}\n",
    "              ,'cutoffDate':\"2022-03-01\"}"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Without any stress assumption, the return result will be a map, which keys are the pool name"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "/home/xiaoyu/repo/AbsBox/lib/python3.13/site-packages/urllib3/connectionpool.py:1097: InsecureRequestWarning: Unverified HTTPS request is being made to host 'absbox.org'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#tls-warnings\n",
      "  warnings.warn(\n"
     ]
    },
    {
     "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>Balance</th>\n",
       "      <th>AccuredFee</th>\n",
       "      <th>Principal</th>\n",
       "      <th>Fee</th>\n",
       "      <th>Default</th>\n",
       "      <th>Recovery</th>\n",
       "      <th>Loss</th>\n",
       "      <th>CumPrincipal</th>\n",
       "      <th>CumPrepay</th>\n",
       "      <th>CumDelinq</th>\n",
       "      <th>CumDefault</th>\n",
       "      <th>CumRecovery</th>\n",
       "      <th>CumLoss</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>Date</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>2024-04-01</th>\n",
       "      <td>2000</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2024-06-01</th>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>2000</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "            Balance  AccuredFee  Principal  Fee  Default  Recovery  Loss  \\\n",
       "Date                                                                       \n",
       "2024-04-01     2000           0          0    0        0         0     0   \n",
       "2024-06-01        0           0       2000    0        0         0     0   \n",
       "\n",
       "            CumPrincipal  CumPrepay  CumDelinq  CumDefault  CumRecovery  \\\n",
       "Date                                                                      \n",
       "2024-04-01             0          0          0           0            0   \n",
       "2024-06-01             0          0          0           0            0   \n",
       "\n",
       "            CumLoss  \n",
       "Date                 \n",
       "2024-04-01        0  \n",
       "2024-06-01        0  "
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "r = localAPI.runPool(myMixedPool,read=True)\n",
    "\n",
    "r['invoicePool']['flow'].head()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "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>Balance</th>\n",
       "      <th>Principal</th>\n",
       "      <th>Interest</th>\n",
       "      <th>Prepayment</th>\n",
       "      <th>Default</th>\n",
       "      <th>Recovery</th>\n",
       "      <th>Loss</th>\n",
       "      <th>WAC</th>\n",
       "      <th>BorrowerNum</th>\n",
       "      <th>PrepayPenalty</th>\n",
       "      <th>CumPrincipal</th>\n",
       "      <th>CumPrepay</th>\n",
       "      <th>CumDelinq</th>\n",
       "      <th>CumDefault</th>\n",
       "      <th>CumRecovery</th>\n",
       "      <th>CumLoss</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>Date</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>2022-03-01</th>\n",
       "      <td>9082.00</td>\n",
       "      <td>307.91</td>\n",
       "      <td>58.68</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>307.91</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-04-01</th>\n",
       "      <td>8772.17</td>\n",
       "      <td>309.83</td>\n",
       "      <td>56.76</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>617.74</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-05-01</th>\n",
       "      <td>8460.40</td>\n",
       "      <td>311.77</td>\n",
       "      <td>54.82</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>929.51</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-06-01</th>\n",
       "      <td>8146.68</td>\n",
       "      <td>313.72</td>\n",
       "      <td>52.87</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1243.23</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-07-01</th>\n",
       "      <td>7831.00</td>\n",
       "      <td>315.68</td>\n",
       "      <td>50.91</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1558.91</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "            Balance  Principal  Interest  Prepayment  Default  Recovery  Loss  \\\n",
       "Date                                                                            \n",
       "2022-03-01  9082.00     307.91     58.68           0        0         0     0   \n",
       "2022-04-01  8772.17     309.83     56.76           0        0         0     0   \n",
       "2022-05-01  8460.40     311.77     54.82           0        0         0     0   \n",
       "2022-06-01  8146.68     313.72     52.87           0        0         0     0   \n",
       "2022-07-01  7831.00     315.68     50.91           0        0         0     0   \n",
       "\n",
       "              WAC BorrowerNum PrepayPenalty  CumPrincipal  CumPrepay  \\\n",
       "Date                                                                   \n",
       "2022-03-01  0.075        None          None        307.91          0   \n",
       "2022-04-01  0.075        None          None        617.74          0   \n",
       "2022-05-01  0.075        None          None        929.51          0   \n",
       "2022-06-01  0.075        None          None       1243.23          0   \n",
       "2022-07-01  0.075        None          None       1558.91          0   \n",
       "\n",
       "            CumDelinq  CumDefault  CumRecovery  CumLoss  \n",
       "Date                                                     \n",
       "2022-03-01          0           0            0        0  \n",
       "2022-04-01          0           0            0        0  \n",
       "2022-05-01          0           0            0        0  \n",
       "2022-06-01          0           0            0        0  \n",
       "2022-07-01          0           0            0        0  "
      ]
     },
     "execution_count": 11,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "r['mortgagePool']['flow'].head()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Set assumptions to the pools\n",
    "* passing a tuple with key ``ByPoolID`` to pool Assumption\n",
    "* a map with key equals to the name of pool"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "/home/xiaoyu/repo/AbsBox/lib/python3.13/site-packages/urllib3/connectionpool.py:1097: InsecureRequestWarning: Unverified HTTPS request is being made to host 'absbox.org'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#tls-warnings\n",
      "  warnings.warn(\n"
     ]
    }
   ],
   "source": [
    "mPoolAssump = (\"Pool\",\n",
    "               (\"Mortgage\",{\"CDR\":0.01},None,None,None)\n",
    "                ,None\n",
    "                ,None)\n",
    "\n",
    "iPoolAssump = (\"Pool\"\n",
    "                ,(\"Receivable\", {\"CDR\":0.01}, None, None)\n",
    "                ,None\n",
    "                ,None)\n",
    "\n",
    "\n",
    "r = localAPI.runPool(myMixedPool\n",
    "                  ,poolAssump = (\"ByPoolId\",\n",
    "                                    {\"invoicePool\":iPoolAssump\n",
    "                                    ,\"mortgagePool\":mPoolAssump}\n",
    "                                    )\n",
    "                  ,read=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 16,
   "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>Balance</th>\n",
       "      <th>AccuredFee</th>\n",
       "      <th>Principal</th>\n",
       "      <th>Fee</th>\n",
       "      <th>Default</th>\n",
       "      <th>Recovery</th>\n",
       "      <th>Loss</th>\n",
       "      <th>CumPrincipal</th>\n",
       "      <th>CumPrepay</th>\n",
       "      <th>CumDelinq</th>\n",
       "      <th>CumDefault</th>\n",
       "      <th>CumRecovery</th>\n",
       "      <th>CumLoss</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>Date</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>2024-04-01</th>\n",
       "      <td>2000</td>\n",
       "      <td>0</td>\n",
       "      <td>0.00</td>\n",
       "      <td>0</td>\n",
       "      <td>0.00</td>\n",
       "      <td>0</td>\n",
       "      <td>0.00</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0.00</td>\n",
       "      <td>0</td>\n",
       "      <td>0.00</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2024-06-01</th>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>1996.65</td>\n",
       "      <td>0</td>\n",
       "      <td>3.35</td>\n",
       "      <td>0</td>\n",
       "      <td>3.35</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>3.35</td>\n",
       "      <td>0</td>\n",
       "      <td>3.35</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "            Balance  AccuredFee  Principal  Fee  Default  Recovery  Loss  \\\n",
       "Date                                                                       \n",
       "2024-04-01     2000           0       0.00    0     0.00         0  0.00   \n",
       "2024-06-01        0           0    1996.65    0     3.35         0  3.35   \n",
       "\n",
       "            CumPrincipal  CumPrepay  CumDelinq  CumDefault  CumRecovery  \\\n",
       "Date                                                                      \n",
       "2024-04-01             0          0          0        0.00            0   \n",
       "2024-06-01             0          0          0        3.35            0   \n",
       "\n",
       "            CumLoss  \n",
       "Date                 \n",
       "2024-04-01     0.00  \n",
       "2024-06-01     3.35  "
      ]
     },
     "execution_count": 16,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "r['invoicePool']['flow'].head(5)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 17,
   "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>Balance</th>\n",
       "      <th>Principal</th>\n",
       "      <th>Interest</th>\n",
       "      <th>Prepayment</th>\n",
       "      <th>Default</th>\n",
       "      <th>Recovery</th>\n",
       "      <th>Loss</th>\n",
       "      <th>WAC</th>\n",
       "      <th>BorrowerNum</th>\n",
       "      <th>PrepayPenalty</th>\n",
       "      <th>CumPrincipal</th>\n",
       "      <th>CumPrepay</th>\n",
       "      <th>CumDelinq</th>\n",
       "      <th>CumDefault</th>\n",
       "      <th>CumRecovery</th>\n",
       "      <th>CumLoss</th>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>Date</th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "      <th></th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>2022-03-01</th>\n",
       "      <td>9059.53</td>\n",
       "      <td>307.14</td>\n",
       "      <td>58.54</td>\n",
       "      <td>0</td>\n",
       "      <td>7.22</td>\n",
       "      <td>0</td>\n",
       "      <td>7.22</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>307.14</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>7.22</td>\n",
       "      <td>0</td>\n",
       "      <td>7.22</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-04-01</th>\n",
       "      <td>8743.01</td>\n",
       "      <td>308.80</td>\n",
       "      <td>56.57</td>\n",
       "      <td>0</td>\n",
       "      <td>7.72</td>\n",
       "      <td>0</td>\n",
       "      <td>7.72</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>615.94</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>14.94</td>\n",
       "      <td>0</td>\n",
       "      <td>14.94</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-05-01</th>\n",
       "      <td>8425.32</td>\n",
       "      <td>310.48</td>\n",
       "      <td>54.59</td>\n",
       "      <td>0</td>\n",
       "      <td>7.21</td>\n",
       "      <td>0</td>\n",
       "      <td>7.21</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>926.42</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>22.15</td>\n",
       "      <td>0</td>\n",
       "      <td>22.15</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-06-01</th>\n",
       "      <td>8105.99</td>\n",
       "      <td>312.15</td>\n",
       "      <td>52.61</td>\n",
       "      <td>0</td>\n",
       "      <td>7.18</td>\n",
       "      <td>0</td>\n",
       "      <td>7.18</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1238.57</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>29.33</td>\n",
       "      <td>0</td>\n",
       "      <td>29.33</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2022-07-01</th>\n",
       "      <td>7785.46</td>\n",
       "      <td>313.84</td>\n",
       "      <td>50.62</td>\n",
       "      <td>0</td>\n",
       "      <td>6.69</td>\n",
       "      <td>0</td>\n",
       "      <td>6.69</td>\n",
       "      <td>0.075</td>\n",
       "      <td>None</td>\n",
       "      <td>None</td>\n",
       "      <td>1552.41</td>\n",
       "      <td>0</td>\n",
       "      <td>0</td>\n",
       "      <td>36.02</td>\n",
       "      <td>0</td>\n",
       "      <td>36.02</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "            Balance  Principal  Interest  Prepayment  Default  Recovery  Loss  \\\n",
       "Date                                                                            \n",
       "2022-03-01  9059.53     307.14     58.54           0     7.22         0  7.22   \n",
       "2022-04-01  8743.01     308.80     56.57           0     7.72         0  7.72   \n",
       "2022-05-01  8425.32     310.48     54.59           0     7.21         0  7.21   \n",
       "2022-06-01  8105.99     312.15     52.61           0     7.18         0  7.18   \n",
       "2022-07-01  7785.46     313.84     50.62           0     6.69         0  6.69   \n",
       "\n",
       "              WAC BorrowerNum PrepayPenalty  CumPrincipal  CumPrepay  \\\n",
       "Date                                                                   \n",
       "2022-03-01  0.075        None          None        307.14          0   \n",
       "2022-04-01  0.075        None          None        615.94          0   \n",
       "2022-05-01  0.075        None          None        926.42          0   \n",
       "2022-06-01  0.075        None          None       1238.57          0   \n",
       "2022-07-01  0.075        None          None       1552.41          0   \n",
       "\n",
       "            CumDelinq  CumDefault  CumRecovery  CumLoss  \n",
       "Date                                                     \n",
       "2022-03-01          0        7.22            0     7.22  \n",
       "2022-04-01          0       14.94            0    14.94  \n",
       "2022-05-01          0       22.15            0    22.15  \n",
       "2022-06-01          0       29.33            0    29.33  \n",
       "2022-07-01          0       36.02            0    36.02  "
      ]
     },
     "execution_count": 17,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "r['mortgagePool']['flow'].head(5)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "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.13.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}