snaptrade-python-sdk 11.0.115__py3-none-any.whl → 11.0.117__py3-none-any.whl

snaptrade_client/paths/brokerages_brokerage_id_instruments/get.pyi

@@ -0,0 +1,406 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from dataclasses import dataclass
+import typing_extensions
+import urllib3
+from snaptrade_client.request_before_hook import request_before_hook
+import json
+from urllib3._collections import HTTPHeaderDict
+
+from snaptrade_client.api_response import AsyncGeneratorResponse
+from snaptrade_client import api_client, exceptions
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from snaptrade_client import schemas  # noqa: F401
+
+from snaptrade_client.model.brokerage_instruments_response import BrokerageInstrumentsResponse as BrokerageInstrumentsResponseSchema
+
+from snaptrade_client.type.brokerage_instruments_response import BrokerageInstrumentsResponse
+
+# Path params
+BrokerageIdSchema = schemas.UUIDSchema
+RequestRequiredPathParams = typing_extensions.TypedDict(
+    'RequestRequiredPathParams',
+    {
+        'brokerageId': typing.Union[BrokerageIdSchema, str, uuid.UUID, ],
+    }
+)
+RequestOptionalPathParams = typing_extensions.TypedDict(
+    'RequestOptionalPathParams',
+    {
+    },
+    total=False
+)
+
+
+class RequestPathParams(RequestRequiredPathParams, RequestOptionalPathParams):
+    pass
+
+
+request_path_brokerage_id = api_client.PathParameter(
+    name="brokerageId",
+    style=api_client.ParameterStyle.SIMPLE,
+    schema=BrokerageIdSchema,
+    required=True,
+)
+SchemaFor200ResponseBodyApplicationJson = BrokerageInstrumentsResponseSchema
+
+
+@dataclass
+class ApiResponseFor200(api_client.ApiResponse):
+    body: BrokerageInstrumentsResponse
+
+
+@dataclass
+class ApiResponseFor200Async(api_client.AsyncApiResponse):
+    body: BrokerageInstrumentsResponse
+
+
+_response_for_200 = api_client.OpenApiResponse(
+    response_cls=ApiResponseFor200,
+    response_cls_async=ApiResponseFor200Async,
+    content={
+        'application/json': api_client.MediaType(
+            schema=SchemaFor200ResponseBodyApplicationJson),
+    },
+)
+
+
+@dataclass
+class ApiResponseForDefault(api_client.ApiResponse):
+    body: schemas.Unset = schemas.unset
+
+
+@dataclass
+class ApiResponseForDefaultAsync(api_client.AsyncApiResponse):
+    body: schemas.Unset = schemas.unset
+
+
+_response_for_default = api_client.OpenApiResponse(
+    response_cls=ApiResponseForDefault,
+)
+_all_accept_content_types = (
+    'application/json',
+)
+
+
+class BaseApi(api_client.Api):
+
+    def _list_all_brokerage_instruments_mapped_args(
+        self,
+        brokerage_id: typing.Optional[str] = None,
+        path_params: typing.Optional[dict] = {},
+    ) -> api_client.MappedArgs:
+        args: api_client.MappedArgs = api_client.MappedArgs()
+        _path_params = {}
+        if brokerage_id is not None:
+            _path_params["brokerageId"] = brokerage_id
+        args.path = path_params if path_params else _path_params
+        return args
+
+    async def _alist_all_brokerage_instruments_oapg(
+        self,
+        path_params: typing.Optional[dict] = {},
+        skip_deserialization: bool = True,
+        timeout: typing.Optional[typing.Union[float, typing.Tuple]] = None,
+        accept_content_types: typing.Tuple[str] = _all_accept_content_types,
+        stream: bool = False,
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        ApiResponseForDefaultAsync,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        """
+        Get a list of instruments available on the brokerage.
+        :param skip_deserialization: If true then api_response.response will be set but
+            api_response.body and api_response.headers will not be deserialized into schema
+            class instances
+        """
+        self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params)
+        used_path = path.value
+    
+        _path_params = {}
+        for parameter in (
+            request_path_brokerage_id,
+        ):
+            parameter_data = path_params.get(parameter.name, schemas.unset)
+            if parameter_data is schemas.unset:
+                continue
+            serialized_data = parameter.serialize(parameter_data)
+            _path_params.update(serialized_data)
+    
+        for k, v in _path_params.items():
+            used_path = used_path.replace('{%s}' % k, v)
+    
+        _headers = HTTPHeaderDict()
+        # TODO add cookie handling
+        if accept_content_types:
+            for accept_content_type in accept_content_types:
+                _headers.add('Accept', accept_content_type)
+        method = 'get'.upper()
+        request_before_hook(
+            resource_path=used_path,
+            method=method,
+            configuration=self.api_client.configuration,
+            path_template='/brokerages/{brokerageId}/instruments',
+            auth_settings=_auth,
+            headers=_headers,
+        )
+    
+        response = await self.api_client.async_call_api(
+            resource_path=used_path,
+            method=method,
+            headers=_headers,
+            auth_settings=_auth,
+            timeout=timeout,
+            **kwargs
+        )
+    
+        if stream:
+            if not 200 <= response.http_response.status <= 299:
+                body = (await response.http_response.content.read()).decode("utf-8")
+                raise exceptions.ApiStreamingException(
+                    status=response.http_response.status,
+                    reason=response.http_response.reason,
+                    body=body,
+                )
+    
+            async def stream_iterator():
+                """
+                iterates over response.http_response.content and closes connection once iteration has finished
+                """
+                async for line in response.http_response.content:
+                    if line == b'\r\n':
+                        continue
+                    yield line
+                response.http_response.close()
+                await response.session.close()
+            return AsyncGeneratorResponse(
+                content=stream_iterator(),
+                headers=response.http_response.headers,
+                status=response.http_response.status,
+                response=response.http_response
+            )
+    
+        response_for_status = _status_code_to_response.get(str(response.http_response.status))
+        if response_for_status:
+            api_response = await response_for_status.deserialize_async(
+                                                    response,
+                                                    self.api_client.configuration,
+                                                    skip_deserialization=skip_deserialization
+                                                )
+        else:
+            default_response = _status_code_to_response.get('default')
+            if default_response:
+                api_response = default_response.deserialize(
+                                                    response,
+                                                    self.api_client.configuration,
+                                                    skip_deserialization=skip_deserialization
+                                                )
+            else:
+                api_response = api_client.ApiResponseWithoutDeserializationAsync(
+                    response=response.http_response,
+                    round_trip_time=response.round_trip_time,
+                    status=response.http_response.status,
+                    headers=response.http_response.headers,
+                )
+    
+        if not 200 <= api_response.status <= 299:
+            raise exceptions.ApiException(api_response=api_response)
+    
+        # cleanup session / response
+        response.http_response.close()
+        await response.session.close()
+    
+        return api_response
+
+
+    def _list_all_brokerage_instruments_oapg(
+        self,
+        path_params: typing.Optional[dict] = {},
+        skip_deserialization: bool = True,
+        timeout: typing.Optional[typing.Union[float, typing.Tuple]] = None,
+        accept_content_types: typing.Tuple[str] = _all_accept_content_types,
+        stream: bool = False,
+    ) -> typing.Union[
+        ApiResponseFor200,
+        ApiResponseForDefault,
+        api_client.ApiResponseWithoutDeserialization,
+    ]:
+        """
+        Get a list of instruments available on the brokerage.
+        :param skip_deserialization: If true then api_response.response will be set but
+            api_response.body and api_response.headers will not be deserialized into schema
+            class instances
+        """
+        self._verify_typed_dict_inputs_oapg(RequestPathParams, path_params)
+        used_path = path.value
+    
+        _path_params = {}
+        for parameter in (
+            request_path_brokerage_id,
+        ):
+            parameter_data = path_params.get(parameter.name, schemas.unset)
+            if parameter_data is schemas.unset:
+                continue
+            serialized_data = parameter.serialize(parameter_data)
+            _path_params.update(serialized_data)
+    
+        for k, v in _path_params.items():
+            used_path = used_path.replace('{%s}' % k, v)
+    
+        _headers = HTTPHeaderDict()
+        # TODO add cookie handling
+        if accept_content_types:
+            for accept_content_type in accept_content_types:
+                _headers.add('Accept', accept_content_type)
+        method = 'get'.upper()
+        request_before_hook(
+            resource_path=used_path,
+            method=method,
+            configuration=self.api_client.configuration,
+            path_template='/brokerages/{brokerageId}/instruments',
+            auth_settings=_auth,
+            headers=_headers,
+        )
+    
+        response = self.api_client.call_api(
+            resource_path=used_path,
+            method=method,
+            headers=_headers,
+            auth_settings=_auth,
+            timeout=timeout,
+        )
+    
+        response_for_status = _status_code_to_response.get(str(response.http_response.status))
+        if response_for_status:
+            api_response = response_for_status.deserialize(
+                                                    response,
+                                                    self.api_client.configuration,
+                                                    skip_deserialization=skip_deserialization
+                                                )
+        else:
+            default_response = _status_code_to_response.get('default')
+            if default_response:
+                api_response = default_response.deserialize(
+                                                    response,
+                                                    self.api_client.configuration,
+                                                    skip_deserialization=skip_deserialization
+                                                )
+            else:
+                api_response = api_client.ApiResponseWithoutDeserialization(
+                    response=response.http_response,
+                    round_trip_time=response.round_trip_time,
+                    status=response.http_response.status,
+                    headers=response.http_response.headers,
+                )
+    
+        if not 200 <= api_response.status <= 299:
+            raise exceptions.ApiException(api_response=api_response)
+    
+        return api_response
+
+
+class ListAllBrokerageInstruments(BaseApi):
+    # this class is used by api classes that refer to endpoints with operationId fn names
+
+    async def alist_all_brokerage_instruments(
+        self,
+        brokerage_id: typing.Optional[str] = None,
+        path_params: typing.Optional[dict] = {},
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        ApiResponseForDefaultAsync,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        args = self._list_all_brokerage_instruments_mapped_args(
+            path_params=path_params,
+            brokerage_id=brokerage_id,
+        )
+        return await self._alist_all_brokerage_instruments_oapg(
+            path_params=args.path,
+            **kwargs,
+        )
+    
+    def list_all_brokerage_instruments(
+        self,
+        brokerage_id: typing.Optional[str] = None,
+        path_params: typing.Optional[dict] = {},
+    ) -> typing.Union[
+        ApiResponseFor200,
+        ApiResponseForDefault,
+        api_client.ApiResponseWithoutDeserialization,
+    ]:
+        """ Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list. """
+        args = self._list_all_brokerage_instruments_mapped_args(
+            path_params=path_params,
+            brokerage_id=brokerage_id,
+        )
+        return self._list_all_brokerage_instruments_oapg(
+            path_params=args.path,
+        )
+
+class ApiForget(BaseApi):
+    # this class is used by api classes that refer to endpoints by path and http method names
+
+    async def aget(
+        self,
+        brokerage_id: typing.Optional[str] = None,
+        path_params: typing.Optional[dict] = {},
+        **kwargs,
+    ) -> typing.Union[
+        ApiResponseFor200Async,
+        ApiResponseForDefaultAsync,
+        api_client.ApiResponseWithoutDeserializationAsync,
+        AsyncGeneratorResponse,
+    ]:
+        args = self._list_all_brokerage_instruments_mapped_args(
+            path_params=path_params,
+            brokerage_id=brokerage_id,
+        )
+        return await self._alist_all_brokerage_instruments_oapg(
+            path_params=args.path,
+            **kwargs,
+        )
+    
+    def get(
+        self,
+        brokerage_id: typing.Optional[str] = None,
+        path_params: typing.Optional[dict] = {},
+    ) -> typing.Union[
+        ApiResponseFor200,
+        ApiResponseForDefault,
+        api_client.ApiResponseWithoutDeserialization,
+    ]:
+        """ Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list. """
+        args = self._list_all_brokerage_instruments_mapped_args(
+            path_params=path_params,
+            brokerage_id=brokerage_id,
+        )
+        return self._list_all_brokerage_instruments_oapg(
+            path_params=args.path,
+        )
+

snaptrade_client/type/brokerage_id.py

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import datetime, date
+import typing
+from enum import Enum
+from typing_extensions import TypedDict, Literal, TYPE_CHECKING
+
+
+BrokerageID = str

snaptrade_client/type/brokerage_instrument.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import datetime, date
+import typing
+from enum import Enum
+from typing_extensions import TypedDict, Literal, TYPE_CHECKING
+
+
+class RequiredBrokerageInstrument(TypedDict):
+    pass
+
+class OptionalBrokerageInstrument(TypedDict, total=False):
+    # The instrument's trading symbol / ticker.
+    symbol: str
+
+    # The MIC code of the exchange where the instrument is traded.
+    exchange_mic: typing.Optional[str]
+
+    # Whether the instrument is tradeable through the brokerage. `null` if the tradeability is unknown.
+    tradeable: typing.Optional[bool]
+
+    # Whether the instrument allows fractional units. `null` if the fractionability is unknown.
+    fractionable: typing.Optional[bool]
+
+    # The universal symbol ID of the instrument. This is the ID used to reference the instrument in SnapTrade API calls.
+    universal_symbol_id: typing.Optional[str]
+
+class BrokerageInstrument(RequiredBrokerageInstrument, OptionalBrokerageInstrument):
+    pass

snaptrade_client/type/brokerage_instruments_response.py

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import datetime, date
+import typing
+from enum import Enum
+from typing_extensions import TypedDict, Literal, TYPE_CHECKING
+
+from snaptrade_client.type.brokerage_instrument import BrokerageInstrument
+
+class RequiredBrokerageInstrumentsResponse(TypedDict):
+    pass
+
+class OptionalBrokerageInstrumentsResponse(TypedDict, total=False):
+    instruments: typing.List[BrokerageInstrument]
+
+class BrokerageInstrumentsResponse(RequiredBrokerageInstrumentsResponse, OptionalBrokerageInstrumentsResponse):
+    pass

snaptrade_client/type/cancel_order_response.py

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import datetime, date
+import typing
+from enum import Enum
+from typing_extensions import TypedDict, Literal, TYPE_CHECKING
+
+from snaptrade_client.type.cancel_order_response_raw_response import CancelOrderResponseRawResponse
+
+class RequiredCancelOrderResponse(TypedDict):
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    brokerage_order_id: str
+
+
+class OptionalCancelOrderResponse(TypedDict, total=False):
+    raw_response: typing.Optional[CancelOrderResponseRawResponse]
+
+class CancelOrderResponse(RequiredCancelOrderResponse, OptionalCancelOrderResponse):
+    pass

snaptrade_client/type/cancel_order_response_raw_response.py

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import datetime, date
+import typing
+from enum import Enum
+from typing_extensions import TypedDict, Literal, TYPE_CHECKING
+
+
+CancelOrderResponseRawResponse = dict

{snaptrade_python_sdk-11.0.115.dist-info → snaptrade_python_sdk-11.0.117.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snaptrade-python-sdk
-Version: 11.0.115
+Version: 11.0.117
 Summary: Client for SnapTrade
 License: MIT
 Author: SnapTrade
@@ -30,7 +30,7 @@ Description-Content-Type: text/markdown
 Connect brokerage accounts to your app for live positions and trading
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v11.0.115-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.115)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.117-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.117)
 [![README.md](https://img.shields.io/badge/README-Click%20Here-green)](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/python#readme)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
@@ -81,6 +81,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.reference_data.get_symbols`](#snaptradereference_dataget_symbols)
   * [`snaptrade.reference_data.get_symbols_by_ticker`](#snaptradereference_dataget_symbols_by_ticker)
   * [`snaptrade.reference_data.list_all_brokerage_authorization_type`](#snaptradereference_datalist_all_brokerage_authorization_type)
+  * [`snaptrade.reference_data.list_all_brokerage_instruments`](#snaptradereference_datalist_all_brokerage_instruments)
   * [`snaptrade.reference_data.list_all_brokerages`](#snaptradereference_datalist_all_brokerages)
   * [`snaptrade.reference_data.list_all_currencies`](#snaptradereference_datalist_all_currencies)
   * [`snaptrade.reference_data.list_all_currencies_rates`](#snaptradereference_datalist_all_currencies_rates)
@@ -110,7 +111,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.115
+pip install snaptrade-python-sdk==11.0.117
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1565,6 +1566,36 @@ Comma separated value of brokerage slugs
 
 ---
 
+### `snaptrade.reference_data.list_all_brokerage_instruments`<a id="snaptradereference_datalist_all_brokerage_instruments"></a>
+
+Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_all_brokerage_instruments_response = (
+    snaptrade.reference_data.list_all_brokerage_instruments(
+        brokerage_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_id: `str`<a id="brokerage_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageInstrumentsResponse`](./snaptrade_client/type/brokerage_instruments_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/brokerages/{brokerageId}/instruments` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.reference_data.list_all_brokerages`<a id="snaptradereference_datalist_all_brokerages"></a>
 
 Returns a list of all defined Brokerage objects.
@@ -1706,13 +1737,18 @@ cancel_order_response = snaptrade.trading.cancel_order(
 
 ##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
 
+Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`Any`](./snaptrade_client/type/typing_any.py)
 #### 🔄 Return<a id="🔄-return"></a>
 
-[`OrderUpdatedResponse`](./snaptrade_client/type/order_updated_response.py)
+[`CancelOrderResponse`](./snaptrade_client/type/cancel_order_response.py)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/accounts/{accountId}/trading/simple/{brokerageOrderId}/cancel` `post`
+`/accounts/{accountId}/trading/cancel` `post`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)