upstox-python-sdk 2.23.0__tar.gz → 2.25.0__tar.gz

{upstox-python-sdk-2.23.0 → upstox_python_sdk-2.25.0}/PKG-INFO

@@ -1,13 +1,27 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: upstox-python-sdk
-Version: 2.23.0
+Version: 2.25.0
 Summary: Upstox Developer API
 Home-page: https://github.com/upstox/upstox-python
 License: MIT
 Keywords: Upstox Developer API
-Platform: UNKNOWN
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: urllib3>=1.15
+Requires-Dist: six>=1.10
+Requires-Dist: certifi
+Requires-Dist: python-dateutil
+Requires-Dist: websocket-client
+Requires-Dist: uuid
+Requires-Dist: protobuf
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 # Upstox Python SDK for API v2
 
@@ -515,4 +529,3 @@ if __name__ == "__main__":
 - **error**: Signals an error has occurred.
 - **reconnecting**: Announced when a reconnect attempt is initiated.
 - **autoReconnectStopped**: Informs when auto-reconnect efforts have ceased after exhausting the retry count.
-

{upstox-python-sdk-2.23.0 → upstox_python_sdk-2.25.0}/setup.py

@@ -18,7 +18,7 @@ this_directory = Path(__file__).parent
 long_description = (this_directory / "README.md").read_text()
 
 NAME = "upstox-python-sdk"
-VERSION = "2.23.0"
+VERSION = "2.25.0"
 # To install the library, run the following
 #
 # python setup.py install

{upstox-python-sdk-2.23.0 → upstox_python_sdk-2.25.0}/upstox_client/__init__.py

@@ -3,11 +3,11 @@
 # flake8: noqa
 
 """
-    Upstox Developer API
+    OpenAPI definition
 
-    Build your App on the Upstox platform  ![Banner](https://api.upstox.com/api-docs/images/banner.jpg \"banner\")  # Introduction  Upstox API is a set of rest APIs that provide data required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (using Websocket), and more, with the easy to understand API collection.  All requests are over HTTPS and the requests are sent with the content-type ‘application/json’. Developers have the option of choosing the response type as JSON or CSV for a few API calls.  To be able to use these APIs you need to create an App in the Developer Console and generate your **apiKey** and **apiSecret**. You can use a redirect URL which will be called after the login flow.  If you are a **trader**, you can directly create apps from Upstox mobile app or the desktop platform itself from **Apps** sections inside the **Account** Tab. Head over to <a href=\"http://account.upstox.com/developer/apps\" target=\"_blank\">account.upstox.com/developer/apps</a>.</br> If you are a **business** looking to integrate Upstox APIs, reach out to us and we will get a custom app created for you in no time.  It is highly recommended that you do not embed the **apiSecret** in your frontend app. Create a remote backend which does the handshake on behalf of the frontend app. Marking the apiSecret in the frontend app will make your app vulnerable to threats and potential issues.   # noqa: E501
+    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
 
-    OpenAPI spec version: v2
+    OpenAPI spec version: v0
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -24,6 +24,7 @@ from upstox_client.api.login_api import LoginApi
 from upstox_client.api.market_holidays_and_timings_api import MarketHolidaysAndTimingsApi
 from upstox_client.api.market_quote_api import MarketQuoteApi
 from upstox_client.api.market_quote_v3_api import MarketQuoteV3Api
+from upstox_client.api.mutual_fund_api import MutualFundApi
 from upstox_client.api.news_api import NewsApi
 from upstox_client.api.options_api import OptionsApi
 from upstox_client.api.order_api import OrderApi
@@ -51,12 +52,12 @@ from upstox_client.models.cancel_or_exit_multi_order_data import CancelOrExitMul
 from upstox_client.models.cancel_or_exit_multi_order_response import CancelOrExitMultiOrderResponse
 from upstox_client.models.cancel_or_exit_order_error_data import CancelOrExitOrderErrorData
 from upstox_client.models.cancel_order_data import CancelOrderData
+from upstox_client.models.cancel_order_response import CancelOrderResponse
+from upstox_client.models.cancel_order_v3_response import CancelOrderV3Response
 from upstox_client.models.cash_available_to_trade import CashAvailableToTrade
 from upstox_client.models.cash_breakdown import CashBreakdown
 from upstox_client.models.cash_margin_used import CashMarginUsed
 from upstox_client.models.cash_unavailable_to_trade import CashUnavailableToTrade
-from upstox_client.models.cancel_order_response import CancelOrderResponse
-from upstox_client.models.cancel_order_v3_response import CancelOrderV3Response
 from upstox_client.models.convert_position_data import ConvertPositionData
 from upstox_client.models.convert_position_request import ConvertPositionRequest
 from upstox_client.models.convert_position_response import ConvertPositionResponse
@@ -66,6 +67,7 @@ from upstox_client.models.depth_map import DepthMap
 from upstox_client.models.dp_plan import DpPlan
 from upstox_client.models.exchange_timing_data import ExchangeTimingData
 from upstox_client.models.expired_future_data import ExpiredFutureData
+from upstox_client.models.family_member_data import FamilyMemberData
 from upstox_client.models.get_brokerage_response import GetBrokerageResponse
 from upstox_client.models.get_exchange_timing_response import GetExchangeTimingResponse
 from upstox_client.models.get_expired_futures_contract_response import GetExpiredFuturesContractResponse
@@ -82,6 +84,10 @@ from upstox_client.models.get_market_quote_ohlc_response import GetMarketQuoteOH
 from upstox_client.models.get_market_quote_ohlc_response_v3 import GetMarketQuoteOHLCResponseV3
 from upstox_client.models.get_market_quote_option_greek_response_v3 import GetMarketQuoteOptionGreekResponseV3
 from upstox_client.models.get_market_status_response import GetMarketStatusResponse
+from upstox_client.models.get_mutual_fund_holdings_response import GetMutualFundHoldingsResponse
+from upstox_client.models.get_mutual_fund_order_details_response import GetMutualFundOrderDetailsResponse
+from upstox_client.models.get_mutual_fund_orders_response import GetMutualFundOrdersResponse
+from upstox_client.models.get_mutual_fund_sips_response import GetMutualFundSipsResponse
 from upstox_client.models.get_news_response import GetNewsResponse
 from upstox_client.models.get_option_chain_response import GetOptionChainResponse
 from upstox_client.models.get_option_contract_response import GetOptionContractResponse
@@ -142,6 +148,10 @@ from upstox_client.models.multi_order_request import MultiOrderRequest
 from upstox_client.models.multi_order_response import MultiOrderResponse
 from upstox_client.models.multi_order_summary import MultiOrderSummary
 from upstox_client.models.multi_order_v3_data import MultiOrderV3Data
+from upstox_client.models.mutual_fund_holding_data import MutualFundHoldingData
+from upstox_client.models.mutual_fund_meta_data import MutualFundMetaData
+from upstox_client.models.mutual_fund_order_data import MutualFundOrderData
+from upstox_client.models.mutual_fund_sip_data import MutualFundSipData
 from upstox_client.models.news_item_data import NewsItemData
 from upstox_client.models.news_response_meta_data import NewsResponseMetaData
 from upstox_client.models.news_response_page_data import NewsResponsePageData
@@ -156,6 +166,9 @@ from upstox_client.models.order_book_data import OrderBookData
 from upstox_client.models.order_data import OrderData
 from upstox_client.models.order_metadata import OrderMetadata
 from upstox_client.models.other_taxes import OtherTaxes
+from upstox_client.models.pagination import Pagination
+from upstox_client.models.payment_history_data import PaymentHistoryData
+from upstox_client.models.payment_history_response import PaymentHistoryResponse
 from upstox_client.models.place_order_data import PlaceOrderData
 from upstox_client.models.place_order_request import PlaceOrderRequest
 from upstox_client.models.place_order_response import PlaceOrderResponse

{upstox-python-sdk-2.23.0 → upstox_python_sdk-2.25.0}/upstox_client/api/__init__.py

@@ -12,6 +12,7 @@ from upstox_client.api.login_api import LoginApi
 from upstox_client.api.market_holidays_and_timings_api import MarketHolidaysAndTimingsApi
 from upstox_client.api.market_quote_api import MarketQuoteApi
 from upstox_client.api.market_quote_v3_api import MarketQuoteV3Api
+from upstox_client.api.mutual_fund_api import MutualFundApi
 from upstox_client.api.news_api import NewsApi
 from upstox_client.api.options_api import OptionsApi
 from upstox_client.api.order_api import OrderApi

upstox_python_sdk-2.25.0/upstox_client/api/mutual_fund_api.py

@@ -0,0 +1,413 @@
+# coding: utf-8
+
+"""
+    OpenAPI definition
+
+    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
+
+    OpenAPI spec version: v0
+    
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from upstox_client.api_client import ApiClient
+
+
+class MutualFundApi(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    Ref: https://github.com/swagger-api/swagger-codegen
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def get_mutual_fund_holdings(self, **kwargs):  # noqa: E501
+        """Get mutual fund holdings  # noqa: E501
+
+        Returns mutual fund holdings for the authenticated user.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_mutual_fund_holdings(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: GetMutualFundHoldingsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_mutual_fund_holdings_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_mutual_fund_holdings_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_mutual_fund_holdings_with_http_info(self, **kwargs):  # noqa: E501
+        """Get mutual fund holdings  # noqa: E501
+
+        Returns mutual fund holdings for the authenticated user.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_mutual_fund_holdings_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :return: GetMutualFundHoldingsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = []  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_mutual_fund_holdings" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['*/*', 'application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['OAUTH2']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/v2/mf/holdings', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='GetMutualFundHoldingsResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
+    def get_mutual_fund_order(self, order_id, **kwargs):  # noqa: E501
+        """Get mutual fund order by id  # noqa: E501
+
+        Returns a single mutual fund order by order id.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_mutual_fund_order(order_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param object order_id: Mutual fund order id (required)
+        :return: GetMutualFundOrderDetailsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_mutual_fund_order_with_http_info(order_id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_mutual_fund_order_with_http_info(order_id, **kwargs)  # noqa: E501
+            return data
+
+    def get_mutual_fund_order_with_http_info(self, order_id, **kwargs):  # noqa: E501
+        """Get mutual fund order by id  # noqa: E501
+
+        Returns a single mutual fund order by order id.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_mutual_fund_order_with_http_info(order_id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param object order_id: Mutual fund order id (required)
+        :return: GetMutualFundOrderDetailsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['order_id']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_mutual_fund_order" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'order_id' is set
+        if ('order_id' not in params or
+                params['order_id'] is None):
+            raise ValueError("Missing the required parameter `order_id` when calling `get_mutual_fund_order`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'order_id' in params:
+            path_params['order_id'] = params['order_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['*/*', 'application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['OAUTH2']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/v2/mf/orders/{order_id}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='GetMutualFundOrderDetailsResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
+    def get_mutual_fund_orders(self, **kwargs):  # noqa: E501
+        """Get mutual fund orders  # noqa: E501
+
+        Returns mutual fund orders from the last 7 days for the authenticated user.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_mutual_fund_orders(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param object status: Mutual fund order status
+        :param object transaction_type: Mutual fund order transaction type
+        :param object page_number: Page number for pagination.
+        :param object records: no of records in a single page
+        :return: GetMutualFundOrdersResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_mutual_fund_orders_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_mutual_fund_orders_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_mutual_fund_orders_with_http_info(self, **kwargs):  # noqa: E501
+        """Get mutual fund orders  # noqa: E501
+
+        Returns mutual fund orders from the last 7 days for the authenticated user.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_mutual_fund_orders_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param object status: Mutual fund order status
+        :param object transaction_type: Mutual fund order transaction type
+        :param object page_number: Page number for pagination.
+        :param object records: no of records in a single page
+        :return: GetMutualFundOrdersResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['status', 'transaction_type', 'page_number', 'records']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_mutual_fund_orders" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'status' in params:
+            query_params.append(('status', params['status']))  # noqa: E501
+        if 'transaction_type' in params:
+            query_params.append(('transaction_type', params['transaction_type']))  # noqa: E501
+        if 'page_number' in params:
+            query_params.append(('page_number', params['page_number']))  # noqa: E501
+        if 'records' in params:
+            query_params.append(('records', params['records']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['*/*', 'application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['OAUTH2']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/v2/mf/orders', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='GetMutualFundOrdersResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
+    def get_mutual_fund_sips(self, **kwargs):  # noqa: E501
+        """Get mutual fund SIPs  # noqa: E501
+
+        Returns active and paused SIP orders for the authenticated user.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_mutual_fund_sips(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param object page_number: Page number for pagination.
+        :param object records: no of records in a single page
+        :return: GetMutualFundSipsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_mutual_fund_sips_with_http_info(**kwargs)  # noqa: E501
+        else:
+            (data) = self.get_mutual_fund_sips_with_http_info(**kwargs)  # noqa: E501
+            return data
+
+    def get_mutual_fund_sips_with_http_info(self, **kwargs):  # noqa: E501
+        """Get mutual fund SIPs  # noqa: E501
+
+        Returns active and paused SIP orders for the authenticated user.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_mutual_fund_sips_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param object page_number: Page number for pagination.
+        :param object records: no of records in a single page
+        :return: GetMutualFundSipsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['page_number', 'records']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_mutual_fund_sips" % key
+                )
+            params[key] = val
+        del params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'page_number' in params:
+            query_params.append(('page_number', params['page_number']))  # noqa: E501
+        if 'records' in params:
+            query_params.append(('records', params['records']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['*/*', 'application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['OAUTH2']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/v2/mf/sips', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='GetMutualFundSipsResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)