Examples/2-Content/2.06-Search/EX-2.06.01-Search.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "----\n",
    "<img src=\"../../../files/refinitiv.png\" width=\"20%\" style=\"vertical-align: top;\">\n",
    "\n",
    "# Data Library for Python\n",
    "\n",
    "----"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Content layer - Search\n",
    "This notebook demonstrates how to use the Search service of the Refinitiv Data Platform."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Learn more\n",
    "\n",
    "To learn more about the Refinitiv Data Library for Python please join the Refinitiv Developer Community. By [registering](https://developers.refinitiv.com/iam/register) and [logging](https://developers.refinitiv.com/content/devportal/en_us/initCookie.html) into the Refinitiv Developer Community portal you will have free access to a number of learning materials like \n",
    " [Quick Start guides](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-library-for-python/quick-start), \n",
    " [Tutorials](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-library-for-python/learning), \n",
    " [Documentation](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-library-for-python/docs)\n",
    " and much more.\n",
    "\n",
    "#### Getting Help and Support\n",
    "\n",
    "If you have any questions regarding using the API, please post them on \n",
    "the [Refinitiv Data Q&A Forum](https://community.developers.refinitiv.com/spaces/321/index.html). \n",
    "The Refinitiv Developer Community will be happy to help. "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Set the configuration file location\n",
    "For a better ease of use, you have the option to set initialization parameters of the Refinitiv Data Library in the _refinitiv-data.config.json_ configuration file. This file must be located beside your notebook, in your user folder or in a folder defined by the _RD_LIB_CONFIG_PATH_ environment variable. The _RD_LIB_CONFIG_PATH_ environment variable is the option used by this series of examples. The following code sets this environment variable.      "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "import os\n",
    "os.environ[\"RD_LIB_CONFIG_PATH\"] = \"../../../Configuration\""
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Some Imports to start with"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "import refinitiv.data as rd\n",
    "from refinitiv.data.content import search"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Open the data session\n",
    "\n",
    "The open_session() function creates and open sessions based on the information contained in the refinitiv-data.config.json configuration file. Please edit this file to set the session type and other parameters required for the session you want to open."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "<refinitiv.data.session.Definition object at 0x7fb9f6d39f10 {name='workspace'}>"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "rd.open_session()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Retrieve data"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### General Search"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "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>BusinessEntity</th>\n",
       "      <th>DocumentTitle</th>\n",
       "      <th>PermID</th>\n",
       "      <th>PI</th>\n",
       "      <th>RIC</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>46637038358</td>\n",
       "      <td>0x00102c80bf6b046c</td>\n",
       "      <td>459200JC6=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>192826899363</td>\n",
       "      <td>0x00102c53ff1f1897</td>\n",
       "      <td>US194445601=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>44657843041</td>\n",
       "      <td>0x0004051bd47954e3</td>\n",
       "      <td>US114316318=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>44649129642</td>\n",
       "      <td>0x00040513a4865c6c</td>\n",
       "      <td>459200HP9=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>44653695161</td>\n",
       "      <td>0x00040517bba31719</td>\n",
       "      <td>459200HU8=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>192841929400</td>\n",
       "      <td>0x00102c2052251a71</td>\n",
       "      <td>459200JY8=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>46638470074</td>\n",
       "      <td>0x00102cf964da067d</td>\n",
       "      <td>US137584123=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>192826895881</td>\n",
       "      <td>0x00102c8de61f1850</td>\n",
       "      <td>US194445610=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>46644611190</td>\n",
       "      <td>0x00102c00c0900d61</td>\n",
       "      <td>US161784508=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>232796002153</td>\n",
       "      <td>0x00102cfffd953398</td>\n",
       "      <td>459200KS9=</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "                   BusinessEntity  \\\n",
       "0  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "1  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "2  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "3  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "4  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "5  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "6  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "7  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "8  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "9  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "\n",
       "                                       DocumentTitle        PermID  \\\n",
       "0  International Business Machines Corp, Plain Va...   46637038358   \n",
       "1  International Business Machines Corp, Plain Va...  192826899363   \n",
       "2  International Business Machines Corp, Plain Va...   44657843041   \n",
       "3  International Business Machines Corp, Plain Va...   44649129642   \n",
       "4  International Business Machines Corp, Plain Va...   44653695161   \n",
       "5  International Business Machines Corp, Plain Va...  192841929400   \n",
       "6  International Business Machines Corp, Plain Va...   46638470074   \n",
       "7  International Business Machines Corp, Plain Va...  192826895881   \n",
       "8  International Business Machines Corp, Plain Va...   46644611190   \n",
       "9  International Business Machines Corp, Plain Va...  232796002153   \n",
       "\n",
       "                   PI           RIC  \n",
       "0  0x00102c80bf6b046c    459200JC6=  \n",
       "1  0x00102c53ff1f1897  US194445601=  \n",
       "2  0x0004051bd47954e3  US114316318=  \n",
       "3  0x00040513a4865c6c    459200HP9=  \n",
       "4  0x00040517bba31719    459200HU8=  \n",
       "5  0x00102c2052251a71    459200JY8=  \n",
       "6  0x00102cf964da067d  US137584123=  \n",
       "7  0x00102c8de61f1850  US194445610=  \n",
       "8  0x00102c00c0900d61  US161784508=  \n",
       "9  0x00102cfffd953398    459200KS9=  "
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.Definition(\"IBM Bonds\").get_data()\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Specify number of rows to fetch"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {
    "tags": []
   },
   "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>BusinessEntity</th>\n",
       "      <th>DocumentTitle</th>\n",
       "      <th>PermID</th>\n",
       "      <th>PI</th>\n",
       "      <th>RIC</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>46637038358</td>\n",
       "      <td>0x00102c80bf6b046c</td>\n",
       "      <td>459200JC6=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>192826899363</td>\n",
       "      <td>0x00102c53ff1f1897</td>\n",
       "      <td>US194445601=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>44657843041</td>\n",
       "      <td>0x0004051bd47954e3</td>\n",
       "      <td>US114316318=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>44649129642</td>\n",
       "      <td>0x00040513a4865c6c</td>\n",
       "      <td>459200HP9=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>International Business Machines Corp, Plain Va...</td>\n",
       "      <td>44653695161</td>\n",
       "      <td>0x00040517bba31719</td>\n",
       "      <td>459200HU8=</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>95</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "      <td>0x000034000037dfdc</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>96</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "      <td>0x000034000037e0e3</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>97</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "      <td>0x000034000037e1e2</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>98</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "      <td>0x000034000037e3e0</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>99</th>\n",
       "      <td>INSTRUMENTxFIXEDINCOMExGOVCORP</td>\n",
       "      <td>IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "      <td>0x000034000037e4e7</td>\n",
       "      <td>&lt;NA&gt;</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>100 rows × 5 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                    BusinessEntity  \\\n",
       "0   INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "1   INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "2   INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "3   INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "4   INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "..                             ...   \n",
       "95  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "96  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "97  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "98  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "99  INSTRUMENTxFIXEDINCOMExGOVCORP   \n",
       "\n",
       "                                        DocumentTitle        PermID  \\\n",
       "0   International Business Machines Corp, Plain Va...   46637038358   \n",
       "1   International Business Machines Corp, Plain Va...  192826899363   \n",
       "2   International Business Machines Corp, Plain Va...   44657843041   \n",
       "3   International Business Machines Corp, Plain Va...   44649129642   \n",
       "4   International Business Machines Corp, Plain Va...   44653695161   \n",
       "..                                                ...           ...   \n",
       "95  IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...          <NA>   \n",
       "96  IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...          <NA>   \n",
       "97  IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...          <NA>   \n",
       "98  IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...          <NA>   \n",
       "99  IBM Credit LLC, Plain Vanilla Fixed Coupon Bon...          <NA>   \n",
       "\n",
       "                    PI           RIC  \n",
       "0   0x00102c80bf6b046c    459200JC6=  \n",
       "1   0x00102c53ff1f1897  US194445601=  \n",
       "2   0x0004051bd47954e3  US114316318=  \n",
       "3   0x00040513a4865c6c    459200HP9=  \n",
       "4   0x00040517bba31719    459200HU8=  \n",
       "..                 ...           ...  \n",
       "95  0x000034000037dfdc          <NA>  \n",
       "96  0x000034000037e0e3          <NA>  \n",
       "97  0x000034000037e1e2          <NA>  \n",
       "98  0x000034000037e3e0          <NA>  \n",
       "99  0x000034000037e4e7          <NA>  \n",
       "\n",
       "[100 rows x 5 columns]"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.Definition(\"IBM Bonds\", top=100).get_data()\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Filter Expressions"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "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>ISIN</th>\n",
       "      <th>RIC</th>\n",
       "      <th>IssueDate</th>\n",
       "      <th>Currency</th>\n",
       "      <th>FaceIssuedTotal</th>\n",
       "      <th>CouponRate</th>\n",
       "      <th>MaturityDate</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>US459200JC60</td>\n",
       "      <td>459200JC6=</td>\n",
       "      <td>2015-11-09</td>\n",
       "      <td>USD</td>\n",
       "      <td>900000000</td>\n",
       "      <td>2.875</td>\n",
       "      <td>2022-11-09</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>XS1944456018</td>\n",
       "      <td>US194445601=</td>\n",
       "      <td>2019-01-31</td>\n",
       "      <td>EUR</td>\n",
       "      <td>1750000000</td>\n",
       "      <td>0.375</td>\n",
       "      <td>2023-01-31</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>XS1143163183</td>\n",
       "      <td>US114316318=</td>\n",
       "      <td>2014-11-26</td>\n",
       "      <td>EUR</td>\n",
       "      <td>1000000000</td>\n",
       "      <td>1.25</td>\n",
       "      <td>2023-05-26</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>US459200HP91</td>\n",
       "      <td>459200HP9=</td>\n",
       "      <td>2013-08-01</td>\n",
       "      <td>USD</td>\n",
       "      <td>1500000000</td>\n",
       "      <td>3.375</td>\n",
       "      <td>2023-08-01</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>US459200HU86</td>\n",
       "      <td>459200HU8=</td>\n",
       "      <td>2014-02-12</td>\n",
       "      <td>USD</td>\n",
       "      <td>2000000000</td>\n",
       "      <td>3.625</td>\n",
       "      <td>2024-02-12</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>US459200JY80</td>\n",
       "      <td>459200JY8=</td>\n",
       "      <td>2019-05-15</td>\n",
       "      <td>USD</td>\n",
       "      <td>3000000000</td>\n",
       "      <td>3.0</td>\n",
       "      <td>2024-05-15</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>XS1375841233</td>\n",
       "      <td>US137584123=</td>\n",
       "      <td>2016-03-07</td>\n",
       "      <td>EUR</td>\n",
       "      <td>750000000</td>\n",
       "      <td>1.125</td>\n",
       "      <td>2024-09-06</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>XS1944456109</td>\n",
       "      <td>US194445610=</td>\n",
       "      <td>2019-01-31</td>\n",
       "      <td>EUR</td>\n",
       "      <td>1000000000</td>\n",
       "      <td>0.875</td>\n",
       "      <td>2025-01-31</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>XS1617845083</td>\n",
       "      <td>US161784508=</td>\n",
       "      <td>2017-05-23</td>\n",
       "      <td>EUR</td>\n",
       "      <td>1000000000</td>\n",
       "      <td>0.95</td>\n",
       "      <td>2025-05-23</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>US459200KS93</td>\n",
       "      <td>459200KS9=</td>\n",
       "      <td>2022-07-27</td>\n",
       "      <td>USD</td>\n",
       "      <td>1000000000</td>\n",
       "      <td>4.0</td>\n",
       "      <td>2025-07-27</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "           ISIN           RIC  IssueDate Currency  FaceIssuedTotal  \\\n",
       "0  US459200JC60    459200JC6= 2015-11-09      USD        900000000   \n",
       "1  XS1944456018  US194445601= 2019-01-31      EUR       1750000000   \n",
       "2  XS1143163183  US114316318= 2014-11-26      EUR       1000000000   \n",
       "3  US459200HP91    459200HP9= 2013-08-01      USD       1500000000   \n",
       "4  US459200HU86    459200HU8= 2014-02-12      USD       2000000000   \n",
       "5  US459200JY80    459200JY8= 2019-05-15      USD       3000000000   \n",
       "6  XS1375841233  US137584123= 2016-03-07      EUR        750000000   \n",
       "7  XS1944456109  US194445610= 2019-01-31      EUR       1000000000   \n",
       "8  XS1617845083  US161784508= 2017-05-23      EUR       1000000000   \n",
       "9  US459200KS93    459200KS9= 2022-07-27      USD       1000000000   \n",
       "\n",
       "   CouponRate MaturityDate  \n",
       "0       2.875   2022-11-09  \n",
       "1       0.375   2023-01-31  \n",
       "2        1.25   2023-05-26  \n",
       "3       3.375   2023-08-01  \n",
       "4       3.625   2024-02-12  \n",
       "5         3.0   2024-05-15  \n",
       "6       1.125   2024-09-06  \n",
       "7       0.875   2025-01-31  \n",
       "8        0.95   2025-05-23  \n",
       "9         4.0   2025-07-27  "
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.Definition(\n",
    "    view=search.Views.GOV_CORP_INSTRUMENTS,\n",
    "    select=\"ISIN,RIC,IssueDate,Currency,FaceIssuedTotal,CouponRate,MaturityDate\", \n",
    "    filter=\"IssuerTicker eq 'IBM' and IsActive eq true and AssetStatus ne 'MAT'\"\n",
    ").get_data()\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Properties - Metadata"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "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></th>\n",
       "      <th>Type</th>\n",
       "      <th>Searchable</th>\n",
       "      <th>Sortable</th>\n",
       "      <th>Navigable</th>\n",
       "      <th>Groupable</th>\n",
       "      <th>Exact</th>\n",
       "      <th>Symbol</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>AccrualDate</th>\n",
       "      <th>AccrualDate</th>\n",
       "      <td>Date</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>AccruedInterest</th>\n",
       "      <th>AccruedInterest</th>\n",
       "      <td>Double</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>ActiveEstimatesExist</th>\n",
       "      <th>ActiveEstimatesExist</th>\n",
       "      <td>Boolean</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>AdtLocalCurrencyValue</th>\n",
       "      <th>AdtLocalCurrencyValue</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>AdtLocalCurrencyValueName</th>\n",
       "      <th>AdtLocalCurrencyValueName</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\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",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>WorstStandardYield</th>\n",
       "      <th>WorstStandardYield</th>\n",
       "      <td>Double</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>WorstYearsToRedem</th>\n",
       "      <th>WorstYearsToRedem</th>\n",
       "      <td>Double</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>YieldCurveBenchmarkRIC</th>\n",
       "      <th>YieldCurveBenchmarkRIC</th>\n",
       "      <td>String</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>YieldTypeDescription</th>\n",
       "      <th>YieldTypeDescription</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>ZCodeValue</th>\n",
       "      <th>ZCodeValue</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>1129 rows × 7 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                                                        Type  Searchable  \\\n",
       "AccrualDate               AccrualDate                   Date        True   \n",
       "AccruedInterest           AccruedInterest             Double        True   \n",
       "ActiveEstimatesExist      ActiveEstimatesExist       Boolean        True   \n",
       "AdtLocalCurrencyValue     AdtLocalCurrencyValue       String        True   \n",
       "AdtLocalCurrencyValueName AdtLocalCurrencyValueName   String        True   \n",
       "...                                                      ...         ...   \n",
       "WorstStandardYield        WorstStandardYield          Double        True   \n",
       "WorstYearsToRedem         WorstYearsToRedem           Double        True   \n",
       "YieldCurveBenchmarkRIC    YieldCurveBenchmarkRIC      String       False   \n",
       "YieldTypeDescription      YieldTypeDescription        String        True   \n",
       "ZCodeValue                ZCodeValue                  String        True   \n",
       "\n",
       "                                                     Sortable  Navigable  \\\n",
       "AccrualDate               AccrualDate                    True       True   \n",
       "AccruedInterest           AccruedInterest                True       True   \n",
       "ActiveEstimatesExist      ActiveEstimatesExist          False      False   \n",
       "AdtLocalCurrencyValue     AdtLocalCurrencyValue         False      False   \n",
       "AdtLocalCurrencyValueName AdtLocalCurrencyValueName     False      False   \n",
       "...                                                       ...        ...   \n",
       "WorstStandardYield        WorstStandardYield             True       True   \n",
       "WorstYearsToRedem         WorstYearsToRedem              True       True   \n",
       "YieldCurveBenchmarkRIC    YieldCurveBenchmarkRIC        False      False   \n",
       "YieldTypeDescription      YieldTypeDescription          False      False   \n",
       "ZCodeValue                ZCodeValue                     True      False   \n",
       "\n",
       "                                                     Groupable  Exact  Symbol  \n",
       "AccrualDate               AccrualDate                    False  False   False  \n",
       "AccruedInterest           AccruedInterest                False  False   False  \n",
       "ActiveEstimatesExist      ActiveEstimatesExist           False  False   False  \n",
       "AdtLocalCurrencyValue     AdtLocalCurrencyValue          False  False   False  \n",
       "AdtLocalCurrencyValueName AdtLocalCurrencyValueName      False  False   False  \n",
       "...                                                        ...    ...     ...  \n",
       "WorstStandardYield        WorstStandardYield             False  False   False  \n",
       "WorstYearsToRedem         WorstYearsToRedem              False  False   False  \n",
       "YieldCurveBenchmarkRIC    YieldCurveBenchmarkRIC         False  False   False  \n",
       "YieldTypeDescription      YieldTypeDescription           False  False   False  \n",
       "ZCodeValue                ZCodeValue                      True  False    True  \n",
       "\n",
       "[1129 rows x 7 columns]"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.metadata.Definition(\n",
    "    view = search.Views.GOV_CORP_INSTRUMENTS  # Required parameterc\n",
    ").get_data() \n",
    "\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Navigators"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = search.Definition(\n",
    "    top=0,\n",
    "    navigators=\"RCSTRBC2012Leaf\"\n",
    ").get_data()\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Search with Navigator option"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "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>BusinessEntity</th>\n",
       "      <th>DocumentTitle</th>\n",
       "      <th>PermID</th>\n",
       "      <th>PI</th>\n",
       "      <th>RIC</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>CME Cash Settled Cheese Electronic Commodity F...</td>\n",
       "      <td>21622940491</td>\n",
       "      <td>273610776</td>\n",
       "      <td>CSCc1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>Cash Settled Cheese Futures Chain Contracts, C...</td>\n",
       "      <td>21622425217</td>\n",
       "      <td>272623267</td>\n",
       "      <td>0#CSC:</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>CME Cash Settled Cheese Electronic Commodity F...</td>\n",
       "      <td>21757842054</td>\n",
       "      <td>444997903</td>\n",
       "      <td>CSCM2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>CME Cash Settled Cheese Electronic Commodity F...</td>\n",
       "      <td>21772665846</td>\n",
       "      <td>463861357</td>\n",
       "      <td>CSCU2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>CME Cash Settled Cheese Electronic Commodity F...</td>\n",
       "      <td>21767494118</td>\n",
       "      <td>457131738</td>\n",
       "      <td>CSCQ2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>CME Cash Settled Cheese Electronic Commodity F...</td>\n",
       "      <td>21778821217</td>\n",
       "      <td>471517057</td>\n",
       "      <td>CSCV2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>CME Cash Settled Cheese Electronic Commodity F...</td>\n",
       "      <td>21784277336</td>\n",
       "      <td>478150068</td>\n",
       "      <td>CSCX2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>CME Cash Settled Cheese Electronic Commodity F...</td>\n",
       "      <td>21790857663</td>\n",
       "      <td>485909287</td>\n",
       "      <td>CSCZ2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>CME Cash Settled Cheese Electronic Commodity F...</td>\n",
       "      <td>21801133645</td>\n",
       "      <td>498573458</td>\n",
       "      <td>CSCG3</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>QUOTExCOMMODITY</td>\n",
       "      <td>CME Cash Settled Cheese Electronic Commodity F...</td>\n",
       "      <td>21819204534</td>\n",
       "      <td>520638487</td>\n",
       "      <td>CSCM3</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "    BusinessEntity                                      DocumentTitle  \\\n",
       "0  QUOTExCOMMODITY  CME Cash Settled Cheese Electronic Commodity F...   \n",
       "1  QUOTExCOMMODITY  Cash Settled Cheese Futures Chain Contracts, C...   \n",
       "2  QUOTExCOMMODITY  CME Cash Settled Cheese Electronic Commodity F...   \n",
       "3  QUOTExCOMMODITY  CME Cash Settled Cheese Electronic Commodity F...   \n",
       "4  QUOTExCOMMODITY  CME Cash Settled Cheese Electronic Commodity F...   \n",
       "5  QUOTExCOMMODITY  CME Cash Settled Cheese Electronic Commodity F...   \n",
       "6  QUOTExCOMMODITY  CME Cash Settled Cheese Electronic Commodity F...   \n",
       "7  QUOTExCOMMODITY  CME Cash Settled Cheese Electronic Commodity F...   \n",
       "8  QUOTExCOMMODITY  CME Cash Settled Cheese Electronic Commodity F...   \n",
       "9  QUOTExCOMMODITY  CME Cash Settled Cheese Electronic Commodity F...   \n",
       "\n",
       "        PermID         PI     RIC  \n",
       "0  21622940491  273610776   CSCc1  \n",
       "1  21622425217  272623267  0#CSC:  \n",
       "2  21757842054  444997903   CSCM2  \n",
       "3  21772665846  463861357   CSCU2  \n",
       "4  21767494118  457131738   CSCQ2  \n",
       "5  21778821217  471517057   CSCV2  \n",
       "6  21784277336  478150068   CSCX2  \n",
       "7  21790857663  485909287   CSCZ2  \n",
       "8  21801133645  498573458   CSCG3  \n",
       "9  21819204534  520638487   CSCM3  "
      ]
     },
     "execution_count": 9,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.Definition(\n",
    "    view=search.Views.COMMODITY_QUOTES,\n",
    "    query=\"cheese\",\n",
    "    navigators=\"ExchangeName\"\n",
    ").get_data()\n",
    "\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'Buckets': [{'Label': 'CME:Index and Options Market', 'Count': 17677},\n",
       "  {'Label': 'Chicago Mercantile Exchange', 'Count': 3001},\n",
       "  {'Label': 'INTL FCStone Inc', 'Count': 2550},\n",
       "  {'Label': 'Source is a Refinitiv Contributor', 'Count': 1498},\n",
       "  {'Label': 'US Department of Agriculture', 'Count': 101},\n",
       "  {'Label': 'Commodity Futures Trading Commission', 'Count': 66},\n",
       "  {'Label': 'Complete Intelligence', 'Count': 51},\n",
       "  {'Label': 'Intercontinental Exchange US', 'Count': 31},\n",
       "  {'Label': 'US Bureau Of Labor Statistics', 'Count': 10},\n",
       "  {'Label': 'European Energy Exchange', 'Count': 9},\n",
       "  {'Label': 'DCA Markets B.V. - DCA-Markets-PRA Price Reporting Agent',\n",
       "   'Count': 4},\n",
       "  {'Label': 'European Commission', 'Count': 3},\n",
       "  {'Label': 'ESALQ', 'Count': 2},\n",
       "  {'Label': 'CME:International Monetary Market', 'Count': 1}]}"
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.data.raw[\"Navigators\"]['ExchangeName']"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'Total': 11494208,\n",
       " 'Hits': [],\n",
       " 'Navigators': {'Currency': {'Buckets': [{'Label': 'USD',\n",
       "     'Count': 3763389,\n",
       "     'max_CouponRate': 1800.0,\n",
       "     'sum_FaceOutstandingUSD': 49438954323649.78},\n",
       "    {'Label': 'EUR',\n",
       "     'Count': 1093746,\n",
       "     'max_CouponRate': 500.0,\n",
       "     'sum_FaceOutstandingUSD': 21527212316149.0},\n",
       "    {'Label': 'CNY',\n",
       "     'Count': 342663,\n",
       "     'max_CouponRate': 72.0,\n",
       "     'sum_FaceOutstandingUSD': 20044978882106.297},\n",
       "    {'Label': 'JPY',\n",
       "     'Count': 471204,\n",
       "     'max_CouponRate': 632.0,\n",
       "     'sum_FaceOutstandingUSD': 10901404501957.016},\n",
       "    {'Label': 'GBP',\n",
       "     'Count': 200667,\n",
       "     'max_CouponRate': 120.0,\n",
       "     'sum_FaceOutstandingUSD': 4186088564763.0},\n",
       "    {'Label': 'CAD',\n",
       "     'Count': 321134,\n",
       "     'max_CouponRate': 100.0,\n",
       "     'sum_FaceOutstandingUSD': 2573047806153.0},\n",
       "    {'Label': 'INR',\n",
       "     'Count': 112945,\n",
       "     'max_CouponRate': 42.75,\n",
       "     'sum_FaceOutstandingUSD': 2497247939348.0},\n",
       "    {'Label': 'KRW',\n",
       "     'Count': 400869,\n",
       "     'max_CouponRate': 46.41,\n",
       "     'sum_FaceOutstandingUSD': 2140298006081.0},\n",
       "    {'Label': 'AUD',\n",
       "     'Count': 149976,\n",
       "     'max_CouponRate': 120.96,\n",
       "     'sum_FaceOutstandingUSD': 1571159285514.6873},\n",
       "    {'Label': 'BRL',\n",
       "     'Count': 68846,\n",
       "     'max_CouponRate': 108.5,\n",
       "     'sum_FaceOutstandingUSD': 1388815848653.7607}]}}}"
      ]
     },
     "execution_count": 11,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.Definition(\n",
    "    view=search.Views.GOV_CORP_INSTRUMENTS,\n",
    "    top=0,\n",
    "    navigators=\"Currency(buckets:10,desc:sum_FaceOutstandingUSD,calc:max_CouponRate)\"\n",
    ").get_data()\n",
    "\n",
    "response.data.raw"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Sub-navigator"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'Label': 'John',\n",
       "  'Count': 41492,\n",
       "  'LastName': {'Buckets': [{'Label': 'Wilson', 'Count': 110},\n",
       "    {'Label': 'Lee', 'Count': 107}]}},\n",
       " {'Label': 'David',\n",
       "  'Count': 40465,\n",
       "  'LastName': {'Buckets': [{'Label': 'Smith', 'Count': 239},\n",
       "    {'Label': 'Williams', 'Count': 164}]}},\n",
       " {'Label': 'Michael',\n",
       "  'Count': 38945,\n",
       "  'LastName': {'Buckets': [{'Label': 'Smith', 'Count': 186},\n",
       "    {'Label': 'Brown', 'Count': 126}]}}]"
      ]
     },
     "execution_count": 12,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.Definition(\n",
    "    view=search.Views.PEOPLE,\n",
    "    top=0,\n",
    "    navigators=\"FirstName(buckets:3,sub:LastName(buckets:2))\"\n",
    ").get_data()\n",
    "\n",
    "response.data.raw[\"Navigators\"][\"FirstName\"][\"Buckets\"]"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Search with order_by option"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {
    "scrolled": true
   },
   "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>YearOfBirth</th>\n",
       "      <th>DocumentTitle</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>1996</td>\n",
       "      <td>Hiroyasu Saito - Gracia Inc - Chief Executive ...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>1996</td>\n",
       "      <td>Shu Yao - Dongjiang Environmental Co Ltd - Ex-...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>1994</td>\n",
       "      <td>Connor Campbell - Osler Diagnostics Ltd - Chie...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>1993</td>\n",
       "      <td>Yiduitakuya Iwamoto - Polyuse Inc - Chief Exec...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>1993</td>\n",
       "      <td>Alberto Rizzoli - V7 Ltd - Chief Executive Off...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>1993</td>\n",
       "      <td>Tongda Wu - Paifang Technology Tianjin Co Ltd ...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>1992</td>\n",
       "      <td>Ross Bailey - Appear Here Ltd - Chief Executiv...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>1992</td>\n",
       "      <td>Christian Besenbruch - Deep Render Ltd - Chief...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>1992</td>\n",
       "      <td>Ed Leon Klinger - Flock Ltd - Chief Executive ...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>1992</td>\n",
       "      <td>Snigdha Mothukuri - Jeevan Scientific Technolo...</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "   YearOfBirth                                      DocumentTitle\n",
       "0         1996  Hiroyasu Saito - Gracia Inc - Chief Executive ...\n",
       "1         1996  Shu Yao - Dongjiang Environmental Co Ltd - Ex-...\n",
       "2         1994  Connor Campbell - Osler Diagnostics Ltd - Chie...\n",
       "3         1993  Yiduitakuya Iwamoto - Polyuse Inc - Chief Exec...\n",
       "4         1993  Alberto Rizzoli - V7 Ltd - Chief Executive Off...\n",
       "5         1993  Tongda Wu - Paifang Technology Tianjin Co Ltd ...\n",
       "6         1992  Ross Bailey - Appear Here Ltd - Chief Executiv...\n",
       "7         1992  Christian Besenbruch - Deep Render Ltd - Chief...\n",
       "8         1992  Ed Leon Klinger - Flock Ltd - Chief Executive ...\n",
       "9         1992  Snigdha Mothukuri - Jeevan Scientific Technolo..."
      ]
     },
     "execution_count": 13,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.Definition(\n",
    "    view=search.Views.PEOPLE,\n",
    "    query=\"ceo\",\n",
    "    order_by=\"YearOfBirth desc,LastName,FirstName\",\n",
    "    select=\"YearOfBirth,DocumentTitle\"\n",
    ").get_data()\n",
    "\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Search with group_by option"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "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>CentralBankName</th>\n",
       "      <th>DocumentTitle</th>\n",
       "      <th>RIC</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>Federal Reserve System</td>\n",
       "      <td>United States, Policy Rates, Fed Funds Target ...</td>\n",
       "      <td>USFOMC=ECI</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>Federal Reserve System</td>\n",
       "      <td>United States, Policy Rates, Fed Overnight Rep...</td>\n",
       "      <td>USRRP=ECI</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>European Central Bank</td>\n",
       "      <td>Euro Zone, Policy Rates, ECB Main refinancing,...</td>\n",
       "      <td>EUECBR=ECI</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>European Central Bank</td>\n",
       "      <td>Euro Zone, Policy Rates, ECB Deposit Rate, Reu...</td>\n",
       "      <td>EUECBD=ECI</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>Sveriges Riksbank</td>\n",
       "      <td>Sweden, Policy Rates, Repo Rate (Effective Dat...</td>\n",
       "      <td>SERATE=ECI</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>Sveriges Riksbank</td>\n",
       "      <td>Sweden, Riksbank Rate-Median, Reuters Polls, D...</td>\n",
       "      <td>pSERATE=M</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>Magyar Nemzeti Bank</td>\n",
       "      <td>Hungary, Policy Rates, Base Rate, Reuters Poll...</td>\n",
       "      <td>HUINT=ECI</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>Magyar Nemzeti Bank</td>\n",
       "      <td>Hungary, Policy Rates, Base Rate, Reuters Poll...</td>\n",
       "      <td>HUOD2=ECI</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>Central Bank of Colombia</td>\n",
       "      <td>Colombia, Policy Rates, Intervention Rate, Reu...</td>\n",
       "      <td>COCBIR=ECI</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>Central Bank of Colombia</td>\n",
       "      <td>Colombia, Interest Rate-Median, Reuters Polls,...</td>\n",
       "      <td>pCOCBIR=M</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "            CentralBankName  \\\n",
       "0    Federal Reserve System   \n",
       "1    Federal Reserve System   \n",
       "2     European Central Bank   \n",
       "3     European Central Bank   \n",
       "4         Sveriges Riksbank   \n",
       "5         Sveriges Riksbank   \n",
       "6       Magyar Nemzeti Bank   \n",
       "7       Magyar Nemzeti Bank   \n",
       "8  Central Bank of Colombia   \n",
       "9  Central Bank of Colombia   \n",
       "\n",
       "                                       DocumentTitle         RIC  \n",
       "0  United States, Policy Rates, Fed Funds Target ...  USFOMC=ECI  \n",
       "1  United States, Policy Rates, Fed Overnight Rep...   USRRP=ECI  \n",
       "2  Euro Zone, Policy Rates, ECB Main refinancing,...  EUECBR=ECI  \n",
       "3  Euro Zone, Policy Rates, ECB Deposit Rate, Reu...  EUECBD=ECI  \n",
       "4  Sweden, Policy Rates, Repo Rate (Effective Dat...  SERATE=ECI  \n",
       "5  Sweden, Riksbank Rate-Median, Reuters Polls, D...   pSERATE=M  \n",
       "6  Hungary, Policy Rates, Base Rate, Reuters Poll...   HUINT=ECI  \n",
       "7  Hungary, Policy Rates, Base Rate, Reuters Poll...   HUOD2=ECI  \n",
       "8  Colombia, Policy Rates, Intervention Rate, Reu...  COCBIR=ECI  \n",
       "9  Colombia, Interest Rate-Median, Reuters Polls,...   pCOCBIR=M  "
      ]
     },
     "execution_count": 14,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.Definition(\n",
    "    view=search.Views.INDICATOR_QUOTES,\n",
    "    query=\"rate\",\n",
    "    group_by=\"CentralBankName\",\n",
    "    group_count=2,\n",
    "    select=\"CentralBankName,DocumentTitle,RIC\"\n",
    ").get_data()\n",
    "\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Search For People"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 15,
   "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>BusinessEntity</th>\n",
       "      <th>DocumentTitle</th>\n",
       "      <th>PermID</th>\n",
       "      <th>PI</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>Amy E. Hood - Microsoft Corp - Chief Financial...</td>\n",
       "      <td>34415553383</td>\n",
       "      <td>34415553383</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>Luca Maestri - Apple Inc - Chief Financial Off...</td>\n",
       "      <td>34414554748</td>\n",
       "      <td>34414554748</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>Brian T. Olsavsky - Amazon.com Inc - Chief Fin...</td>\n",
       "      <td>34417610894</td>\n",
       "      <td>34417610894</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>Ruth M. Porat - Alphabet Inc - Chief Financial...</td>\n",
       "      <td>34413960665</td>\n",
       "      <td>34413960665</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>David M. Wehner - Meta Platforms Inc - Chief F...</td>\n",
       "      <td>34414804241</td>\n",
       "      <td>34414804241</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>Marc D. Hamburg - Berkshire Hathaway Inc - Chi...</td>\n",
       "      <td>34413152672</td>\n",
       "      <td>34413152672</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>Andrew K. Klatt - Berkshire Hathaway Inc - CFO...</td>\n",
       "      <td>34414966250</td>\n",
       "      <td>34414966250</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>Xu Hong - Alibaba Group Holding Ltd - Chief Fi...</td>\n",
       "      <td>34425652371</td>\n",
       "      <td>34425652371</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>John Lo - Tencent Holdings Ltd - Chief Financi...</td>\n",
       "      <td>34414907131</td>\n",
       "      <td>34414907131</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>PERSON</td>\n",
       "      <td>Vasant M. Prabhu - Visa Inc - Vice Chairman of...</td>\n",
       "      <td>34413340523</td>\n",
       "      <td>34413340523</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "  BusinessEntity                                      DocumentTitle  \\\n",
       "0         PERSON  Amy E. Hood - Microsoft Corp - Chief Financial...   \n",
       "1         PERSON  Luca Maestri - Apple Inc - Chief Financial Off...   \n",
       "2         PERSON  Brian T. Olsavsky - Amazon.com Inc - Chief Fin...   \n",
       "3         PERSON  Ruth M. Porat - Alphabet Inc - Chief Financial...   \n",
       "4         PERSON  David M. Wehner - Meta Platforms Inc - Chief F...   \n",
       "5         PERSON  Marc D. Hamburg - Berkshire Hathaway Inc - Chi...   \n",
       "6         PERSON  Andrew K. Klatt - Berkshire Hathaway Inc - CFO...   \n",
       "7         PERSON  Xu Hong - Alibaba Group Holding Ltd - Chief Fi...   \n",
       "8         PERSON  John Lo - Tencent Holdings Ltd - Chief Financi...   \n",
       "9         PERSON  Vasant M. Prabhu - Visa Inc - Vice Chairman of...   \n",
       "\n",
       "        PermID           PI  \n",
       "0  34415553383  34415553383  \n",
       "1  34414554748  34414554748  \n",
       "2  34417610894  34417610894  \n",
       "3  34413960665  34413960665  \n",
       "4  34414804241  34414804241  \n",
       "5  34413152672  34413152672  \n",
       "6  34414966250  34414966250  \n",
       "7  34425652371  34425652371  \n",
       "8  34414907131  34414907131  \n",
       "9  34413340523  34413340523  "
      ]
     },
     "execution_count": 15,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.Definition(\n",
    "    query=\"cfo\",\n",
    "    view=search.Views.PEOPLE\n",
    ").get_data()\n",
    "\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Close the session"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 16,
   "metadata": {},
   "outputs": [],
   "source": [
    "rd.close_session()"
   ]
  },
  {
   "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.9.7"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}