docs/examples/Simple_Use_Case_Webinar.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [],
   "source": [
    "from datetime import datetime\n",
    "from vortexasdk import CargoMovements"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [],
   "source": [
    "dt = datetime(2017, 8, 1)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "2020-04-21 10:04:27,631 vortexasdk.operations — INFO — Searching CargoMovements with params: {'filter_activity': 'loading_state', 'filter_time_min': '2017-08-01T00:00:00.000Z', 'filter_time_max': '2017-08-01T00:00:00.000Z', 'timeseries_activity_time_span_min': None, 'timeseries_activity_time_span_max': None, 'cm_unit': 'b', 'filter_charterers': [], 'filter_owners': [], 'filter_products': [], 'filter_vessels': [], 'filter_destinations': [], 'filter_origins': [], 'filter_storage_locations': [], 'filter_ship_to_ship_locations': [], 'filter_waypoints': [], 'disable_geographic_exclusion_rules': None, 'size': 500}\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "\r",
      "Loading from API:   0%|          | 0/837 [00:00<?, ?it/s]"
     ]
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "2020-04-21 10:04:28,007 vortexasdk.client — INFO — 837 Results to retreive. Sending 2 post requests in parallel using 6 threads.\n"
     ]
    },
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "Loading from API: 1000it [00:01, 887.58it/s]             \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>events.cargo_port_load_event.0.location.port.label</th>\n",
       "      <th>events.cargo_port_unload_event.0.location.port.label</th>\n",
       "      <th>product.group.label</th>\n",
       "      <th>product.grade.label</th>\n",
       "      <th>quantity</th>\n",
       "      <th>vessels.0.name</th>\n",
       "      <th>events.cargo_port_load_event.0.end_timestamp</th>\n",
       "      <th>events.cargo_port_unload_event.0.start_timestamp</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>Baton Rouge, LA [US]</td>\n",
       "      <td>La Libertad [EC]</td>\n",
       "      <td>Clean Petroleum Products</td>\n",
       "      <td>NaN</td>\n",
       "      <td>218878</td>\n",
       "      <td>CANAL STREET</td>\n",
       "      <td>2017-08-01T21:14:22+0000</td>\n",
       "      <td>2017-08-21T21:22:22+0000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>Taman [RU]</td>\n",
       "      <td>Augusta [IT]</td>\n",
       "      <td>Dirty Petroleum Products</td>\n",
       "      <td>NaN</td>\n",
       "      <td>201896</td>\n",
       "      <td>NAFTILOS AN</td>\n",
       "      <td>2017-08-02T09:59:28+0000</td>\n",
       "      <td>2017-08-11T11:54:11+0000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>NaN</td>\n",
       "      <td>Ceyhan [TR]</td>\n",
       "      <td>Clean Petroleum Products</td>\n",
       "      <td>NaN</td>\n",
       "      <td>265756</td>\n",
       "      <td>VIKTOR BAKAEV</td>\n",
       "      <td>NaN</td>\n",
       "      <td>2017-08-10T08:41:59+0000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>Malacca (Melaka) [MY]</td>\n",
       "      <td>Port Kelang [MY]</td>\n",
       "      <td>Dirty Petroleum Products</td>\n",
       "      <td>NaN</td>\n",
       "      <td>18944</td>\n",
       "      <td>M T SIDRA MESSAIED</td>\n",
       "      <td>2017-08-03T11:31:56+0000</td>\n",
       "      <td>2017-08-03T21:04:35+0000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>Yeosu (Yosu), Gwangyang [KR]</td>\n",
       "      <td>Barbers Point-Honolulu, HI [US]</td>\n",
       "      <td>Crude/Condensates</td>\n",
       "      <td>Sokol (Sakhalin I)</td>\n",
       "      <td>720729</td>\n",
       "      <td>NEW ACCORD</td>\n",
       "      <td>2017-08-02T01:29:38+0000</td>\n",
       "      <td>2017-08-18T19:55:31+0000</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>832</th>\n",
       "      <td>Ulsan, Onsan [KR]</td>\n",
       "      <td>Pinghu, Jiaxing [CN]</td>\n",
       "      <td>Clean Petroleum Products</td>\n",
       "      <td>NaN</td>\n",
       "      <td>13453</td>\n",
       "      <td>NO.9 SJGAS</td>\n",
       "      <td>2017-08-01T02:34:47+0000</td>\n",
       "      <td>2017-08-05T03:55:49+0000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>833</th>\n",
       "      <td>Houston, TX [US]</td>\n",
       "      <td>Wakayama [JP]</td>\n",
       "      <td>Clean Petroleum Products</td>\n",
       "      <td>NaN</td>\n",
       "      <td>87855</td>\n",
       "      <td>IVY EXPRESS</td>\n",
       "      <td>2017-08-01T17:36:03+0000</td>\n",
       "      <td>2017-09-08T02:32:18+0000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>834</th>\n",
       "      <td>Le Havre [FR]</td>\n",
       "      <td>Alexandria [EG]</td>\n",
       "      <td>Clean Petroleum Products</td>\n",
       "      <td>NaN</td>\n",
       "      <td>4805</td>\n",
       "      <td>ALSIA SWAN</td>\n",
       "      <td>2017-08-01T06:10:45+0000</td>\n",
       "      <td>2017-08-12T19:37:38+0000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>835</th>\n",
       "      <td>Yeosu (Yosu), Gwangyang [KR]</td>\n",
       "      <td>Rotterdam [NL]</td>\n",
       "      <td>Clean Petroleum Products</td>\n",
       "      <td>Jet A-1</td>\n",
       "      <td>275046</td>\n",
       "      <td>EAGLE LYON</td>\n",
       "      <td>2017-08-07T03:10:21+0000</td>\n",
       "      <td>2017-09-15T00:07:54+0000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>836</th>\n",
       "      <td>Yeosu (Yosu), Gwangyang [KR]</td>\n",
       "      <td>Ulsan, Onsan [KR]</td>\n",
       "      <td>Clean Petroleum Products</td>\n",
       "      <td>NaN</td>\n",
       "      <td>46720</td>\n",
       "      <td>WOOJIN KELLY</td>\n",
       "      <td>2017-08-01T17:06:12+0000</td>\n",
       "      <td>2017-08-02T04:28:11+0000</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>837 rows × 8 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "    events.cargo_port_load_event.0.location.port.label  \\\n",
       "0                                 Baton Rouge, LA [US]   \n",
       "1                                           Taman [RU]   \n",
       "2                                                  NaN   \n",
       "3                                Malacca (Melaka) [MY]   \n",
       "4                         Yeosu (Yosu), Gwangyang [KR]   \n",
       "..                                                 ...   \n",
       "832                                  Ulsan, Onsan [KR]   \n",
       "833                                   Houston, TX [US]   \n",
       "834                                      Le Havre [FR]   \n",
       "835                       Yeosu (Yosu), Gwangyang [KR]   \n",
       "836                       Yeosu (Yosu), Gwangyang [KR]   \n",
       "\n",
       "    events.cargo_port_unload_event.0.location.port.label  \\\n",
       "0                                     La Libertad [EC]     \n",
       "1                                         Augusta [IT]     \n",
       "2                                          Ceyhan [TR]     \n",
       "3                                     Port Kelang [MY]     \n",
       "4                      Barbers Point-Honolulu, HI [US]     \n",
       "..                                                 ...     \n",
       "832                               Pinghu, Jiaxing [CN]     \n",
       "833                                      Wakayama [JP]     \n",
       "834                                    Alexandria [EG]     \n",
       "835                                     Rotterdam [NL]     \n",
       "836                                  Ulsan, Onsan [KR]     \n",
       "\n",
       "          product.group.label product.grade.label  quantity  \\\n",
       "0    Clean Petroleum Products                 NaN    218878   \n",
       "1    Dirty Petroleum Products                 NaN    201896   \n",
       "2    Clean Petroleum Products                 NaN    265756   \n",
       "3    Dirty Petroleum Products                 NaN     18944   \n",
       "4           Crude/Condensates  Sokol (Sakhalin I)    720729   \n",
       "..                        ...                 ...       ...   \n",
       "832  Clean Petroleum Products                 NaN     13453   \n",
       "833  Clean Petroleum Products                 NaN     87855   \n",
       "834  Clean Petroleum Products                 NaN      4805   \n",
       "835  Clean Petroleum Products             Jet A-1    275046   \n",
       "836  Clean Petroleum Products                 NaN     46720   \n",
       "\n",
       "         vessels.0.name events.cargo_port_load_event.0.end_timestamp  \\\n",
       "0          CANAL STREET                     2017-08-01T21:14:22+0000   \n",
       "1           NAFTILOS AN                     2017-08-02T09:59:28+0000   \n",
       "2         VIKTOR BAKAEV                                          NaN   \n",
       "3    M T SIDRA MESSAIED                     2017-08-03T11:31:56+0000   \n",
       "4            NEW ACCORD                     2017-08-02T01:29:38+0000   \n",
       "..                  ...                                          ...   \n",
       "832          NO.9 SJGAS                     2017-08-01T02:34:47+0000   \n",
       "833         IVY EXPRESS                     2017-08-01T17:36:03+0000   \n",
       "834          ALSIA SWAN                     2017-08-01T06:10:45+0000   \n",
       "835          EAGLE LYON                     2017-08-07T03:10:21+0000   \n",
       "836        WOOJIN KELLY                     2017-08-01T17:06:12+0000   \n",
       "\n",
       "    events.cargo_port_unload_event.0.start_timestamp  \n",
       "0                           2017-08-21T21:22:22+0000  \n",
       "1                           2017-08-11T11:54:11+0000  \n",
       "2                           2017-08-10T08:41:59+0000  \n",
       "3                           2017-08-03T21:04:35+0000  \n",
       "4                           2017-08-18T19:55:31+0000  \n",
       "..                                               ...  \n",
       "832                         2017-08-05T03:55:49+0000  \n",
       "833                         2017-09-08T02:32:18+0000  \n",
       "834                         2017-08-12T19:37:38+0000  \n",
       "835                         2017-09-15T00:07:54+0000  \n",
       "836                         2017-08-02T04:28:11+0000  \n",
       "\n",
       "[837 rows x 8 columns]"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "CargoMovements().search(filter_time_max=dt, filter_time_min=dt, filter_activity=\"loading_state\").to_df()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "\tvessels.2.name"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "python-sdk",
   "language": "python",
   "name": "python-sdk"
  },
  "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.7.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}