|
1
|
|
|
# ================================================================================== # |
|
2
|
|
|
# earnings_trend.py - This file is part of the yfrake package. # |
|
3
|
|
|
# ================================================================================== # |
|
4
|
|
|
# # |
|
5
|
|
|
# MIT License # |
|
6
|
|
|
# # |
|
7
|
|
|
# Copyright (c) 2022 Mattias Aabmets # |
|
8
|
|
|
# # |
|
9
|
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy # |
|
10
|
|
|
# of this software and associated documentation files (the "Software"), to deal # |
|
11
|
|
|
# in the Software without restriction, including without limitation the rights # |
|
12
|
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # |
|
13
|
|
|
# copies of the Software, and to permit persons to whom the Software is # |
|
14
|
|
|
# furnished to do so, subject to the following conditions: # |
|
15
|
|
|
# # |
|
16
|
|
|
# The above copyright notice and this permission notice shall be included in all # |
|
17
|
|
|
# copies or substantial portions of the Software. # |
|
18
|
|
|
# # |
|
19
|
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # |
|
20
|
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # |
|
21
|
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # |
|
22
|
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # |
|
23
|
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # |
|
24
|
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # |
|
25
|
|
|
# SOFTWARE. # |
|
26
|
|
|
# # |
|
27
|
|
|
# ================================================================================== # |
|
28
|
|
|
summary = 'Earnings Trend' |
|
29
|
|
|
description = 'Returns the earnings trend of a security identifier.' |
|
30
|
|
|
|
|
31
|
|
|
# ---------------------------------------------------------------------------------- # |
|
32
|
|
|
parameters = [ |
|
33
|
|
|
{ |
|
34
|
|
|
'name': 'symbol', |
|
35
|
|
|
'description': 'Any valid equity security identifier.', |
|
36
|
|
|
'required': True, |
|
37
|
|
|
'in': 'query', |
|
38
|
|
|
'schema': { |
|
39
|
|
|
'type': str |
|
40
|
|
|
} |
|
41
|
|
|
} |
|
42
|
|
|
] |
|
43
|
|
|
|
|
44
|
|
|
# ---------------------------------------------------------------------------------- # |
|
45
|
|
|
response = { |
|
46
|
|
|
'list': [ |
|
47
|
|
|
{ |
|
48
|
|
|
'maxAge': int, |
|
49
|
|
|
'period': str, |
|
50
|
|
|
'endDate': str, |
|
51
|
|
|
'growth': { |
|
52
|
|
|
'raw': float, |
|
53
|
|
|
'fmt': str |
|
54
|
|
|
}, |
|
55
|
|
|
'earningsEstimate': { |
|
56
|
|
|
'avg': { |
|
57
|
|
|
'raw': float, |
|
58
|
|
|
'fmt': str |
|
59
|
|
|
}, |
|
60
|
|
|
'low': { |
|
61
|
|
|
'raw': float, |
|
62
|
|
|
'fmt': str |
|
63
|
|
|
}, |
|
64
|
|
|
'high': { |
|
65
|
|
|
'raw': float, |
|
66
|
|
|
'fmt': str |
|
67
|
|
|
}, |
|
68
|
|
|
'yearAgoEps': { |
|
69
|
|
|
'raw': float, |
|
70
|
|
|
'fmt': str |
|
71
|
|
|
}, |
|
72
|
|
|
'numberOfAnalysts': { |
|
73
|
|
|
'raw': int, |
|
74
|
|
|
'fmt': str, |
|
75
|
|
|
'longFmt': str |
|
76
|
|
|
}, |
|
77
|
|
|
'growth': { |
|
78
|
|
|
'raw': float, |
|
79
|
|
|
'fmt': str |
|
80
|
|
|
} |
|
81
|
|
|
} |
|
82
|
|
|
} |
|
83
|
|
|
] |
|
84
|
|
|
} |
|
85
|
|
|
|
aabmets /
yfrake
