Examples/2-Content/2.06-Search/EX-2.06.03-Search-Metadata.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 Metadata\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 0x7f8ed0d5d910 {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": [
    "### Metadata"
   ]
  },
  {
   "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></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>AccountName</th>\n",
       "      <th>AccountName</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>AccountType</th>\n",
       "      <th>AccountType</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>Address</th>\n",
       "      <th>Address</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>AllRoles</th>\n",
       "      <th>AllRoles</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>AnalystCode</th>\n",
       "      <th>AnalystCode</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>True</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>SUMTotalEquityAssets</th>\n",
       "      <th>SUMTotalEquityAssets</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>TelephoneNumber</th>\n",
       "      <th>TelephoneNumber</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>UltimateParentId</th>\n",
       "      <th>UltimateParentId</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>UUID</th>\n",
       "      <th>UUID</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>YearOfBirth</th>\n",
       "      <th>YearOfBirth</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",
       "  </tbody>\n",
       "</table>\n",
       "<p>252 rows × 7 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                                             Type  Searchable  Sortable  \\\n",
       "AccountName          AccountName           String        True      True   \n",
       "AccountType          AccountType           String        True      True   \n",
       "Address              Address               String        True      True   \n",
       "AllRoles             AllRoles              String        True     False   \n",
       "AnalystCode          AnalystCode           String        True     False   \n",
       "...                                           ...         ...       ...   \n",
       "SUMTotalEquityAssets SUMTotalEquityAssets  Double        True      True   \n",
       "TelephoneNumber      TelephoneNumber       String        True     False   \n",
       "UltimateParentId     UltimateParentId      String        True      True   \n",
       "UUID                 UUID                  String        True     False   \n",
       "YearOfBirth          YearOfBirth           Double        True      True   \n",
       "\n",
       "                                           Navigable  Groupable  Exact  Symbol  \n",
       "AccountName          AccountName                True       True   True   False  \n",
       "AccountType          AccountType               False      False  False   False  \n",
       "Address              Address                   False      False  False   False  \n",
       "AllRoles             AllRoles                  False      False  False   False  \n",
       "AnalystCode          AnalystCode               False       True  False    True  \n",
       "...                                              ...        ...    ...     ...  \n",
       "SUMTotalEquityAssets SUMTotalEquityAssets       True      False  False   False  \n",
       "TelephoneNumber      TelephoneNumber           False      False  False   False  \n",
       "UltimateParentId     UltimateParentId          False      False  False   False  \n",
       "UUID                 UUID                      False      False  False   False  \n",
       "YearOfBirth          YearOfBirth                True      False  False   False  \n",
       "\n",
       "[252 rows x 7 columns]"
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.metadata.Definition(\n",
    "    view = search.Views.PEOPLE  # Required parameterc\n",
    ").get_data()\n",
    "\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### viewmeta with nested type"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "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>AccrualBondCode</th>\n",
       "      <th>AccrualBondCode</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>AccrualBondDescription</th>\n",
       "      <th>AccrualBondDescription</th>\n",
       "      <td>String</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "    </tr>\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>...</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>1490 rows × 7 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                                                  Type  Searchable  Sortable  \\\n",
       "AccrualBondCode        AccrualBondCode          String        True     False   \n",
       "AccrualBondDescription AccrualBondDescription   String        True     False   \n",
       "AccrualDate            AccrualDate                Date        True      True   \n",
       "AccruedInterest        AccruedInterest          Double        True      True   \n",
       "ActiveEstimatesExist   ActiveEstimatesExist    Boolean        True     False   \n",
       "...                                                ...         ...       ...   \n",
       "WorstStandardYield     WorstStandardYield       Double        True      True   \n",
       "WorstYearsToRedem      WorstYearsToRedem        Double        True      True   \n",
       "YieldCurveBenchmarkRIC YieldCurveBenchmarkRIC   String       False     False   \n",
       "YieldTypeDescription   YieldTypeDescription     String        True     False   \n",
       "ZCodeValue             ZCodeValue               String        True      True   \n",
       "\n",
       "                                               Navigable  Groupable  Exact  \\\n",
       "AccrualBondCode        AccrualBondCode             False       True  False   \n",
       "AccrualBondDescription AccrualBondDescription       True       True   True   \n",
       "AccrualDate            AccrualDate                  True      False  False   \n",
       "AccruedInterest        AccruedInterest              True      False  False   \n",
       "ActiveEstimatesExist   ActiveEstimatesExist        False      False  False   \n",
       "...                                                  ...        ...    ...   \n",
       "WorstStandardYield     WorstStandardYield           True      False  False   \n",
       "WorstYearsToRedem      WorstYearsToRedem            True      False  False   \n",
       "YieldCurveBenchmarkRIC YieldCurveBenchmarkRIC      False      False  False   \n",
       "YieldTypeDescription   YieldTypeDescription        False      False  False   \n",
       "ZCodeValue             ZCodeValue                  False       True  False   \n",
       "\n",
       "                                               Symbol  \n",
       "AccrualBondCode        AccrualBondCode           True  \n",
       "AccrualBondDescription AccrualBondDescription   False  \n",
       "AccrualDate            AccrualDate              False  \n",
       "AccruedInterest        AccruedInterest          False  \n",
       "ActiveEstimatesExist   ActiveEstimatesExist     False  \n",
       "...                                               ...  \n",
       "WorstStandardYield     WorstStandardYield       False  \n",
       "WorstYearsToRedem      WorstYearsToRedem        False  \n",
       "YieldCurveBenchmarkRIC YieldCurveBenchmarkRIC   False  \n",
       "YieldTypeDescription   YieldTypeDescription     False  \n",
       "ZCodeValue             ZCodeValue                True  \n",
       "\n",
       "[1490 rows x 7 columns]"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response = search.metadata.Definition(\n",
    "    view = search.Views.INSTRUMENTS  \n",
    ").get_data()\n",
    "\n",
    "response.data.df"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Close the session"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "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
}