2_data_gov_india.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "4784bf03-fb18-43ca-b2b9-1d03cf782b27",
   "metadata": {},
   "source": [
    "## Example API requests to data.gov.in"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "7b22432f-4b29-425d-ad71-00b52118fb0f",
   "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>state</th>\n",
       "      <th>district</th>\n",
       "      <th>market</th>\n",
       "      <th>commodity</th>\n",
       "      <th>variety</th>\n",
       "      <th>arrival_date</th>\n",
       "      <th>min_price</th>\n",
       "      <th>max_price</th>\n",
       "      <th>modal_price</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>Chattisgarh</td>\n",
       "      <td>Balrampur</td>\n",
       "      <td>Ramanujganj</td>\n",
       "      <td>Garlic</td>\n",
       "      <td>Desi</td>\n",
       "      <td>2021-04-30T07:48:16Z</td>\n",
       "      <td>10000</td>\n",
       "      <td>10000</td>\n",
       "      <td>10000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>Chattisgarh</td>\n",
       "      <td>Balrampur</td>\n",
       "      <td>Ramanujganj</td>\n",
       "      <td>Garlic</td>\n",
       "      <td>Other</td>\n",
       "      <td>2021-01-01T07:48:16Z</td>\n",
       "      <td>4000</td>\n",
       "      <td>4000</td>\n",
       "      <td>4000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>Chattisgarh</td>\n",
       "      <td>Balrampur</td>\n",
       "      <td>Ramanujganj</td>\n",
       "      <td>Garlic</td>\n",
       "      <td>Other</td>\n",
       "      <td>2021-02-01T07:48:16Z</td>\n",
       "      <td>4000</td>\n",
       "      <td>4000</td>\n",
       "      <td>4000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>Chattisgarh</td>\n",
       "      <td>Balrampur</td>\n",
       "      <td>Ramanujganj</td>\n",
       "      <td>Garlic</td>\n",
       "      <td>Other</td>\n",
       "      <td>2021-03-05T07:48:16Z</td>\n",
       "      <td>4000</td>\n",
       "      <td>4000</td>\n",
       "      <td>4000</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>Chattisgarh</td>\n",
       "      <td>Balrampur</td>\n",
       "      <td>Ramanujganj</td>\n",
       "      <td>Garlic</td>\n",
       "      <td>Other</td>\n",
       "      <td>2021-04-05T07:48:16Z</td>\n",
       "      <td>4000</td>\n",
       "      <td>4000</td>\n",
       "      <td>4000</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "         state   district       market commodity variety  \\\n",
       "0  Chattisgarh  Balrampur  Ramanujganj    Garlic    Desi   \n",
       "1  Chattisgarh  Balrampur  Ramanujganj    Garlic   Other   \n",
       "2  Chattisgarh  Balrampur  Ramanujganj    Garlic   Other   \n",
       "3  Chattisgarh  Balrampur  Ramanujganj    Garlic   Other   \n",
       "4  Chattisgarh  Balrampur  Ramanujganj    Garlic   Other   \n",
       "\n",
       "           arrival_date  min_price  max_price  modal_price  \n",
       "0  2021-04-30T07:48:16Z      10000      10000        10000  \n",
       "1  2021-01-01T07:48:16Z       4000       4000         4000  \n",
       "2  2021-02-01T07:48:16Z       4000       4000         4000  \n",
       "3  2021-03-05T07:48:16Z       4000       4000         4000  \n",
       "4  2021-04-05T07:48:16Z       4000       4000         4000  "
      ]
     },
     "execution_count": 1,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "import requests\n",
    "import pandas as pd\n",
    "from io import BytesIO\n",
    "\n",
    "def get_as_dataframe(url, api_params):\n",
    "    r = requests.api.get(url, api_params)\n",
    "    return pd.read_csv(BytesIO(r.content))\n",
    "\n",
    "# address of resource\n",
    "url = 'https://api.data.gov.in/resource/af4ed290-ed4f-40e1-a8b8-a4440e57a9ed'\n",
    "\n",
    "# additional params\n",
    "api_params = {\n",
    "    'api-key': '579b464db66ec23bdd000001cdd3946e44ce4aad7209ff7b23ac571b', # change this for the one generated by your user account\n",
    "    'format': 'csv' # The output format for the data (XML or CSV)\n",
    "}\n",
    "\n",
    "df = get_as_dataframe(url, api_params)\n",
    "df.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "82207fa7-cce1-4f86-9843-f51c2b3c4abe",
   "metadata": {},
   "source": [
    "## Confirm that response matches the stored version"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "87621fc8-9338-4660-b811-82250cc2d558",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "API request is the same as repo copy: True\n"
     ]
    }
   ],
   "source": [
    "print('API request is the same as repo copy: {}'.format(\n",
    "    (pd.read_csv('data/sample_data_gov_in.csv').head() == df.head()).all().all()))"
   ]
  }
 ],
 "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": 5
}