financegy 3.0__tar.gz → 3.1__tar.gz
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.
- {financegy-3.0 → financegy-3.1}/PKG-INFO +67 -29
- {financegy-3.0 → financegy-3.1}/README.md +66 -28
- {financegy-3.0 → financegy-3.1}/financegy.egg-info/PKG-INFO +67 -29
- {financegy-3.0 → financegy-3.1}/pyproject.toml +1 -1
- {financegy-3.0 → financegy-3.1}/LICENSE +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/__init__.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/cache/cache_manager.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/config.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/core/parser.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/core/request_handler.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/helpers/safe_text.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/helpers/to_float.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/modules/portfolio.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/modules/securities.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy/utils/utils.py +0 -0
- {financegy-3.0 → financegy-3.1}/financegy.egg-info/SOURCES.txt +0 -0
- {financegy-3.0 → financegy-3.1}/financegy.egg-info/dependency_links.txt +0 -0
- {financegy-3.0 → financegy-3.1}/financegy.egg-info/requires.txt +0 -0
- {financegy-3.0 → financegy-3.1}/financegy.egg-info/top_level.txt +0 -0
- {financegy-3.0 → financegy-3.1}/setup.cfg +0 -0
- {financegy-3.0 → financegy-3.1}/tests/test_securities.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: financegy
|
|
3
|
-
Version: 3.
|
|
3
|
+
Version: 3.1
|
|
4
4
|
Summary: Unofficial Python library for accessing GSE (Guyana Stock Exchange) financial data
|
|
5
5
|
Author-email: Ezra Minty <ezranminty@gmail.com>
|
|
6
6
|
License: MIT
|
|
@@ -70,7 +70,7 @@ search_results = financegy.search_securities("DDL")
|
|
|
70
70
|
# Get all trades for a specific year
|
|
71
71
|
year_trades = financegy.get_trades_for_year("DDL", "2019")
|
|
72
72
|
|
|
73
|
-
# Get historical trades within a date range
|
|
73
|
+
# Get historical trades within a date range - supports: yyyy / mm/yyyy / dd/mm/yyyy
|
|
74
74
|
historical_trades = financegy.get_historical_trades(
|
|
75
75
|
symbol="DDL",
|
|
76
76
|
start_date="01/06/2020",
|
|
@@ -96,6 +96,35 @@ volatility = financegy.get_sessions_volatility("DDL", 30)
|
|
|
96
96
|
# Year-to-date high and low traded prices
|
|
97
97
|
ytd_high_low = financegy.get_ytd_high_low("DDL")
|
|
98
98
|
|
|
99
|
+
# --------------------------
|
|
100
|
+
# Portfolio / Position Calculations
|
|
101
|
+
# --------------------------
|
|
102
|
+
|
|
103
|
+
# Calculate the current market value of a position
|
|
104
|
+
position_value = financegy.calculate_position_value("DDL", shares=50)
|
|
105
|
+
|
|
106
|
+
# Calculate unrealized gain or loss for a position
|
|
107
|
+
position_return = financegy.calculate_position_return(
|
|
108
|
+
symbol="DDL",
|
|
109
|
+
shares=50,
|
|
110
|
+
purchase_price=250
|
|
111
|
+
)
|
|
112
|
+
|
|
113
|
+
# Calculate percentage return for a position
|
|
114
|
+
position_return_percent = financegy.calculate_position_return_percent(
|
|
115
|
+
symbol="DDL",
|
|
116
|
+
shares=50,
|
|
117
|
+
purchase_price=250
|
|
118
|
+
)
|
|
119
|
+
|
|
120
|
+
# Portfolio-level summary
|
|
121
|
+
portfolio = [
|
|
122
|
+
{"symbol": "DTC", "shares": 100, "purchase_price": 300},
|
|
123
|
+
{"symbol": "DDL", "shares": 50, "purchase_price": 250},
|
|
124
|
+
]
|
|
125
|
+
|
|
126
|
+
portfolio_summary = financegy.calculate_portfolio_summary(portfolio)
|
|
127
|
+
|
|
99
128
|
# --------------------------
|
|
100
129
|
# Utilities
|
|
101
130
|
# --------------------------
|
|
@@ -117,39 +146,48 @@ financegy.clear_cache(silent=True)
|
|
|
117
146
|
|
|
118
147
|
### Core Data Retrieval
|
|
119
148
|
|
|
120
|
-
| Function | Description
|
|
121
|
-
| ----------------------------------------------------- |
|
|
122
|
-
| `get_securities()` | Returns all currently traded securities on the GSE.
|
|
123
|
-
| `get_security_by_symbol(symbol)` | Returns the full security name for a ticker symbol
|
|
124
|
-
| `get_recent_trade(symbol)` | Returns the most recent trade information for the given security.
|
|
125
|
-
| `get_security_recent_year(symbol)` | Returns all trade data for the most recent year available for the selected security.
|
|
126
|
-
| `get_session_trades(session)` | Returns trade data for
|
|
127
|
-
| `get_security_session_trade(symbol, session)` | Returns trade data for a
|
|
128
|
-
| `search_securities(query)` | Searches securities whose names or ticker symbols match the given query
|
|
129
|
-
| `get_trades_for_year(symbol, year)` | Returns all trade records for a specific security during a given year.
|
|
130
|
-
| `get_historical_trades(symbol, start_date, end_date)` | Returns historical trades within the specified date range
|
|
149
|
+
| Function | Description |
|
|
150
|
+
| ----------------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
151
|
+
| `get_securities()` | Returns all currently traded securities on the GSE. |
|
|
152
|
+
| `get_security_by_symbol(symbol)` | Returns the full security name for a ticker symbol. |
|
|
153
|
+
| `get_recent_trade(symbol)` | Returns the most recent trade information for the given security. |
|
|
154
|
+
| `get_security_recent_year(symbol)` | Returns all trade data for the most recent year available for the selected security. |
|
|
155
|
+
| `get_session_trades(session)` | Returns trade data for all securities during a specific trading session. |
|
|
156
|
+
| `get_security_session_trade(symbol, session)` | Returns trade data for a specific security during a specific session. |
|
|
157
|
+
| `search_securities(query)` | Searches securities whose names or ticker symbols match the given query. |
|
|
158
|
+
| `get_trades_for_year(symbol, year)` | Returns all trade records for a specific security during a given year. |
|
|
159
|
+
| `get_historical_trades(symbol, start_date, end_date)` | Returns historical trades within the specified date range. |
|
|
131
160
|
|
|
132
161
|
### Analytics / Calculation Functions
|
|
133
162
|
|
|
134
|
-
| Function | Description
|
|
135
|
-
| ---------------------------------------------------------------- |
|
|
136
|
-
| `get_previous_close(symbol)` | Returns the most recent closing/last trade price
|
|
137
|
-
| `get_price_change(symbol)` | Returns absolute price difference
|
|
138
|
-
| `get_price_change_percent(symbol)` | Returns percent price change
|
|
139
|
-
| `get_latest_session_for_symbol(symbol)` | Returns the latest trade dict for the symbol
|
|
140
|
-
| `get_sessions_average_price(symbol, session_start, session_end)` | Returns the average last traded price over a session range
|
|
141
|
-
| `get_average_price(symbol, session_number)` | Returns the average last traded price over the last
|
|
142
|
-
| `get_sessions_volatility(symbol, session_number)` | Returns volatility over the last
|
|
143
|
-
| `get_ytd_high_low(symbol)` | Returns year-to-date highest and lowest traded prices
|
|
163
|
+
| Function | Description |
|
|
164
|
+
| ---------------------------------------------------------------- | --------------------------------------------------------------- |
|
|
165
|
+
| `get_previous_close(symbol)` | Returns the most recent closing/last trade price. |
|
|
166
|
+
| `get_price_change(symbol)` | Returns absolute price difference vs previous session close. |
|
|
167
|
+
| `get_price_change_percent(symbol)` | Returns percent price change vs previous session close. |
|
|
168
|
+
| `get_latest_session_for_symbol(symbol)` | Returns the latest trade dict for the symbol. |
|
|
169
|
+
| `get_sessions_average_price(symbol, session_start, session_end)` | Returns the average last traded price over a session range. |
|
|
170
|
+
| `get_average_price(symbol, session_number)` | Returns the average last traded price over the last N sessions. |
|
|
171
|
+
| `get_sessions_volatility(symbol, session_number)` | Returns volatility over the last N sessions. |
|
|
172
|
+
| `get_ytd_high_low(symbol)` | Returns year-to-date highest and lowest traded prices. |
|
|
173
|
+
|
|
174
|
+
### Portfolio / Position Functions
|
|
175
|
+
|
|
176
|
+
| Function | Description |
|
|
177
|
+
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
178
|
+
| `calculate_position_value(symbol, shares)` | Calculates the current market value of a position using the latest trade price. |
|
|
179
|
+
| `calculate_position_return(symbol, shares, purchase_price)` | Calculates the unrealized gain or loss for a position. |
|
|
180
|
+
| `calculate_position_return_percent(symbol, shares, purchase_price)` | Calculates the percentage return for a position. |
|
|
181
|
+
| `calculate_portfolio_summary(positions)` | Computes a full portfolio summary including totals and per-position breakdown. |
|
|
144
182
|
|
|
145
183
|
### Utilities
|
|
146
184
|
|
|
147
|
-
| Function | Description
|
|
148
|
-
| ---------------------------------------------------------------------- |
|
|
149
|
-
| `to_dataframe(data)` | Converts FinanceGY list/dict results into a
|
|
150
|
-
| `save_to_csv(data, filename="output.csv", path=None, silent=False)` | Saves data to a CSV file.
|
|
151
|
-
| `save_to_excel(data, filename="output.xlsx", path=None, silent=False)` | Saves data to an Excel file.
|
|
152
|
-
| `clear_cache(silent=False)` | Completely clears the FinanceGY cache directory.
|
|
185
|
+
| Function | Description |
|
|
186
|
+
| ---------------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
187
|
+
| `to_dataframe(data)` | Converts FinanceGY list/dict results into a pandas DataFrame. |
|
|
188
|
+
| `save_to_csv(data, filename="output.csv", path=None, silent=False)` | Saves data to a CSV file. |
|
|
189
|
+
| `save_to_excel(data, filename="output.xlsx", path=None, silent=False)` | Saves data to an Excel file. |
|
|
190
|
+
| `clear_cache(silent=False)` | Completely clears the FinanceGY cache directory. |
|
|
153
191
|
|
|
154
192
|
---
|
|
155
193
|
|
|
@@ -54,7 +54,7 @@ search_results = financegy.search_securities("DDL")
|
|
|
54
54
|
# Get all trades for a specific year
|
|
55
55
|
year_trades = financegy.get_trades_for_year("DDL", "2019")
|
|
56
56
|
|
|
57
|
-
# Get historical trades within a date range
|
|
57
|
+
# Get historical trades within a date range - supports: yyyy / mm/yyyy / dd/mm/yyyy
|
|
58
58
|
historical_trades = financegy.get_historical_trades(
|
|
59
59
|
symbol="DDL",
|
|
60
60
|
start_date="01/06/2020",
|
|
@@ -80,6 +80,35 @@ volatility = financegy.get_sessions_volatility("DDL", 30)
|
|
|
80
80
|
# Year-to-date high and low traded prices
|
|
81
81
|
ytd_high_low = financegy.get_ytd_high_low("DDL")
|
|
82
82
|
|
|
83
|
+
# --------------------------
|
|
84
|
+
# Portfolio / Position Calculations
|
|
85
|
+
# --------------------------
|
|
86
|
+
|
|
87
|
+
# Calculate the current market value of a position
|
|
88
|
+
position_value = financegy.calculate_position_value("DDL", shares=50)
|
|
89
|
+
|
|
90
|
+
# Calculate unrealized gain or loss for a position
|
|
91
|
+
position_return = financegy.calculate_position_return(
|
|
92
|
+
symbol="DDL",
|
|
93
|
+
shares=50,
|
|
94
|
+
purchase_price=250
|
|
95
|
+
)
|
|
96
|
+
|
|
97
|
+
# Calculate percentage return for a position
|
|
98
|
+
position_return_percent = financegy.calculate_position_return_percent(
|
|
99
|
+
symbol="DDL",
|
|
100
|
+
shares=50,
|
|
101
|
+
purchase_price=250
|
|
102
|
+
)
|
|
103
|
+
|
|
104
|
+
# Portfolio-level summary
|
|
105
|
+
portfolio = [
|
|
106
|
+
{"symbol": "DTC", "shares": 100, "purchase_price": 300},
|
|
107
|
+
{"symbol": "DDL", "shares": 50, "purchase_price": 250},
|
|
108
|
+
]
|
|
109
|
+
|
|
110
|
+
portfolio_summary = financegy.calculate_portfolio_summary(portfolio)
|
|
111
|
+
|
|
83
112
|
# --------------------------
|
|
84
113
|
# Utilities
|
|
85
114
|
# --------------------------
|
|
@@ -101,39 +130,48 @@ financegy.clear_cache(silent=True)
|
|
|
101
130
|
|
|
102
131
|
### Core Data Retrieval
|
|
103
132
|
|
|
104
|
-
| Function | Description
|
|
105
|
-
| ----------------------------------------------------- |
|
|
106
|
-
| `get_securities()` | Returns all currently traded securities on the GSE.
|
|
107
|
-
| `get_security_by_symbol(symbol)` | Returns the full security name for a ticker symbol
|
|
108
|
-
| `get_recent_trade(symbol)` | Returns the most recent trade information for the given security.
|
|
109
|
-
| `get_security_recent_year(symbol)` | Returns all trade data for the most recent year available for the selected security.
|
|
110
|
-
| `get_session_trades(session)` | Returns trade data for
|
|
111
|
-
| `get_security_session_trade(symbol, session)` | Returns trade data for a
|
|
112
|
-
| `search_securities(query)` | Searches securities whose names or ticker symbols match the given query
|
|
113
|
-
| `get_trades_for_year(symbol, year)` | Returns all trade records for a specific security during a given year.
|
|
114
|
-
| `get_historical_trades(symbol, start_date, end_date)` | Returns historical trades within the specified date range
|
|
133
|
+
| Function | Description |
|
|
134
|
+
| ----------------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
135
|
+
| `get_securities()` | Returns all currently traded securities on the GSE. |
|
|
136
|
+
| `get_security_by_symbol(symbol)` | Returns the full security name for a ticker symbol. |
|
|
137
|
+
| `get_recent_trade(symbol)` | Returns the most recent trade information for the given security. |
|
|
138
|
+
| `get_security_recent_year(symbol)` | Returns all trade data for the most recent year available for the selected security. |
|
|
139
|
+
| `get_session_trades(session)` | Returns trade data for all securities during a specific trading session. |
|
|
140
|
+
| `get_security_session_trade(symbol, session)` | Returns trade data for a specific security during a specific session. |
|
|
141
|
+
| `search_securities(query)` | Searches securities whose names or ticker symbols match the given query. |
|
|
142
|
+
| `get_trades_for_year(symbol, year)` | Returns all trade records for a specific security during a given year. |
|
|
143
|
+
| `get_historical_trades(symbol, start_date, end_date)` | Returns historical trades within the specified date range. |
|
|
115
144
|
|
|
116
145
|
### Analytics / Calculation Functions
|
|
117
146
|
|
|
118
|
-
| Function | Description
|
|
119
|
-
| ---------------------------------------------------------------- |
|
|
120
|
-
| `get_previous_close(symbol)` | Returns the most recent closing/last trade price
|
|
121
|
-
| `get_price_change(symbol)` | Returns absolute price difference
|
|
122
|
-
| `get_price_change_percent(symbol)` | Returns percent price change
|
|
123
|
-
| `get_latest_session_for_symbol(symbol)` | Returns the latest trade dict for the symbol
|
|
124
|
-
| `get_sessions_average_price(symbol, session_start, session_end)` | Returns the average last traded price over a session range
|
|
125
|
-
| `get_average_price(symbol, session_number)` | Returns the average last traded price over the last
|
|
126
|
-
| `get_sessions_volatility(symbol, session_number)` | Returns volatility over the last
|
|
127
|
-
| `get_ytd_high_low(symbol)` | Returns year-to-date highest and lowest traded prices
|
|
147
|
+
| Function | Description |
|
|
148
|
+
| ---------------------------------------------------------------- | --------------------------------------------------------------- |
|
|
149
|
+
| `get_previous_close(symbol)` | Returns the most recent closing/last trade price. |
|
|
150
|
+
| `get_price_change(symbol)` | Returns absolute price difference vs previous session close. |
|
|
151
|
+
| `get_price_change_percent(symbol)` | Returns percent price change vs previous session close. |
|
|
152
|
+
| `get_latest_session_for_symbol(symbol)` | Returns the latest trade dict for the symbol. |
|
|
153
|
+
| `get_sessions_average_price(symbol, session_start, session_end)` | Returns the average last traded price over a session range. |
|
|
154
|
+
| `get_average_price(symbol, session_number)` | Returns the average last traded price over the last N sessions. |
|
|
155
|
+
| `get_sessions_volatility(symbol, session_number)` | Returns volatility over the last N sessions. |
|
|
156
|
+
| `get_ytd_high_low(symbol)` | Returns year-to-date highest and lowest traded prices. |
|
|
157
|
+
|
|
158
|
+
### Portfolio / Position Functions
|
|
159
|
+
|
|
160
|
+
| Function | Description |
|
|
161
|
+
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
162
|
+
| `calculate_position_value(symbol, shares)` | Calculates the current market value of a position using the latest trade price. |
|
|
163
|
+
| `calculate_position_return(symbol, shares, purchase_price)` | Calculates the unrealized gain or loss for a position. |
|
|
164
|
+
| `calculate_position_return_percent(symbol, shares, purchase_price)` | Calculates the percentage return for a position. |
|
|
165
|
+
| `calculate_portfolio_summary(positions)` | Computes a full portfolio summary including totals and per-position breakdown. |
|
|
128
166
|
|
|
129
167
|
### Utilities
|
|
130
168
|
|
|
131
|
-
| Function | Description
|
|
132
|
-
| ---------------------------------------------------------------------- |
|
|
133
|
-
| `to_dataframe(data)` | Converts FinanceGY list/dict results into a
|
|
134
|
-
| `save_to_csv(data, filename="output.csv", path=None, silent=False)` | Saves data to a CSV file.
|
|
135
|
-
| `save_to_excel(data, filename="output.xlsx", path=None, silent=False)` | Saves data to an Excel file.
|
|
136
|
-
| `clear_cache(silent=False)` | Completely clears the FinanceGY cache directory.
|
|
169
|
+
| Function | Description |
|
|
170
|
+
| ---------------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
171
|
+
| `to_dataframe(data)` | Converts FinanceGY list/dict results into a pandas DataFrame. |
|
|
172
|
+
| `save_to_csv(data, filename="output.csv", path=None, silent=False)` | Saves data to a CSV file. |
|
|
173
|
+
| `save_to_excel(data, filename="output.xlsx", path=None, silent=False)` | Saves data to an Excel file. |
|
|
174
|
+
| `clear_cache(silent=False)` | Completely clears the FinanceGY cache directory. |
|
|
137
175
|
|
|
138
176
|
---
|
|
139
177
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: financegy
|
|
3
|
-
Version: 3.
|
|
3
|
+
Version: 3.1
|
|
4
4
|
Summary: Unofficial Python library for accessing GSE (Guyana Stock Exchange) financial data
|
|
5
5
|
Author-email: Ezra Minty <ezranminty@gmail.com>
|
|
6
6
|
License: MIT
|
|
@@ -70,7 +70,7 @@ search_results = financegy.search_securities("DDL")
|
|
|
70
70
|
# Get all trades for a specific year
|
|
71
71
|
year_trades = financegy.get_trades_for_year("DDL", "2019")
|
|
72
72
|
|
|
73
|
-
# Get historical trades within a date range
|
|
73
|
+
# Get historical trades within a date range - supports: yyyy / mm/yyyy / dd/mm/yyyy
|
|
74
74
|
historical_trades = financegy.get_historical_trades(
|
|
75
75
|
symbol="DDL",
|
|
76
76
|
start_date="01/06/2020",
|
|
@@ -96,6 +96,35 @@ volatility = financegy.get_sessions_volatility("DDL", 30)
|
|
|
96
96
|
# Year-to-date high and low traded prices
|
|
97
97
|
ytd_high_low = financegy.get_ytd_high_low("DDL")
|
|
98
98
|
|
|
99
|
+
# --------------------------
|
|
100
|
+
# Portfolio / Position Calculations
|
|
101
|
+
# --------------------------
|
|
102
|
+
|
|
103
|
+
# Calculate the current market value of a position
|
|
104
|
+
position_value = financegy.calculate_position_value("DDL", shares=50)
|
|
105
|
+
|
|
106
|
+
# Calculate unrealized gain or loss for a position
|
|
107
|
+
position_return = financegy.calculate_position_return(
|
|
108
|
+
symbol="DDL",
|
|
109
|
+
shares=50,
|
|
110
|
+
purchase_price=250
|
|
111
|
+
)
|
|
112
|
+
|
|
113
|
+
# Calculate percentage return for a position
|
|
114
|
+
position_return_percent = financegy.calculate_position_return_percent(
|
|
115
|
+
symbol="DDL",
|
|
116
|
+
shares=50,
|
|
117
|
+
purchase_price=250
|
|
118
|
+
)
|
|
119
|
+
|
|
120
|
+
# Portfolio-level summary
|
|
121
|
+
portfolio = [
|
|
122
|
+
{"symbol": "DTC", "shares": 100, "purchase_price": 300},
|
|
123
|
+
{"symbol": "DDL", "shares": 50, "purchase_price": 250},
|
|
124
|
+
]
|
|
125
|
+
|
|
126
|
+
portfolio_summary = financegy.calculate_portfolio_summary(portfolio)
|
|
127
|
+
|
|
99
128
|
# --------------------------
|
|
100
129
|
# Utilities
|
|
101
130
|
# --------------------------
|
|
@@ -117,39 +146,48 @@ financegy.clear_cache(silent=True)
|
|
|
117
146
|
|
|
118
147
|
### Core Data Retrieval
|
|
119
148
|
|
|
120
|
-
| Function | Description
|
|
121
|
-
| ----------------------------------------------------- |
|
|
122
|
-
| `get_securities()` | Returns all currently traded securities on the GSE.
|
|
123
|
-
| `get_security_by_symbol(symbol)` | Returns the full security name for a ticker symbol
|
|
124
|
-
| `get_recent_trade(symbol)` | Returns the most recent trade information for the given security.
|
|
125
|
-
| `get_security_recent_year(symbol)` | Returns all trade data for the most recent year available for the selected security.
|
|
126
|
-
| `get_session_trades(session)` | Returns trade data for
|
|
127
|
-
| `get_security_session_trade(symbol, session)` | Returns trade data for a
|
|
128
|
-
| `search_securities(query)` | Searches securities whose names or ticker symbols match the given query
|
|
129
|
-
| `get_trades_for_year(symbol, year)` | Returns all trade records for a specific security during a given year.
|
|
130
|
-
| `get_historical_trades(symbol, start_date, end_date)` | Returns historical trades within the specified date range
|
|
149
|
+
| Function | Description |
|
|
150
|
+
| ----------------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
151
|
+
| `get_securities()` | Returns all currently traded securities on the GSE. |
|
|
152
|
+
| `get_security_by_symbol(symbol)` | Returns the full security name for a ticker symbol. |
|
|
153
|
+
| `get_recent_trade(symbol)` | Returns the most recent trade information for the given security. |
|
|
154
|
+
| `get_security_recent_year(symbol)` | Returns all trade data for the most recent year available for the selected security. |
|
|
155
|
+
| `get_session_trades(session)` | Returns trade data for all securities during a specific trading session. |
|
|
156
|
+
| `get_security_session_trade(symbol, session)` | Returns trade data for a specific security during a specific session. |
|
|
157
|
+
| `search_securities(query)` | Searches securities whose names or ticker symbols match the given query. |
|
|
158
|
+
| `get_trades_for_year(symbol, year)` | Returns all trade records for a specific security during a given year. |
|
|
159
|
+
| `get_historical_trades(symbol, start_date, end_date)` | Returns historical trades within the specified date range. |
|
|
131
160
|
|
|
132
161
|
### Analytics / Calculation Functions
|
|
133
162
|
|
|
134
|
-
| Function | Description
|
|
135
|
-
| ---------------------------------------------------------------- |
|
|
136
|
-
| `get_previous_close(symbol)` | Returns the most recent closing/last trade price
|
|
137
|
-
| `get_price_change(symbol)` | Returns absolute price difference
|
|
138
|
-
| `get_price_change_percent(symbol)` | Returns percent price change
|
|
139
|
-
| `get_latest_session_for_symbol(symbol)` | Returns the latest trade dict for the symbol
|
|
140
|
-
| `get_sessions_average_price(symbol, session_start, session_end)` | Returns the average last traded price over a session range
|
|
141
|
-
| `get_average_price(symbol, session_number)` | Returns the average last traded price over the last
|
|
142
|
-
| `get_sessions_volatility(symbol, session_number)` | Returns volatility over the last
|
|
143
|
-
| `get_ytd_high_low(symbol)` | Returns year-to-date highest and lowest traded prices
|
|
163
|
+
| Function | Description |
|
|
164
|
+
| ---------------------------------------------------------------- | --------------------------------------------------------------- |
|
|
165
|
+
| `get_previous_close(symbol)` | Returns the most recent closing/last trade price. |
|
|
166
|
+
| `get_price_change(symbol)` | Returns absolute price difference vs previous session close. |
|
|
167
|
+
| `get_price_change_percent(symbol)` | Returns percent price change vs previous session close. |
|
|
168
|
+
| `get_latest_session_for_symbol(symbol)` | Returns the latest trade dict for the symbol. |
|
|
169
|
+
| `get_sessions_average_price(symbol, session_start, session_end)` | Returns the average last traded price over a session range. |
|
|
170
|
+
| `get_average_price(symbol, session_number)` | Returns the average last traded price over the last N sessions. |
|
|
171
|
+
| `get_sessions_volatility(symbol, session_number)` | Returns volatility over the last N sessions. |
|
|
172
|
+
| `get_ytd_high_low(symbol)` | Returns year-to-date highest and lowest traded prices. |
|
|
173
|
+
|
|
174
|
+
### Portfolio / Position Functions
|
|
175
|
+
|
|
176
|
+
| Function | Description |
|
|
177
|
+
| ------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
178
|
+
| `calculate_position_value(symbol, shares)` | Calculates the current market value of a position using the latest trade price. |
|
|
179
|
+
| `calculate_position_return(symbol, shares, purchase_price)` | Calculates the unrealized gain or loss for a position. |
|
|
180
|
+
| `calculate_position_return_percent(symbol, shares, purchase_price)` | Calculates the percentage return for a position. |
|
|
181
|
+
| `calculate_portfolio_summary(positions)` | Computes a full portfolio summary including totals and per-position breakdown. |
|
|
144
182
|
|
|
145
183
|
### Utilities
|
|
146
184
|
|
|
147
|
-
| Function | Description
|
|
148
|
-
| ---------------------------------------------------------------------- |
|
|
149
|
-
| `to_dataframe(data)` | Converts FinanceGY list/dict results into a
|
|
150
|
-
| `save_to_csv(data, filename="output.csv", path=None, silent=False)` | Saves data to a CSV file.
|
|
151
|
-
| `save_to_excel(data, filename="output.xlsx", path=None, silent=False)` | Saves data to an Excel file.
|
|
152
|
-
| `clear_cache(silent=False)` | Completely clears the FinanceGY cache directory.
|
|
185
|
+
| Function | Description |
|
|
186
|
+
| ---------------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
187
|
+
| `to_dataframe(data)` | Converts FinanceGY list/dict results into a pandas DataFrame. |
|
|
188
|
+
| `save_to_csv(data, filename="output.csv", path=None, silent=False)` | Saves data to a CSV file. |
|
|
189
|
+
| `save_to_excel(data, filename="output.xlsx", path=None, silent=False)` | Saves data to an Excel file. |
|
|
190
|
+
| `clear_cache(silent=False)` | Completely clears the FinanceGY cache directory. |
|
|
153
191
|
|
|
154
192
|
---
|
|
155
193
|
|
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "financegy"
|
|
7
|
-
version = "3.
|
|
7
|
+
version = "3.1"
|
|
8
8
|
description = "Unofficial Python library for accessing GSE (Guyana Stock Exchange) financial data"
|
|
9
9
|
authors = [{ name = "Ezra Minty", email = "ezranminty@gmail.com" }]
|
|
10
10
|
dependencies = ["requests", "beautifulsoup4", "pandas", "openpyxl"]
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|