Skip to content

vinter_abc.py

vinter_abc

VinterAPIABC 

VinterAPIABC(api_key: str, asset_type: str)

Bases: ABC

Parameters:

  • api_key (str) –

    Your API key.

  • asset_type (AssetType(str)) –

    The type of asset you want to get data for. The acceptable asset types listed in the AssetType enum.

Source code in vintersdk/vinter_abc.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
@abstractmethod
def __init__(self, api_key: str, asset_type: str):  # pragma: no cover
    """This function takes in an api_key and asset_type and sets them as attributes of the class

    Parameters
    ----------
    api_key : str
        Your API key.
    asset_type : AssetType (str)
        The type of asset you want to get data for.
        The acceptable asset types listed in the AssetType enum.
    """
    pass

get_active_data abstractmethod 

get_active_data(symbol: str) -> dict

This function returns the data for the active asset

Parameters:

  • symbol (str) –

    The symbol of the asset you want to get data for.

Returns:

  • A dictionary of the data for the active asset –
Source code in vintersdk/vinter_abc.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
@abstractmethod
def get_active_data(self, symbol: str) -> dict:  # pragma: no cover
    """This function returns the data for the active asset

    Parameters
    ----------
    symbol : str
        The symbol of the asset you want to get data for.

    Returns
    -------
        A dictionary of the data for the active asset

    """
    pass

get_all_active_data abstractmethod 

get_all_active_data(
    frequency: str = None, symbol_only: bool = False
) -> Union[list, dict]

This function returns a list of all the active symbols for the asset type

Parameters:

  • frequency (Frequency(str), default: None ) –

    The frequency of the asset you want to get data for., by default None

  • symbol_only (bool, default: False ) –

    If True, it returns a list of symbols only, by default False

Returns:

  • Union[list, dict] –

    A list of data for the active symbols for the asset type

Source code in vintersdk/vinter_abc.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
@abstractmethod
def get_all_active_data(
    self, frequency: str = None, symbol_only: bool = False
) -> Union[list, dict]:  # pragma: no cover
    """
    This function returns a list of all the active symbols for the asset type

    Parameters
    ----------
    frequency : Frequency (str), optional
        The frequency of the asset you want to get data for., by default None
    symbol_only : bool, optional
        If True, it returns a list of symbols only, by default False

    Returns
    -------
    Union[list, dict]
        A list of data for the active symbols for the asset type
    """
    pass

get_data_by_date abstractmethod 

get_data_by_date(
    symbol: str, date: Union[str, list]
) -> dict

This function takes in a symbol and a date and returns a dictionary of the data for that date

This function is only for daily data.

Parameters:

  • symbol (str) –

    The symbol of the asset you want to get data for.

  • date (str | list) –

    The date of the data you want to get. format: YYYY-MM-DD

Returns:

  • A dictionary of the data –
Source code in vintersdk/vinter_abc.py 
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
@abstractmethod
def get_data_by_date(
    self, symbol: str, date: Union[str, list]
) -> dict:  # pragma: no cover
    """This function takes in a symbol and a date and returns a dictionary of the data for that date

    This function is only for daily data.

    Parameters
    ----------
    symbol : str
        The symbol of the asset you want to get data for.
    date : str | list
        The date of the data you want to get. format: YYYY-MM-DD

    Returns
    -------
        A dictionary of the data

    """
    pass

get_data_by_range abstractmethod 

get_data_by_range(
    symbol: str,
    start: str,
    end: str = None,
    limit: int = 1000,
) -> dict

This function takes in a symbol and a start and end date and returns a dictionary of the data for that period

Parameters:

  • symbol (str) –

    The symbol of the asset you want to get data for.

  • start (str) –

    The start datatime . format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.sssZ

  • end (str, default: None ) –

    The end datatime. format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.sssZ

Returns:

  • A dictionary of the data –
Source code in vintersdk/vinter_abc.py 
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
@abstractmethod
def get_data_by_range(
    self, symbol: str, start: str, end: str = None, limit: int = 1000
) -> dict:  # pragma: no cover
    """This function takes in a symbol and a start and end date and returns a dictionary of the data
    for that period

    Parameters
    ----------
    symbol : str
        The symbol of the asset you want to get data for.
    start : str
        The start datatime . format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.sssZ
    end : str
        The end datatime. format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.sssZ

    Returns
    -------
        A dictionary of the data

    """
    pass

get_latest_data abstractmethod 

get_latest_data(symbol: str, limit: int = 1) -> dict

It takes a symbol and a limit as parameters, and returns a dictionary of the latest data for that symbol

Parameters:

  • symbol (str) –

    The symbol of the asset you want to get data for.

  • limit (int, default: 1 ) –

    The number of data points to return.

Returns:

  • A dictionary of the latest data for the symbol and limit. –
Source code in vintersdk/vinter_abc.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
@abstractmethod
def get_latest_data(
    self, symbol: str, limit: int = 1
) -> dict:  # pragma: no cover
    """It takes a symbol and a limit as parameters, and returns a dictionary of the latest data for
    that symbol

    Parameters
    ----------
    symbol : str
        The symbol of the asset you want to get data for.
    limit : int
        The number of data points to return.

    Returns
    -------
        A dictionary of the latest data for the symbol and limit.

    """
    pass

get_latest_value abstractmethod 

get_latest_value(symbol: str) -> float

This function takes in a symbol and returns the latest value for that symbol

Parameters:

  • symbol (str) –

    The symbol of the asset you want to get data for.

Returns:

  • The latest value for the symbol –
Source code in vintersdk/vinter_abc.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
@abstractmethod
def get_latest_value(self, symbol: str) -> float:  # pragma: no cover
    """This function takes in a symbol and returns the latest value for that symbol

    Parameters
    ----------
    symbol : str
        The symbol of the asset you want to get data for.

    Returns
    -------
        The latest value for the symbol

    """
    pass

get_multi_current_rebalance_weight abstractmethod 

get_multi_current_rebalance_weight(symbol: str) -> dict

This function returns the current rebalance weight of multi_assets symbol

Returns:

  • Weight of the current rebalance of the multi_assets symbol –

    OR

    ValueError if the symbol is not a present in the list of active symbols for asset_type multi_assets

Source code in vintersdk/vinter_abc.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@abstractmethod
def get_multi_current_rebalance_weight(
    self, symbol: str
) -> dict:  # pragma: no cover
    """This function returns the current rebalance weight of multi_assets symbol

    Returns
    -------
        Weight of the current rebalance of the multi_assets symbol

        OR

        ValueError if the symbol is not a present in the
        list of active symbols for asset_type multi_assets

    """
    pass

get_multi_next_rebalance_date abstractmethod 

get_multi_next_rebalance_date(
    symbol: str,
) -> Union[str, None]

This function returns the next rebalance date of multi_assets symbol

Returns:

  • Date of the next rebalance of the multi_assets symbol –

    OR

    ValueError if the symbol is not a present in the list of active symbols for asset_type multi_assets

    OR

    None if the symbol Rebalance is not scheduled

Source code in vintersdk/vinter_abc.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
@abstractmethod
def get_multi_next_rebalance_date(
    self, symbol: str
) -> Union[str, None]:  # pragma: no cover
    """This function returns the next rebalance date of multi_assets symbol

    Returns
    -------
        Date of the next rebalance of the multi_assets symbol

        OR

        ValueError if the symbol is not a present in the
        list of active symbols for asset_type multi_assets

        OR

        None if the symbol Rebalance is not scheduled

    """
    pass

get_multi_next_rebalance_weight abstractmethod 

get_multi_next_rebalance_weight(
    symbol: str,
) -> Union[str, None]

This function returns the next rebalance weight of multi_assets symbol

Returns:

  • Weight of the next rebalance of the multi_assets symbol –

    OR

    ValueError if the symbol is not a present in the list of active symbols for asset_type multi_assets

    OR

    None if the symbol Rebalance is not present in the payload

Source code in vintersdk/vinter_abc.py 
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
@abstractmethod
def get_multi_next_rebalance_weight(
    self, symbol: str
) -> Union[str, None]:  # pragma: no cover
    """This function returns the next rebalance weight of multi_assets symbol

    Returns
    -------
        Weight of the next rebalance of the multi_assets symbol

        OR

        ValueError if the symbol is not a present in the
        list of active symbols for asset_type multi_assets

        OR

        None if the symbol Rebalance is not present in the payload

    """
    pass

get_multi_next_review_date abstractmethod 

get_multi_next_review_date(symbol: str) -> Union[str, None]

This function returns the next review date of multi_assets symbol

Returns:

  • Date of the next review of the multi_assets symbol –

    OR

    ValueError if the symbol is not a present in the list of active symbols for asset_type multi_assets

    OR

    None if the symbol Review is not scheduled

Source code in vintersdk/vinter_abc.py 
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
@abstractmethod
def get_multi_next_review_date(
    self, symbol: str
) -> Union[str, None]:  # pragma: no cover
    """This function returns the next review date of multi_assets symbol

    Returns
    -------
        Date of the next review of the multi_assets symbol

        OR

        ValueError if the symbol is not a present in the
        list of active symbols for asset_type multi_assets

        OR

        None if the symbol Review is not scheduled

    """
    pass

get_multi_previous_rebalance_date abstractmethod 

get_multi_previous_rebalance_date(
    symbol: str,
) -> Union[str, None]

This function returns the previous rebalance date of multi_assets symbol

Returns:

  • Date of the previous rebalance of the multi_assets symbol –

    OR

    ValueError if the symbol is not a present in the list of active symbols for asset_type multi_assets

    OR

    None if the symbol Rebalance is not scheduled

Source code in vintersdk/vinter_abc.py 
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
@abstractmethod
def get_multi_previous_rebalance_date(
    self, symbol: str
) -> Union[str, None]:  # pragma: no cover
    """This function returns the previous rebalance date of multi_assets symbol

    Returns
    -------
        Date of the previous rebalance of the multi_assets symbol

        OR

        ValueError if the symbol is not a present in the
        list of active symbols for asset_type multi_assets

        OR

        None if the symbol Rebalance is not scheduled

    """
    pass

get_multi_previous_review_date abstractmethod 

get_multi_previous_review_date(
    symbol: str,
) -> Union[str, None]

This function returns the previous review date of multi_assets symbol

Returns:

  • Date of the previous review of the multi_assets symbol –

    OR

    ValueError if the symbol is not a present in the list of active symbols for asset_type multi_assets

    OR

    None if the symbol Review is not scheduled

Source code in vintersdk/vinter_abc.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
@abstractmethod
def get_multi_previous_review_date(
    self, symbol: str
) -> Union[str, None]:  # pragma: no cover
    """This function returns the previous review date of multi_assets symbol

    Returns
    -------
        Date of the previous review of the multi_assets symbol

        OR

        ValueError if the symbol is not a present in the
        list of active symbols for asset_type multi_assets

        OR

        None if the symbol Review is not scheduled

    """
    pass

get_single_contributions abstractmethod 

get_single_contributions(symbol: str) -> dict

This function returns the contributions of the single_assets symbol

Returns:

  • A dictionary of the contributions of the single_assets symbol –

    OR

    ValueError if the symbol is not a present in the list of active symbols for asset_type single_assets

Source code in vintersdk/vinter_abc.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
@abstractmethod
def get_single_contributions(
    self, symbol: str
) -> dict:  # pragma: no cover
    """This function returns the contributions of the single_assets symbol

    Returns
    -------
        A dictionary of the contributions of the single_assets symbol

        OR

        ValueError if the symbol is not a present in the
        list of active symbols for asset_type single_assets

    """
    pass