snaptrade-python-sdk 11.0.143__py3-none-any.whl → 11.0.145__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- snaptrade_client/__init__.py +1 -1
- snaptrade_client/api_client.py +1 -1
- snaptrade_client/apis/path_to_api.py +6 -0
- snaptrade_client/apis/paths/accounts_account_id_orders_v2.py +7 -0
- snaptrade_client/apis/paths/accounts_account_id_recent_orders_v2.py +7 -0
- snaptrade_client/apis/tag_to_api.py +3 -0
- snaptrade_client/apis/tags/__init__.py +1 -0
- snaptrade_client/apis/tags/experimental_endpoints_api.py +6 -0
- snaptrade_client/apis/tags/experimental_endpoints_api_generated.py +23 -0
- snaptrade_client/client.py +2 -0
- snaptrade_client/client.pyi +2 -0
- snaptrade_client/configuration.py +1 -1
- snaptrade_client/model/account_order_record_leg.py +252 -0
- snaptrade_client/model/account_order_record_leg.pyi +252 -0
- snaptrade_client/model/account_order_record_leg_instrument.py +137 -0
- snaptrade_client/model/account_order_record_leg_instrument.pyi +137 -0
- snaptrade_client/model/account_order_record_status_v2.py +90 -0
- snaptrade_client/model/account_order_record_status_v2.pyi +75 -0
- snaptrade_client/model/account_order_record_status_v2_nullable.py +105 -0
- snaptrade_client/model/account_order_record_status_v2_nullable.pyi +105 -0
- snaptrade_client/model/account_order_record_v2.py +309 -0
- snaptrade_client/model/account_order_record_v2.pyi +309 -0
- snaptrade_client/model/account_orders_v2_response.py +110 -0
- snaptrade_client/model/account_orders_v2_response.pyi +110 -0
- snaptrade_client/model/action_strict_v2.py +25 -0
- snaptrade_client/model/action_strict_v2.pyi +25 -0
- snaptrade_client/models/__init__.py +7 -0
- snaptrade_client/operation_parameter_map.py +35 -0
- snaptrade_client/paths/__init__.py +2 -0
- snaptrade_client/paths/accounts/get.py +2 -2
- snaptrade_client/paths/accounts/get.pyi +2 -2
- snaptrade_client/paths/accounts_account_id/get.py +2 -2
- snaptrade_client/paths/accounts_account_id/get.pyi +2 -2
- snaptrade_client/paths/accounts_account_id_balances/get.py +2 -2
- snaptrade_client/paths/accounts_account_id_balances/get.pyi +2 -2
- snaptrade_client/paths/accounts_account_id_holdings/get.py +2 -2
- snaptrade_client/paths/accounts_account_id_holdings/get.pyi +2 -2
- snaptrade_client/paths/accounts_account_id_options/get.py +2 -2
- snaptrade_client/paths/accounts_account_id_options/get.pyi +2 -2
- snaptrade_client/paths/accounts_account_id_orders/get.py +2 -2
- snaptrade_client/paths/accounts_account_id_orders/get.pyi +2 -2
- snaptrade_client/paths/accounts_account_id_orders_v2/__init__.py +7 -0
- snaptrade_client/paths/accounts_account_id_orders_v2/get.py +592 -0
- snaptrade_client/paths/accounts_account_id_orders_v2/get.pyi +569 -0
- snaptrade_client/paths/accounts_account_id_positions/get.py +2 -2
- snaptrade_client/paths/accounts_account_id_positions/get.pyi +2 -2
- snaptrade_client/paths/accounts_account_id_recent_orders_v2/__init__.py +7 -0
- snaptrade_client/paths/accounts_account_id_recent_orders_v2/get.py +561 -0
- snaptrade_client/paths/accounts_account_id_recent_orders_v2/get.pyi +549 -0
- snaptrade_client/paths/authorizations_authorization_id_refresh/post.py +2 -2
- snaptrade_client/paths/authorizations_authorization_id_refresh/post.pyi +2 -2
- snaptrade_client/type/account_order_record_leg.py +48 -0
- snaptrade_client/type/account_order_record_leg_instrument.py +39 -0
- snaptrade_client/type/account_order_record_status_v2.py +19 -0
- snaptrade_client/type/account_order_record_status_v2_nullable.py +19 -0
- snaptrade_client/type/account_order_record_v2.py +58 -0
- snaptrade_client/type/account_orders_v2_response.py +28 -0
- snaptrade_client/type/action_strict_v2.py +19 -0
- {snaptrade_python_sdk-11.0.143.dist-info → snaptrade_python_sdk-11.0.145.dist-info}/METADATA +124 -11
- {snaptrade_python_sdk-11.0.143.dist-info → snaptrade_python_sdk-11.0.145.dist-info}/RECORD +62 -31
- {snaptrade_python_sdk-11.0.143.dist-info → snaptrade_python_sdk-11.0.145.dist-info}/LICENSE +0 -0
- {snaptrade_python_sdk-11.0.143.dist-info → snaptrade_python_sdk-11.0.145.dist-info}/WHEEL +0 -0
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
SnapTrade
|
|
5
|
+
|
|
6
|
+
Connect brokerage accounts to your app for live positions and trading
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
|
9
|
+
Contact: api@snaptrade.com
|
|
10
|
+
Created by: https://snaptrade.com/
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
from datetime import date, datetime # noqa: F401
|
|
14
|
+
import decimal # noqa: F401
|
|
15
|
+
import functools # noqa: F401
|
|
16
|
+
import io # noqa: F401
|
|
17
|
+
import re # noqa: F401
|
|
18
|
+
import typing # noqa: F401
|
|
19
|
+
import typing_extensions # noqa: F401
|
|
20
|
+
import uuid # noqa: F401
|
|
21
|
+
|
|
22
|
+
import frozendict # noqa: F401
|
|
23
|
+
|
|
24
|
+
from snaptrade_client import schemas # noqa: F401
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class AccountOrdersV2Response(
|
|
28
|
+
schemas.DictSchema
|
|
29
|
+
):
|
|
30
|
+
"""
|
|
31
|
+
This class is auto generated by Konfig (https://konfigthis.com)
|
|
32
|
+
|
|
33
|
+
Contains a standardized list of account orders in the V2 format.
|
|
34
|
+
"""
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class MetaOapg:
|
|
38
|
+
required = {
|
|
39
|
+
"orders",
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
class properties:
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
class orders(
|
|
46
|
+
schemas.ListSchema
|
|
47
|
+
):
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
class MetaOapg:
|
|
51
|
+
|
|
52
|
+
@staticmethod
|
|
53
|
+
def items() -> typing.Type['AccountOrderRecordV2']:
|
|
54
|
+
return AccountOrderRecordV2
|
|
55
|
+
|
|
56
|
+
def __new__(
|
|
57
|
+
cls,
|
|
58
|
+
arg: typing.Union[typing.Tuple['AccountOrderRecordV2'], typing.List['AccountOrderRecordV2']],
|
|
59
|
+
_configuration: typing.Optional[schemas.Configuration] = None,
|
|
60
|
+
) -> 'orders':
|
|
61
|
+
return super().__new__(
|
|
62
|
+
cls,
|
|
63
|
+
arg,
|
|
64
|
+
_configuration=_configuration,
|
|
65
|
+
)
|
|
66
|
+
|
|
67
|
+
def __getitem__(self, i: int) -> 'AccountOrderRecordV2':
|
|
68
|
+
return super().__getitem__(i)
|
|
69
|
+
__annotations__ = {
|
|
70
|
+
"orders": orders,
|
|
71
|
+
}
|
|
72
|
+
additional_properties = schemas.AnyTypeSchema
|
|
73
|
+
|
|
74
|
+
orders: MetaOapg.properties.orders
|
|
75
|
+
|
|
76
|
+
@typing.overload
|
|
77
|
+
def __getitem__(self, name: typing_extensions.Literal["orders"]) -> MetaOapg.properties.orders: ...
|
|
78
|
+
|
|
79
|
+
@typing.overload
|
|
80
|
+
def __getitem__(self, name: str) -> MetaOapg.additional_properties: ...
|
|
81
|
+
|
|
82
|
+
def __getitem__(self, name: typing.Union[typing_extensions.Literal["orders"], str, ]):
|
|
83
|
+
# dict_instance[name] accessor
|
|
84
|
+
return super().__getitem__(name)
|
|
85
|
+
|
|
86
|
+
@typing.overload
|
|
87
|
+
def get_item_oapg(self, name: typing_extensions.Literal["orders"]) -> MetaOapg.properties.orders: ...
|
|
88
|
+
|
|
89
|
+
@typing.overload
|
|
90
|
+
def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ...
|
|
91
|
+
|
|
92
|
+
def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["orders"], str, ]):
|
|
93
|
+
return super().get_item_oapg(name)
|
|
94
|
+
|
|
95
|
+
def __new__(
|
|
96
|
+
cls,
|
|
97
|
+
*args: typing.Union[dict, frozendict.frozendict, ],
|
|
98
|
+
orders: typing.Union[MetaOapg.properties.orders, list, tuple, ],
|
|
99
|
+
_configuration: typing.Optional[schemas.Configuration] = None,
|
|
100
|
+
**kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ],
|
|
101
|
+
) -> 'AccountOrdersV2Response':
|
|
102
|
+
return super().__new__(
|
|
103
|
+
cls,
|
|
104
|
+
*args,
|
|
105
|
+
orders=orders,
|
|
106
|
+
_configuration=_configuration,
|
|
107
|
+
**kwargs,
|
|
108
|
+
)
|
|
109
|
+
|
|
110
|
+
from snaptrade_client.model.account_order_record_v2 import AccountOrderRecordV2
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
SnapTrade
|
|
5
|
+
|
|
6
|
+
Connect brokerage accounts to your app for live positions and trading
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
|
9
|
+
Contact: api@snaptrade.com
|
|
10
|
+
Created by: https://snaptrade.com/
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
from datetime import date, datetime # noqa: F401
|
|
14
|
+
import decimal # noqa: F401
|
|
15
|
+
import functools # noqa: F401
|
|
16
|
+
import io # noqa: F401
|
|
17
|
+
import re # noqa: F401
|
|
18
|
+
import typing # noqa: F401
|
|
19
|
+
import typing_extensions # noqa: F401
|
|
20
|
+
import uuid # noqa: F401
|
|
21
|
+
|
|
22
|
+
import frozendict # noqa: F401
|
|
23
|
+
|
|
24
|
+
from snaptrade_client import schemas # noqa: F401
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class AccountOrdersV2Response(
|
|
28
|
+
schemas.DictSchema
|
|
29
|
+
):
|
|
30
|
+
"""
|
|
31
|
+
This class is auto generated by Konfig (https://konfigthis.com)
|
|
32
|
+
|
|
33
|
+
Contains a standardized list of account orders in the V2 format.
|
|
34
|
+
"""
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class MetaOapg:
|
|
38
|
+
required = {
|
|
39
|
+
"orders",
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
class properties:
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
class orders(
|
|
46
|
+
schemas.ListSchema
|
|
47
|
+
):
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
class MetaOapg:
|
|
51
|
+
|
|
52
|
+
@staticmethod
|
|
53
|
+
def items() -> typing.Type['AccountOrderRecordV2']:
|
|
54
|
+
return AccountOrderRecordV2
|
|
55
|
+
|
|
56
|
+
def __new__(
|
|
57
|
+
cls,
|
|
58
|
+
arg: typing.Union[typing.Tuple['AccountOrderRecordV2'], typing.List['AccountOrderRecordV2']],
|
|
59
|
+
_configuration: typing.Optional[schemas.Configuration] = None,
|
|
60
|
+
) -> 'orders':
|
|
61
|
+
return super().__new__(
|
|
62
|
+
cls,
|
|
63
|
+
arg,
|
|
64
|
+
_configuration=_configuration,
|
|
65
|
+
)
|
|
66
|
+
|
|
67
|
+
def __getitem__(self, i: int) -> 'AccountOrderRecordV2':
|
|
68
|
+
return super().__getitem__(i)
|
|
69
|
+
__annotations__ = {
|
|
70
|
+
"orders": orders,
|
|
71
|
+
}
|
|
72
|
+
additional_properties = schemas.AnyTypeSchema
|
|
73
|
+
|
|
74
|
+
orders: MetaOapg.properties.orders
|
|
75
|
+
|
|
76
|
+
@typing.overload
|
|
77
|
+
def __getitem__(self, name: typing_extensions.Literal["orders"]) -> MetaOapg.properties.orders: ...
|
|
78
|
+
|
|
79
|
+
@typing.overload
|
|
80
|
+
def __getitem__(self, name: str) -> MetaOapg.additional_properties: ...
|
|
81
|
+
|
|
82
|
+
def __getitem__(self, name: typing.Union[typing_extensions.Literal["orders"], str, ]):
|
|
83
|
+
# dict_instance[name] accessor
|
|
84
|
+
return super().__getitem__(name)
|
|
85
|
+
|
|
86
|
+
@typing.overload
|
|
87
|
+
def get_item_oapg(self, name: typing_extensions.Literal["orders"]) -> MetaOapg.properties.orders: ...
|
|
88
|
+
|
|
89
|
+
@typing.overload
|
|
90
|
+
def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ...
|
|
91
|
+
|
|
92
|
+
def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["orders"], str, ]):
|
|
93
|
+
return super().get_item_oapg(name)
|
|
94
|
+
|
|
95
|
+
def __new__(
|
|
96
|
+
cls,
|
|
97
|
+
*args: typing.Union[dict, frozendict.frozendict, ],
|
|
98
|
+
orders: typing.Union[MetaOapg.properties.orders, list, tuple, ],
|
|
99
|
+
_configuration: typing.Optional[schemas.Configuration] = None,
|
|
100
|
+
**kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ],
|
|
101
|
+
) -> 'AccountOrdersV2Response':
|
|
102
|
+
return super().__new__(
|
|
103
|
+
cls,
|
|
104
|
+
*args,
|
|
105
|
+
orders=orders,
|
|
106
|
+
_configuration=_configuration,
|
|
107
|
+
**kwargs,
|
|
108
|
+
)
|
|
109
|
+
|
|
110
|
+
from snaptrade_client.model.account_order_record_v2 import AccountOrderRecordV2
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
SnapTrade
|
|
5
|
+
|
|
6
|
+
Connect brokerage accounts to your app for live positions and trading
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
|
9
|
+
Contact: api@snaptrade.com
|
|
10
|
+
Created by: https://snaptrade.com/
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
from datetime import date, datetime # noqa: F401
|
|
14
|
+
import decimal # noqa: F401
|
|
15
|
+
import functools # noqa: F401
|
|
16
|
+
import io # noqa: F401
|
|
17
|
+
import re # noqa: F401
|
|
18
|
+
import typing # noqa: F401
|
|
19
|
+
import typing_extensions # noqa: F401
|
|
20
|
+
import uuid # noqa: F401
|
|
21
|
+
|
|
22
|
+
import frozendict # noqa: F401
|
|
23
|
+
|
|
24
|
+
from snaptrade_client import schemas # noqa: F401
|
|
25
|
+
ActionStrictV2 = schemas.StrSchema
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
SnapTrade
|
|
5
|
+
|
|
6
|
+
Connect brokerage accounts to your app for live positions and trading
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
|
9
|
+
Contact: api@snaptrade.com
|
|
10
|
+
Created by: https://snaptrade.com/
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
from datetime import date, datetime # noqa: F401
|
|
14
|
+
import decimal # noqa: F401
|
|
15
|
+
import functools # noqa: F401
|
|
16
|
+
import io # noqa: F401
|
|
17
|
+
import re # noqa: F401
|
|
18
|
+
import typing # noqa: F401
|
|
19
|
+
import typing_extensions # noqa: F401
|
|
20
|
+
import uuid # noqa: F401
|
|
21
|
+
|
|
22
|
+
import frozendict # noqa: F401
|
|
23
|
+
|
|
24
|
+
from snaptrade_client import schemas # noqa: F401
|
|
25
|
+
ActionStrictV2 = schemas.StrSchema
|
|
@@ -20,12 +20,19 @@ from snaptrade_client.model.account_id import AccountID
|
|
|
20
20
|
from snaptrade_client.model.account_ids import AccountIDs
|
|
21
21
|
from snaptrade_client.model.account_meta import AccountMeta
|
|
22
22
|
from snaptrade_client.model.account_order_record import AccountOrderRecord
|
|
23
|
+
from snaptrade_client.model.account_order_record_leg import AccountOrderRecordLeg
|
|
24
|
+
from snaptrade_client.model.account_order_record_leg_instrument import AccountOrderRecordLegInstrument
|
|
23
25
|
from snaptrade_client.model.account_order_record_status import AccountOrderRecordStatus
|
|
26
|
+
from snaptrade_client.model.account_order_record_status_v2 import AccountOrderRecordStatusV2
|
|
27
|
+
from snaptrade_client.model.account_order_record_status_v2_nullable import AccountOrderRecordStatusV2Nullable
|
|
28
|
+
from snaptrade_client.model.account_order_record_v2 import AccountOrderRecordV2
|
|
29
|
+
from snaptrade_client.model.account_orders_v2_response import AccountOrdersV2Response
|
|
24
30
|
from snaptrade_client.model.account_simple import AccountSimple
|
|
25
31
|
from snaptrade_client.model.account_sync_status import AccountSyncStatus
|
|
26
32
|
from snaptrade_client.model.account_universal_activity import AccountUniversalActivity
|
|
27
33
|
from snaptrade_client.model.action import Action
|
|
28
34
|
from snaptrade_client.model.action_strict import ActionStrict
|
|
35
|
+
from snaptrade_client.model.action_strict_v2 import ActionStrictV2
|
|
29
36
|
from snaptrade_client.model.action_strict_with_options import ActionStrictWithOptions
|
|
30
37
|
from snaptrade_client.model.balance import Balance
|
|
31
38
|
from snaptrade_client.model.brokerage import Brokerage
|
|
@@ -330,6 +330,41 @@ operation_parameter_map = {
|
|
|
330
330
|
},
|
|
331
331
|
]
|
|
332
332
|
},
|
|
333
|
+
'/accounts/{accountId}/orders/v2-GET': {
|
|
334
|
+
'parameters': [
|
|
335
|
+
{
|
|
336
|
+
'name': 'userId'
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
'name': 'userSecret'
|
|
340
|
+
},
|
|
341
|
+
{
|
|
342
|
+
'name': 'accountId'
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
'name': 'state'
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
'name': 'days'
|
|
349
|
+
},
|
|
350
|
+
]
|
|
351
|
+
},
|
|
352
|
+
'/accounts/{accountId}/recentOrders/v2-GET': {
|
|
353
|
+
'parameters': [
|
|
354
|
+
{
|
|
355
|
+
'name': 'userId'
|
|
356
|
+
},
|
|
357
|
+
{
|
|
358
|
+
'name': 'userSecret'
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
'name': 'accountId'
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
'name': 'only_executed'
|
|
365
|
+
},
|
|
366
|
+
]
|
|
367
|
+
},
|
|
333
368
|
'/accounts/{accountId}/optionsChain-GET': {
|
|
334
369
|
'parameters': [
|
|
335
370
|
{
|
|
@@ -47,6 +47,8 @@ class PathValues(str, enum.Enum):
|
|
|
47
47
|
ACCOUNTS_ACCOUNT_ID_TRADING_CANCEL = "/accounts/{accountId}/trading/cancel"
|
|
48
48
|
ACCOUNTS_ACCOUNT_ID_TRADING_REPLACE = "/accounts/{accountId}/trading/replace"
|
|
49
49
|
SNAP_TRADE_PARTNERS = "/snapTrade/partners"
|
|
50
|
+
ACCOUNTS_ACCOUNT_ID_ORDERS_V2 = "/accounts/{accountId}/orders/v2"
|
|
51
|
+
ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS_V2 = "/accounts/{accountId}/recentOrders/v2"
|
|
50
52
|
ACCOUNTS_ACCOUNT_ID_SYMBOLS = "/accounts/{accountId}/symbols"
|
|
51
53
|
BROKERAGES = "/brokerages"
|
|
52
54
|
BROKERAGES_SLUG_INSTRUMENTS = "/brokerages/{slug}/instruments"
|
|
@@ -410,7 +410,7 @@ class ListUserAccounts(BaseApi):
|
|
|
410
410
|
ApiResponseForDefault,
|
|
411
411
|
api_client.ApiResponseWithoutDeserialization,
|
|
412
412
|
]:
|
|
413
|
-
""" Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
413
|
+
""" Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. """
|
|
414
414
|
args = self._list_user_accounts_mapped_args(
|
|
415
415
|
query_params=query_params,
|
|
416
416
|
user_id=user_id,
|
|
@@ -455,7 +455,7 @@ class ApiForget(BaseApi):
|
|
|
455
455
|
ApiResponseForDefault,
|
|
456
456
|
api_client.ApiResponseWithoutDeserialization,
|
|
457
457
|
]:
|
|
458
|
-
""" Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
458
|
+
""" Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. """
|
|
459
459
|
args = self._list_user_accounts_mapped_args(
|
|
460
460
|
query_params=query_params,
|
|
461
461
|
user_id=user_id,
|
|
@@ -399,7 +399,7 @@ class ListUserAccounts(BaseApi):
|
|
|
399
399
|
ApiResponseForDefault,
|
|
400
400
|
api_client.ApiResponseWithoutDeserialization,
|
|
401
401
|
]:
|
|
402
|
-
""" Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
402
|
+
""" Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. """
|
|
403
403
|
args = self._list_user_accounts_mapped_args(
|
|
404
404
|
query_params=query_params,
|
|
405
405
|
user_id=user_id,
|
|
@@ -444,7 +444,7 @@ class ApiForget(BaseApi):
|
|
|
444
444
|
ApiResponseForDefault,
|
|
445
445
|
api_client.ApiResponseWithoutDeserialization,
|
|
446
446
|
]:
|
|
447
|
-
""" Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.
|
|
447
|
+
""" Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. """
|
|
448
448
|
args = self._list_user_accounts_mapped_args(
|
|
449
449
|
query_params=query_params,
|
|
450
450
|
user_id=user_id,
|
|
@@ -454,7 +454,7 @@ class GetUserAccountDetails(BaseApi):
|
|
|
454
454
|
ApiResponseForDefault,
|
|
455
455
|
api_client.ApiResponseWithoutDeserialization,
|
|
456
456
|
]:
|
|
457
|
-
""" Returns account detail known to SnapTrade for the specified account.
|
|
457
|
+
""" Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
458
458
|
args = self._get_user_account_details_mapped_args(
|
|
459
459
|
query_params=query_params,
|
|
460
460
|
path_params=path_params,
|
|
@@ -509,7 +509,7 @@ class ApiForget(BaseApi):
|
|
|
509
509
|
ApiResponseForDefault,
|
|
510
510
|
api_client.ApiResponseWithoutDeserialization,
|
|
511
511
|
]:
|
|
512
|
-
""" Returns account detail known to SnapTrade for the specified account.
|
|
512
|
+
""" Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
513
513
|
args = self._get_user_account_details_mapped_args(
|
|
514
514
|
query_params=query_params,
|
|
515
515
|
path_params=path_params,
|
|
@@ -443,7 +443,7 @@ class GetUserAccountDetails(BaseApi):
|
|
|
443
443
|
ApiResponseForDefault,
|
|
444
444
|
api_client.ApiResponseWithoutDeserialization,
|
|
445
445
|
]:
|
|
446
|
-
""" Returns account detail known to SnapTrade for the specified account.
|
|
446
|
+
""" Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
447
447
|
args = self._get_user_account_details_mapped_args(
|
|
448
448
|
query_params=query_params,
|
|
449
449
|
path_params=path_params,
|
|
@@ -498,7 +498,7 @@ class ApiForget(BaseApi):
|
|
|
498
498
|
ApiResponseForDefault,
|
|
499
499
|
api_client.ApiResponseWithoutDeserialization,
|
|
500
500
|
]:
|
|
501
|
-
""" Returns account detail known to SnapTrade for the specified account.
|
|
501
|
+
""" Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
502
502
|
args = self._get_user_account_details_mapped_args(
|
|
503
503
|
query_params=query_params,
|
|
504
504
|
path_params=path_params,
|
|
@@ -479,7 +479,7 @@ class GetUserAccountBalance(BaseApi):
|
|
|
479
479
|
ApiResponseForDefault,
|
|
480
480
|
api_client.ApiResponseWithoutDeserialization,
|
|
481
481
|
]:
|
|
482
|
-
""" Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
|
|
482
|
+
""" Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
483
483
|
args = self._get_user_account_balance_mapped_args(
|
|
484
484
|
query_params=query_params,
|
|
485
485
|
path_params=path_params,
|
|
@@ -534,7 +534,7 @@ class ApiForget(BaseApi):
|
|
|
534
534
|
ApiResponseForDefault,
|
|
535
535
|
api_client.ApiResponseWithoutDeserialization,
|
|
536
536
|
]:
|
|
537
|
-
""" Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
|
|
537
|
+
""" Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
538
538
|
args = self._get_user_account_balance_mapped_args(
|
|
539
539
|
query_params=query_params,
|
|
540
540
|
path_params=path_params,
|
|
@@ -468,7 +468,7 @@ class GetUserAccountBalance(BaseApi):
|
|
|
468
468
|
ApiResponseForDefault,
|
|
469
469
|
api_client.ApiResponseWithoutDeserialization,
|
|
470
470
|
]:
|
|
471
|
-
""" Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
|
|
471
|
+
""" Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
472
472
|
args = self._get_user_account_balance_mapped_args(
|
|
473
473
|
query_params=query_params,
|
|
474
474
|
path_params=path_params,
|
|
@@ -523,7 +523,7 @@ class ApiForget(BaseApi):
|
|
|
523
523
|
ApiResponseForDefault,
|
|
524
524
|
api_client.ApiResponseWithoutDeserialization,
|
|
525
525
|
]:
|
|
526
|
-
""" Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
|
|
526
|
+
""" Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
527
527
|
args = self._get_user_account_balance_mapped_args(
|
|
528
528
|
query_params=query_params,
|
|
529
529
|
path_params=path_params,
|
|
@@ -513,7 +513,7 @@ class GetUserHoldings(BaseApi):
|
|
|
513
513
|
ApiResponseFor200,
|
|
514
514
|
api_client.ApiResponseWithoutDeserialization,
|
|
515
515
|
]:
|
|
516
|
-
""" Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
516
|
+
""" Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
517
517
|
args = self._get_user_holdings_mapped_args(
|
|
518
518
|
query_params=query_params,
|
|
519
519
|
path_params=path_params,
|
|
@@ -566,7 +566,7 @@ class ApiForget(BaseApi):
|
|
|
566
566
|
ApiResponseFor200,
|
|
567
567
|
api_client.ApiResponseWithoutDeserialization,
|
|
568
568
|
]:
|
|
569
|
-
""" Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
569
|
+
""" Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
570
570
|
args = self._get_user_holdings_mapped_args(
|
|
571
571
|
query_params=query_params,
|
|
572
572
|
path_params=path_params,
|
|
@@ -499,7 +499,7 @@ class GetUserHoldings(BaseApi):
|
|
|
499
499
|
ApiResponseFor200,
|
|
500
500
|
api_client.ApiResponseWithoutDeserialization,
|
|
501
501
|
]:
|
|
502
|
-
""" Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
502
|
+
""" Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
503
503
|
args = self._get_user_holdings_mapped_args(
|
|
504
504
|
query_params=query_params,
|
|
505
505
|
path_params=path_params,
|
|
@@ -552,7 +552,7 @@ class ApiForget(BaseApi):
|
|
|
552
552
|
ApiResponseFor200,
|
|
553
553
|
api_client.ApiResponseWithoutDeserialization,
|
|
554
554
|
]:
|
|
555
|
-
""" Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
555
|
+
""" Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__ Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
556
556
|
args = self._get_user_holdings_mapped_args(
|
|
557
557
|
query_params=query_params,
|
|
558
558
|
path_params=path_params,
|
|
@@ -473,7 +473,7 @@ class ListOptionHoldings(BaseApi):
|
|
|
473
473
|
ApiResponseFor200,
|
|
474
474
|
api_client.ApiResponseWithoutDeserialization,
|
|
475
475
|
]:
|
|
476
|
-
""" Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
|
|
476
|
+
""" Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. """
|
|
477
477
|
args = self._list_option_holdings_mapped_args(
|
|
478
478
|
query_params=query_params,
|
|
479
479
|
path_params=path_params,
|
|
@@ -526,7 +526,7 @@ class ApiForget(BaseApi):
|
|
|
526
526
|
ApiResponseFor200,
|
|
527
527
|
api_client.ApiResponseWithoutDeserialization,
|
|
528
528
|
]:
|
|
529
|
-
""" Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
|
|
529
|
+
""" Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. """
|
|
530
530
|
args = self._list_option_holdings_mapped_args(
|
|
531
531
|
query_params=query_params,
|
|
532
532
|
path_params=path_params,
|
|
@@ -462,7 +462,7 @@ class ListOptionHoldings(BaseApi):
|
|
|
462
462
|
ApiResponseFor200,
|
|
463
463
|
api_client.ApiResponseWithoutDeserialization,
|
|
464
464
|
]:
|
|
465
|
-
""" Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
|
|
465
|
+
""" Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. """
|
|
466
466
|
args = self._list_option_holdings_mapped_args(
|
|
467
467
|
query_params=query_params,
|
|
468
468
|
path_params=path_params,
|
|
@@ -515,7 +515,7 @@ class ApiForget(BaseApi):
|
|
|
515
515
|
ApiResponseFor200,
|
|
516
516
|
api_client.ApiResponseWithoutDeserialization,
|
|
517
517
|
]:
|
|
518
|
-
""" Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
|
|
518
|
+
""" Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. """
|
|
519
519
|
args = self._list_option_holdings_mapped_args(
|
|
520
520
|
query_params=query_params,
|
|
521
521
|
path_params=path_params,
|
|
@@ -539,7 +539,7 @@ class GetUserAccountOrders(BaseApi):
|
|
|
539
539
|
ApiResponseFor200,
|
|
540
540
|
api_client.ApiResponseWithoutDeserialization,
|
|
541
541
|
]:
|
|
542
|
-
""" Returns a list of recent orders in the specified account.
|
|
542
|
+
""" Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
543
543
|
args = self._get_user_account_orders_mapped_args(
|
|
544
544
|
query_params=query_params,
|
|
545
545
|
path_params=path_params,
|
|
@@ -600,7 +600,7 @@ class ApiForget(BaseApi):
|
|
|
600
600
|
ApiResponseFor200,
|
|
601
601
|
api_client.ApiResponseWithoutDeserialization,
|
|
602
602
|
]:
|
|
603
|
-
""" Returns a list of recent orders in the specified account.
|
|
603
|
+
""" Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don't, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. """
|
|
604
604
|
args = self._get_user_account_orders_mapped_args(
|
|
605
605
|
query_params=query_params,
|
|
606
606
|
path_params=path_params,
|