mcxlib 0.1__tar.gz

mcxlib-0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mcxlib-0.1/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.1
+Name: mcxlib
+Version: 0.1
+Summary: python library to get MCX India data
+Home-page: https://github.com/RuchiTanmay/mcxlib
+Author: RuchiTanmay
+Author-email: ruchitanmay@gmail.com
+Keywords: mcx,mcx india,python,mcx data,mcx history data,commodity,mcx python,mcx python library,mcx library
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# mcxlib 0.1
+
+Python Library to get publicly available data on MCX website.
+
+Release Notes
+* Compatible and Tested with Python 3.8 and above 
+* Future release will be done on requirement basic
+
+## Libraries Required
+- requests
+- numpy
+- pandas
+- lxml
+
+For Windows systems you can install Anaconda, this will cover many dependencies (You'll have to install requests additionally though)
+
+## Installation
+Fresh installation 
+
+```$pip install mcxlib```
+
+Upgrade
+
+```$pip install mcxlib --upgrade```
+
+## Function list
+
+* get_recent_expires
+* get_market_watch
+* get_top_gainers
+* get_heat_map
+* get_top_gainers
+* get_top_losers
+* get_most_active_contracts
+* get_most_active_puts_calls
+* get_bhav_copy
+* get_historical_data
+* get_pro_cli_details
+* get_option_chain
+* get_put_call_ratio
+* get_category_wise_oi
+* get_category_wise_turnover
+* get_mcx_icomdex_indices
+* get_trading_statistics
+* get_ccl_delivery
+
+Example : 
+
+import mcxlib
+
+data = get_live_market_watch()
+
+bhav_copy = get_bhav_copy(trade_date= '20231102', instrument = 'ALL')
+
+option_chain = get_option_chain(commodity = 'CRUDEOIL', expiry = '15NOV2023')
+
+cli_details = get_pro_cli_details(trade_month = '202301')
+
+NB: always follow the function hint to apply valid parameter.
+                                            
+More functions will be available in future releases...
+
+
+## How can I contribute?
+There are multiple ways in which you can contribute-
+
+### Write about your project
+
+There are working on to add many function to this library. mcxlib at the moment is short of good documentation. There are lot of features in mcxlib yet to come :( , so till we complete the documentation, I'll need support from the community.
+
+Please write about your projects in blogs, quora answers and other forums, so that people find working examples to get started.
+
+### Raising issues, bugs, enhancement requests
+
+For quick resolution please raise issues both [here on issue page](https://github.com/RuchiTanmay/mcxlib/issues). I'll try my best to address the issues quickly on github as and when I get notified, but raising it on stackoverflow will provide you access to a larger group and someone else might solve your problem before I do.
+
+### Submit patches
+
+If you have fixed an issue or added a new feature, please fork this repository, make your changes and submit a pull request. [Here's good article on how to do this.](https://code.tutsplus.com/tutorials/how-to-collaborate-on-github--net-34267) 
+
+Looking forward for healthy participation from community.

mcxlib-0.1/README.md

@@ -0,0 +1,81 @@
+# mcxlib 0.1
+
+Python Library to get publicly available data on MCX website.
+
+Release Notes
+* Compatible and Tested with Python 3.8 and above 
+* Future release will be done on requirement basic
+
+## Libraries Required
+- requests
+- numpy
+- pandas
+- lxml
+
+For Windows systems you can install Anaconda, this will cover many dependencies (You'll have to install requests additionally though)
+
+## Installation
+Fresh installation 
+
+```$pip install mcxlib```
+
+Upgrade
+
+```$pip install mcxlib --upgrade```
+
+## Function list
+
+* get_recent_expires
+* get_market_watch
+* get_top_gainers
+* get_heat_map
+* get_top_gainers
+* get_top_losers
+* get_most_active_contracts
+* get_most_active_puts_calls
+* get_bhav_copy
+* get_historical_data
+* get_pro_cli_details
+* get_option_chain
+* get_put_call_ratio
+* get_category_wise_oi
+* get_category_wise_turnover
+* get_mcx_icomdex_indices
+* get_trading_statistics
+* get_ccl_delivery
+
+Example : 
+
+import mcxlib
+
+data = get_live_market_watch()
+
+bhav_copy = get_bhav_copy(trade_date= '20231102', instrument = 'ALL')
+
+option_chain = get_option_chain(commodity = 'CRUDEOIL', expiry = '15NOV2023')
+
+cli_details = get_pro_cli_details(trade_month = '202301')
+
+NB: always follow the function hint to apply valid parameter.
+                                            
+More functions will be available in future releases...
+
+
+## How can I contribute?
+There are multiple ways in which you can contribute-
+
+### Write about your project
+
+There are working on to add many function to this library. mcxlib at the moment is short of good documentation. There are lot of features in mcxlib yet to come :( , so till we complete the documentation, I'll need support from the community.
+
+Please write about your projects in blogs, quora answers and other forums, so that people find working examples to get started.
+
+### Raising issues, bugs, enhancement requests
+
+For quick resolution please raise issues both [here on issue page](https://github.com/RuchiTanmay/mcxlib/issues). I'll try my best to address the issues quickly on github as and when I get notified, but raising it on stackoverflow will provide you access to a larger group and someone else might solve your problem before I do.
+
+### Submit patches
+
+If you have fixed an issue or added a new feature, please fork this repository, make your changes and submit a pull request. [Here's good article on how to do this.](https://code.tutsplus.com/tutorials/how-to-collaborate-on-github--net-34267) 
+
+Looking forward for healthy participation from community.

mcxlib-0.1/mcxlib/__init__.py

@@ -0,0 +1,6 @@
+from market_data import get_market_watch, get_top_gainers, get_heat_map, get_top_gainers, get_recent_expires, \
+    get_top_losers, get_most_active_contracts, get_most_active_puts_calls, get_bhav_copy, \
+    get_historical_date_wise_data, get_pro_cli_details, get_option_chain, get_put_call_ratio, get_category_wise_oi, \
+    get_category_wise_turnover, get_mcx_icomdex_indices, get_trading_statistics, get_ccl_delivery
+
+__version__ = 0.1

mcxlib-0.1/mcxlib/libutil.py

@@ -0,0 +1,81 @@
+from datetime import datetime
+import os
+
+header = {
+        'Accept': 'application/json, text/javascript, */*; q=0.01',
+        'Accept-Language': 'en-US,en;q=0.5',
+        'Connection': 'keep-alive',
+        'Content-Length': '0',
+        'Content-Type': 'application/json',
+        'Cookie': 'ASP.NET_SessionId=p4dkpr24k2j2ck1w2qnov1h5',
+        'Origin': 'https://www.mcxindia.com',
+        'Referer': 'https://www.mcxindia.com/market-data/market-watch',
+        'Sec-Fetch-Dest': 'empty',
+        'Sec-Fetch-Mode': 'cors',
+        'Sec-Fetch-Site': 'same-origin',
+        'Sec-GPC': '1',
+        'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36',
+        'X-Requested-With': 'XMLHttpRequest',
+        'sec-ch-ua': '"Chromium";v="118", "Brave";v="118", "Not=A?Brand";v="99"',
+        'sec-ch-ua-mobile': '?0',
+        'sec-ch-ua-platform': '"Windows"'
+        }
+
+
+class CalenderNotFound(Exception):
+    def __init__(self, message):
+
+        # Call the base class constructor with the parameters it needs
+        super(CalenderNotFound, self).__init__(message)
+
+
+class MCXdataNotFound(Exception):
+    def __init__(self, message):
+        super(MCXdataNotFound, self).__init__(message)
+
+
+def get_headers(use_for:str = 'market-watch'):
+    return {
+        'Accept': 'application/json, text/javascript, */*; q=0.01',
+        'Accept-Language': 'en-US,en;q=0.5',
+        'Connection': 'keep-alive',
+        'Content-Length': '0',
+        'Content-Type': 'application/json',
+        'Origin': 'https://www.mcxindia.com',
+        'Referer': f'https://www.mcxindia.com/market-data/{use_for}',
+        'Sec-GPC': '1',
+        'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36',
+        'X-Requested-With': 'XMLHttpRequest',
+        'sec-ch-ua': '"Chromium";v="118", "Brave";v="118", "Not=A?Brand";v="99"',
+        'sec-ch-ua-platform': '"Windows"'
+    }
+
+
+def validate_date_param(start_date:str, end_date:str):
+    if not start_date or not end_date:
+        raise ValueError(' Please provide the valid parameters')
+    try:
+        start_date = datetime.strptime(start_date, '%Y%m%d')
+        end_date = datetime.strptime(end_date, '%Y%m%d')
+        time_delta = (end_date - start_date).days
+        if time_delta < 1:
+            raise ValueError(f'end_date should greater than start_date ')
+        elif time_delta > 365:
+            raise ValueError(f'Date range cannot be greater than 365 days')
+    except Exception as e:
+        print(e)
+        raise ValueError(f'either or both start_date = {start_date} || end_date = {end_date} are not valid value')
+
+
+def get_mcxlib_path():
+    """
+    Extract isap file path
+    """
+    mydir = os.getcwd()
+    return mydir.split(r'\mcxlib', 1)[0]
+
+
+
+# if __name__ == '__main__':
+#     # data = derive_from_and_to_date('6M')
+#     print(trading_holiday_calendar())

mcxlib-0.1/mcxlib/logger.py

@@ -0,0 +1,15 @@
+import logging
+import sys
+
+
+# Create a custom logger
+def mylogger(logger):
+    logger.setLevel(logging.DEBUG)
+    # Create handlers
+    c_handler = logging.StreamHandler(sys.stdout)
+    # Create formatters and add it to handlers
+    f_format = logging.Formatter('%(name)s::%(levelname)s::%(message)s')
+    c_handler.setFormatter(f_format)
+    # Add handlers to the logger
+    logger.addHandler(c_handler)
+    return logger

mcxlib-0.1/mcxlib/market_data.py

@@ -0,0 +1,375 @@
+import pandas as pd
+import requests
+from mcxlib.libutil import *
+import json
+import calendar
+
+
+def get_recent_expires(commodity:str = 'ALL') -> pd.DataFrame:
+    """
+    get recent expiry for commodity
+    :param commodity: any of the list ['ALL', 'CRUDEOIL', 'COPPER', 'GOLD', 'GOLDM', 'NATURALGAS', 'SILVER', 'SILVERM', 'ZINC']
+    :return: panda dataframe
+    """
+    url = "https://www.mcxindia.com/backpage.aspx/GetExpirywisePutCallRatio"
+    payload = {}
+    headers = get_headers(use_for='put-call-ratio')
+    try:
+        data_dict = requests.post(url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['ExtensionData', 'Date', 'Ratio'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" data not found / Invalid request  : MCX error:{e}")
+    if not commodity == 'ALL':
+        data_df = data_df[data_df['Symbol'] == commodity]
+    if data_df.empty:
+        raise ValueError("Apply a valid commodity name")
+    return data_df
+
+def get_market_watch() -> pd.DataFrame:
+    """
+    get live market watch on MCX
+    :return: panda dataframe
+    """
+    url="https://www.mcxindia.com/backpage.aspx/GetMarketWatch"
+    payload = {}
+    headers = get_headers(use_for='market-watch')
+    try:
+        data_dict = requests.request("POST", url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['__type', 'LTT'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" No Data Found : MCX error:{e}")
+    return data_df
+
+
+def get_heat_map() -> pd.DataFrame:
+    """
+    get live market heat map on MCX
+    :return: panda dataframe
+    """
+    url="https://www.mcxindia.com/backpage.aspx/GetHeatMap"
+    payload = {}
+    headers = get_headers(use_for='heatmap')
+    try:
+        data_dict = requests.post(url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['__type', 'Dttm'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" No heatmap Data Found : MCX error:{e}")
+    return data_df
+
+
+def get_top_gainers() -> pd.DataFrame:
+    """
+    get live market top gainers on MCX
+    :return: panda dataframe
+    """
+    url = "https://www.mcxindia.com/backpage.aspx/GetGainer"
+    payload = {}
+    headers = get_headers(use_for='top-gainers')
+    try:
+        data_dict = requests.post(url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['ExtensionData', 'LTT'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" No top-gainers Data Found / Invalid request  : MCX error:{e}")
+    return data_df
+
+
+def get_top_losers() -> pd.DataFrame:
+    """
+    get live market top losers on MCX
+    :return: panda dataframe
+    """
+    url = "https://www.mcxindia.com/backpage.aspx/GetLosers"
+    payload = {}
+    headers = get_headers(use_for='top-losers')
+    try:
+        data_dict = requests.post(url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['ExtensionData', 'LTT'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" No top-losers Data Found / Invalid request  : MCX error:{e}")
+    return data_df
+
+
+def get_most_active_contracts(instrument:str = 'ALL') -> pd.DataFrame:
+    """
+    get live market most active contract on MCX
+    :param instrument: any value from the list ['ALL','FUTCOM','FUTIDX','OPTCOM','OPTFUT']
+    :return: panda dataframe
+    """
+    headers = get_headers(use_for='most-active-contracts')
+    url = "https://www.mcxindia.com/backpage.aspx/GetMostActiveContractByVolumeFilter"
+    payload = json.dumps({
+                            "InstrumentType": f'{instrument}'
+                        })
+    try:
+        data_dict = requests.request("POST", url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['ExtensionData', 'Date', 'Unit'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" No most-active-contracts Data Found / Invalid request : MCX error:{e}")
+    return data_df
+
+
+def get_most_active_puts_calls(option_type:str = 'PE',
+                               product:str = 'ALL',
+                               instrument:str = 'OPTFUT') -> pd.DataFrame:
+    """
+    get live market most active put/calls on MCX
+    :param option_type: any value from the list ['PE','CE']
+    :param product: any value from the list ['ALL','COPPER','CRUDEOIL','GOLD','GOLDM','NATURALGAS',
+                                            'SILVER','SILVERM','ZINC']
+    :param instrument: any value from the list ['OPTCOM','OPTIONS']
+    :return: panda dataframe
+    """
+    headers = get_headers(use_for='most-active-puts-calls')
+    url = "https://www.mcxindia.com/backpage.aspx/GetMostActiveOptionsContractsByVolume"
+    payload_param = {'OptionType':f'{option_type}','Product':f'{product}','InstrumentType':f'{instrument}'}
+    payload = f"{payload_param}"
+    try:
+        data_dict = requests.request("POST", url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['ExtensionData', 'LTT'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" No Data Found / Invalid request : MCX error:{e}")
+    return data_df
+
+
+def get_bhav_copy(trade_date:str = '20230102',
+                  instrument:str = 'ALL') -> pd.DataFrame:
+    """
+    get bhav copy
+    :param trade_date: in str format : YYYYMMDD
+    :param instrument: any value from the list ['ALL','FUTCOM','FUTIDX','OPTCOM','OPTFUT']
+    :return: panda dataframe
+    """
+    headers = get_headers(use_for='bhavcopy')
+    url="https://www.mcxindia.com/backpage.aspx/GetDateWiseBhavCopy"
+    payload_param = {'Date': f'{trade_date}', 'InstrumentName': f'{instrument}'}
+    payload = f"{payload_param}"
+    try:
+        data_dict = requests.request("POST", url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns='__type', inplace=True)
+    except Exception as e:
+        raise ValueError(f" No Data Found / Invalid parameters : MCX error:{e}")
+    return data_df
+
+
+def get_historical_date_wise_data(start_date:str = '20230101',
+                                  end_date:str = '20231103',) -> pd.DataFrame:
+    """
+    to get date wise history data in a panda dataframe
+    Date range cannot be greater than 365 days
+    :param start_date: in str format : YYYYMMDD
+    :param end_date: in str format : YYYYMMDD
+    :return: panda dataframe
+    """
+    headers = get_headers(use_for='historical-data')
+    url = "https://www.mcxindia.com/backpage.aspx/GetHistoricalDataDetails"
+    payload = json.dumps({
+                            "GroupBy": "D",
+                            "Segment": "ALL",
+                            "CommodityHead": "ALL",
+                            "Commodity": "ALL",
+                            "Startdate": f"{start_date}",
+                            "EndDate": f"{end_date}",
+                            "InstrumentName": "ALL"
+                        })
+    validate_date_param(start_date=start_date, end_date=end_date)
+    try:
+        data_dict = requests.request("POST", url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df['Date'] = pd.to_datetime(data_df['Date'])
+        data_df.drop(columns=['__type', 'Year', 'Month'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" No Data Found / Invalid parameters : MCX error:{e}")
+    return data_df
+
+
+def get_mcx_icomdex_indices() -> pd.DataFrame:
+    """
+    get MCX iCOMDEX Indices
+    :return: panda dataframe
+    """
+    url = "https://www.mcxindia.com/backpage.aspx/GetMCXIComdexIndicesDetails"
+    payload = json.dumps({
+        "Instrument_Identifier": "0",
+        "Lang": "en"
+    })
+    headers = get_headers(use_for='mcx-icomdex-indices')
+    try:
+        data_dict = requests.post(url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['__type'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" No Data Found / Invalid request  : MCX error:{e}")
+    return data_df
+
+
+def get_pro_cli_details(trade_month:str = '202301') -> pd.DataFrame:
+    """
+    get PRO CLI Details for given month
+    :param trade_month: in str format : YYYYMM
+    :return: panda dataframe
+    """
+    headers = get_headers(use_for='pro-cli-details')
+    url = "https://www.mcxindia.com/backpage.aspx/GetPROClientDetailsSegmentWise"
+    payload = json.dumps({
+        "GroupBy": "M",
+        "Segment": "ALL",
+        "CommodityHead": "ALL",
+        "Commodity": "ALL",
+        "Startdate": f"{trade_month}"
+    })
+    try:
+        data_dict = requests.request("POST", url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df['Date'] = pd.to_datetime(data_df['Date'])
+        data_df.drop(columns=['ExtensionData', 'TradingDate', 'Date'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" No Data Found / Invalid parameters : MCX error:{e}")
+    return data_df
+
+
+def get_option_chain(commodity:str = 'CRUDEOIL', expiry:str = '15NOV2023') -> pd.DataFrame:
+    """
+    get live option chain from MCX site, the expiry date is different for different commodity
+    :param commodity: any of the list ['CRUDEOIL', 'COPPER', 'GOLD', 'GOLDM', 'NATURALGAS', 'SILVER', 'SILVERM', 'ZINC']
+    :param expiry: in the format od 'DDMMMYYYY' eg:'15NOV2023'
+    :return: panda dataframe
+    """
+    headers = get_headers(use_for='option-chain')
+    url = "https://www.mcxindia.com/backpage.aspx/GetOptionChain"
+    payload_param = {'Commodity':f'{commodity}','Expiry':f'{expiry}'}
+    payload = f"{payload_param}"
+    try:
+        data_dict = requests.request("POST", url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['ExtensionData', 'PE_LTT', 'CE_LTT', 'LTT', 'Symbol'], inplace=True)
+        data_df = data_df[(data_df['CE_OpenInterest']>0) | (data_df['PE_OpenInterest']>0)].copy()
+    except Exception as e:
+        raise ValueError(f" Invalid parameters : MCX error:{e}")
+    data_df.reset_index(inplace=True)
+    data_df.drop(columns='index', inplace=True)
+    return data_df
+
+
+def get_put_call_ratio(ratio_type:str = 'expiry_wise') -> pd.DataFrame:
+    """
+    get recent expiry wise put call ratio
+    :param ratio_type: 'expiry_wise' or 'commodity_wise'
+    :return: panda dataframe
+    """
+    if ratio_type =='expiry_wise':
+        url = "https://www.mcxindia.com/backpage.aspx/GetExpirywisePutCallRatio"
+    elif ratio_type =='commodity_wise':
+        url = "https://www.mcxindia.com/backpage.aspx/GetCommoditywisePutCallRatio"
+    else:
+        raise ValueError(" Please apply valid ratio type")
+    payload = {}
+    headers = get_headers(use_for='put-call-ratio')
+    try:
+        data_dict = requests.post(url, headers=headers, data=payload).json()
+        data_df = pd.DataFrame.from_dict(data_dict['d']['Data'])
+        data_df.drop(columns=['ExtensionData', 'Date'], inplace=True)
+    except Exception as e:
+        raise ValueError(f" call put ratio data not found / Invalid request  : MCX error:{e}")
+    return data_df
+
+
+def get_category_wise_turnover(year:int = 2023, month_number:int = 9) -> pd.DataFrame:
+    """
+    get the category wise turnover data
+    :param year: int format : YYYY
+    :param month_number: int between (1 to 12)
+    :return: pandas dataframe
+    """
+    month_long = calendar.month_name[month_number].lower()
+    month_short = calendar.month_abbr[month_number].lower()
+    try:
+        url=f"https://www.mcxindia.com/docs/default-source/market-data/historicaldata/{str(year)}/{month_long}/" \
+            f"category-wise-turnover-{month_short}-{str(year)}.xlsx"
+        data_df = pd.read_excel(url, skiprows=2, skipfooter=9)
+    except Exception as e:
+        raise ValueError(f" apply valid parameter : MCX error:{e}")
+    return data_df
+
+
+def get_category_wise_oi(year:int = 2023, month_number:int = 9) -> pd.DataFrame:
+    """
+    get the category wise open interest data
+    :param year: int format : YYYY
+    :param month_number: int between (1 to 12)
+    :return: pandas dataframe
+    """
+    month_long = calendar.month_name[month_number].lower()
+    month_short = calendar.month_abbr[month_number].lower()
+    try:
+        url = f"https://www.mcxindia.com/docs/default-source/market-data/historicaldata/{str(year)}/{month_long}/" \
+              f"category-wise-oi-{month_short}-{str(year)}.xlsx"
+        data_df = pd.read_excel(url, skiprows=3, skipfooter=8)
+    except Exception as e:
+        raise ValueError(f" apply valid parameter : MCX error:{e}")
+    data_df.columns = ['Date', 'Commodity', 'Instrument', 'Open Interest', 'FPOs/ Farmers(Long OI)',
+                       'FPOs/ Farmers(Short OI)', 'VCPs/ Hedger(Long OI)', 'VCPs/ Hedger(Short OI)',
+                       'Proprietary traders(Long OI)', 'Proprietary traders(Short OI)',
+                       'Domestic Financial institutional investors(Long OI)',
+                       'Domestic Financial institutional investors(Short OI)', 'Foreign Participants(Long OI)',
+                       'Foreign Participants(Short OI)', 'Others(Long OI)', 'Others(Short OI)']
+    return data_df
+
+
+def get_ccl_delivery(year:int = 2023, month_number:int = 9) -> pd.DataFrame:
+    """
+    get the ccl delivery data
+    :param year: int format : YYYY
+    :param month_number: int between (1 to 12)
+    :return: pandas dataframe
+    """
+    month_long = calendar.month_name[month_number].lower()
+    month_short = calendar.month_abbr[month_number].lower()
+    try:
+        url=f"https://www.mcxindia.com/docs/default-source/market-data/historicaldata/{str(year)}/{month_long}/" \
+            f"ccl_delivery.xlsx"
+        data_df = pd.read_excel(url)
+    except Exception as e:
+        raise ValueError(f" apply valid parameter : MCX error:{e}")
+    data_df.dropna(inplace=True)
+    data_df.reset_index(inplace=True)
+    data_df.drop(columns='index', inplace=True)
+    return data_df
+
+
+def get_trading_statistics(year:int = 2023, month_number:int = 9) -> pd.DataFrame:
+    """
+    get the trading statistics data from MCX
+    :param year: int format : YYYY
+    :param month_number: int between (1 to 12)
+    :return: pandas dataframe
+    """
+    month_long = calendar.month_name[month_number].lower()
+    month_short = calendar.month_abbr[month_number].lower()
+    try:
+        url=f"https://www.mcxindia.com/docs/default-source/market-data/historicaldata/{str(year)}/{month_long}/" \
+            f"trading-statistics-{month_short}-{str(year)}.xlsx"
+        data_df = pd.read_excel(url, skipfooter=5)
+    except Exception as e:
+        raise ValueError(f" apply valid parameter : MCX error:{e}")
+    data_df.rename(columns={"Mode of Trading (% of Turnover)": "Mode of ALGO Trading (% of Turnover)",
+                    "Unnamed: 25": "Mode of Non-ALGO Trading (% of Turnover)"},inplace=True)
+    data_df.dropna(inplace=True)
+    data_df.reset_index(inplace=True)
+    data_df.drop(columns='index', inplace=True)
+    return data_df
+
+
+# if __name__ == '__main__':
+#     df = get_recent_expires(commodity='COPPE')
+#     print(df.columns)
+#     print(df)
+
+

mcxlib-0.1/mcxlib.egg-info/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.1
+Name: mcxlib
+Version: 0.1
+Summary: python library to get MCX India data
+Home-page: https://github.com/RuchiTanmay/mcxlib
+Author: RuchiTanmay
+Author-email: ruchitanmay@gmail.com
+Keywords: mcx,mcx india,python,mcx data,mcx history data,commodity,mcx python,mcx python library,mcx library
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# mcxlib 0.1
+
+Python Library to get publicly available data on MCX website.
+
+Release Notes
+* Compatible and Tested with Python 3.8 and above 
+* Future release will be done on requirement basic
+
+## Libraries Required
+- requests
+- numpy
+- pandas
+- lxml
+
+For Windows systems you can install Anaconda, this will cover many dependencies (You'll have to install requests additionally though)
+
+## Installation
+Fresh installation 
+
+```$pip install mcxlib```
+
+Upgrade
+
+```$pip install mcxlib --upgrade```
+
+## Function list
+
+* get_recent_expires
+* get_market_watch
+* get_top_gainers
+* get_heat_map
+* get_top_gainers
+* get_top_losers
+* get_most_active_contracts
+* get_most_active_puts_calls
+* get_bhav_copy
+* get_historical_data
+* get_pro_cli_details
+* get_option_chain
+* get_put_call_ratio
+* get_category_wise_oi
+* get_category_wise_turnover
+* get_mcx_icomdex_indices
+* get_trading_statistics
+* get_ccl_delivery
+
+Example : 
+
+import mcxlib
+
+data = get_live_market_watch()
+
+bhav_copy = get_bhav_copy(trade_date= '20231102', instrument = 'ALL')
+
+option_chain = get_option_chain(commodity = 'CRUDEOIL', expiry = '15NOV2023')
+
+cli_details = get_pro_cli_details(trade_month = '202301')
+
+NB: always follow the function hint to apply valid parameter.
+                                            
+More functions will be available in future releases...
+
+
+## How can I contribute?
+There are multiple ways in which you can contribute-
+
+### Write about your project
+
+There are working on to add many function to this library. mcxlib at the moment is short of good documentation. There are lot of features in mcxlib yet to come :( , so till we complete the documentation, I'll need support from the community.
+
+Please write about your projects in blogs, quora answers and other forums, so that people find working examples to get started.
+
+### Raising issues, bugs, enhancement requests
+
+For quick resolution please raise issues both [here on issue page](https://github.com/RuchiTanmay/mcxlib/issues). I'll try my best to address the issues quickly on github as and when I get notified, but raising it on stackoverflow will provide you access to a larger group and someone else might solve your problem before I do.
+
+### Submit patches
+
+If you have fixed an issue or added a new feature, please fork this repository, make your changes and submit a pull request. [Here's good article on how to do this.](https://code.tutsplus.com/tutorials/how-to-collaborate-on-github--net-34267) 
+
+Looking forward for healthy participation from community.

mcxlib-0.1/mcxlib.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+MANIFEST.in
+README.md
+setup.cfg
+setup.py
+mcxlib/__init__.py
+mcxlib/libutil.py
+mcxlib/logger.py
+mcxlib/market_data.py
+mcxlib.egg-info/PKG-INFO
+mcxlib.egg-info/SOURCES.txt
+mcxlib.egg-info/dependency_links.txt
+mcxlib.egg-info/requires.txt
+mcxlib.egg-info/top_level.txt

mcxlib-0.1/mcxlib.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mcxlib-0.1/mcxlib.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests
+pandas

mcxlib-0.1/mcxlib.egg-info/top_level.txt

@@ -0,0 +1 @@
+mcxlib

mcxlib-0.1/setup.cfg

@@ -0,0 +1,7 @@
+[metadata]
+description_file = README.md
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

mcxlib-0.1/setup.py

@@ -0,0 +1,28 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name='mcxlib',
+    packages=setuptools.find_packages(),
+    version='0.1',
+    include_package_data=True,
+    description='python library to get MCX India data',
+    long_description=long_description,
+    long_description_content_type="text/markdown", author='RuchiTanmay',
+    author_email='ruchitanmay@gmail.com',
+    url='https://github.com/RuchiTanmay/mcxlib',
+    install_requires=['requests', 'pandas'],
+    keywords=['mcx', 'mcx india', 'python', 'mcx data', 'mcx history data', 'commodity', 'mcx python',
+              'mcx python library', 'mcx library'],
+    classifiers=[
+        'Intended Audience :: Developers',
+        'Natural Language :: English',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: Implementation :: PyPy',
+        'Topic :: Software Development :: Libraries :: Python Modules'
+    ],
+)