borsajs 0.1.0 → 0.1.1

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.
Files changed (4) hide show
  1. package/LICENSE +33 -0
  2. package/README.en.md +26 -12
  3. package/README.md +28 -10
  4. package/package.json +1 -1
package/LICENSE CHANGED
@@ -199,3 +199,36 @@
199
199
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
200
  See the License for the specific language governing permissions and
201
201
  limitations under the License.
202
+
203
+ ================================================================================
204
+ DATA SOURCES AND ATTRIBUTION
205
+ ================================================================================
206
+
207
+ This project is a TypeScript/JavaScript port of borsapy:
208
+ https://github.com/saidsurucu/borsapy
209
+
210
+ This library accesses publicly available data from the following sources:
211
+
212
+ - Paratic (https://www.paratic.com/) - Stock and index data
213
+ - doviz.com (https://www.doviz.com/) - Forex, gold, and commodity data
214
+ - BtcTurk (https://www.btcturk.com/) - Cryptocurrency data
215
+ - TEFAS (https://www.tefas.gov.tr/) - Investment fund data
216
+ - TCMB (https://www.tcmb.gov.tr/) - Inflation data
217
+ - KAP (https://www.kap.org.tr/) - Company information
218
+ - İş Yatırım (https://www.isyatirim.com.tr/) - Derivatives (VIOP) data
219
+
220
+ ================================================================================
221
+ IMPORTANT NOTICE FOR COMMERCIAL USE
222
+ ================================================================================
223
+
224
+ The data accessed through this library is provided by third-party sources
225
+ and is subject to their respective terms of service. This library is
226
+ provided for personal and educational use only.
227
+
228
+ FOR COMMERCIAL USE:
229
+ You must obtain explicit permission from the respective data source providers
230
+ before using their data for commercial purposes. The authors of this library
231
+ are not responsible for any unauthorized commercial use of data.
232
+
233
+ All trademarks, service marks, and company names are the property of their
234
+ respective owners.
package/README.en.md CHANGED
@@ -190,20 +190,34 @@ for (const [symbol, ticker] of tickers) {
190
190
 
191
191
  ## Data Sources
192
192
 
193
- | Module | Source | Description |
194
- |--------|--------|-------------|
195
- | Ticker | Paratic | Stock data |
196
- | Index | Paratic | BIST indices |
197
- | FX | doviz.com | Forex, gold, commodities |
198
- | Crypto | BtcTurk | Cryptocurrency data |
199
- | Fund | TEFAS | Investment fund data |
200
- | Inflation | TCMB | Inflation data |
201
- | VIOP | İş Yatırım | Futures and options |
193
+ This library accesses publicly available data from the following sources:
202
194
 
203
- ## Disclaimer
195
+ | Module | Source | Website | Description |
196
+ |--------|--------|---------|-------------|
197
+ | Ticker | Paratic | [paratic.com](https://www.paratic.com/) | Stock data |
198
+ | Index | Paratic | [paratic.com](https://www.paratic.com/) | BIST indices |
199
+ | FX | doviz.com | [doviz.com](https://www.doviz.com/) | Forex, gold, commodities |
200
+ | Crypto | BtcTurk | [btcturk.com](https://www.btcturk.com/) | Cryptocurrency data |
201
+ | Fund | TEFAS | [tefas.gov.tr](https://www.tefas.gov.tr/) | Investment fund data |
202
+ | Inflation | TCMB | [tcmb.gov.tr](https://www.tcmb.gov.tr/) | Inflation data |
203
+ | VIOP | İş Yatırım | [isyatirim.com.tr](https://www.isyatirim.com.tr/) | Futures and options |
204
+ | Companies | KAP | [kap.org.tr](https://www.kap.org.tr/) | Company information |
204
205
 
205
- Data accessed through this library belongs to their respective sources. This library is intended for personal use only and data should not be used for commercial purposes.
206
+ ## ⚠️ Important Notices
207
+
208
+ ### About Data Sources
209
+ Data accessed through this library belongs to the third-party sources listed above. The data is subject to the respective terms of service of each provider.
210
+
211
+ ### Commercial Use
212
+ **This library is intended for personal and educational use only.**
213
+
214
+ For commercial use:
215
+ - You must obtain explicit permission from the respective data source providers
216
+ - The authors of this library are not responsible for any unauthorized commercial use of data
217
+
218
+ ### Reference Project
219
+ This project is a TypeScript port of the [borsapy](https://github.com/saidsurucu/borsapy) Python library.
206
220
 
207
221
  ## License
208
222
 
209
- Apache 2.0
223
+ Apache 2.0 - See [LICENSE](LICENSE) file for details.
package/README.md CHANGED
@@ -42,16 +42,34 @@ const calculation = await inflation.calculate(100000, '2020-01', '2024-01');
42
42
 
43
43
  ## Veri Kaynakları
44
44
 
45
- | Modül | Kaynak | Açıklama |
46
- |-------|--------|----------|
47
- | Ticker | Paratic | Hisse verileri |
48
- | Index | Paratic | BIST endeksleri |
49
- | FX | doviz.com | Döviz kurları, altın, emtia |
50
- | Crypto | BtcTurk | Kripto para verileri |
51
- | Fund | TEFAS | Yatırım fonu verileri |
52
- | Inflation | TCMB | Enflasyon verileri |
53
- | VIOP | İş Yatırım | Vadeli işlem ve opsiyon |
45
+ Bu kütüphane aşağıdaki kamuya açık veri kaynaklarından yararlanmaktadır:
46
+
47
+ | Modül | Kaynak | Web Sitesi | Açıklama |
48
+ |-------|--------|------------|----------|
49
+ | Ticker | Paratic | [paratic.com](https://www.paratic.com/) | Hisse senedi verileri |
50
+ | Index | Paratic | [paratic.com](https://www.paratic.com/) | BIST endeksleri |
51
+ | FX | doviz.com | [doviz.com](https://www.doviz.com/) | Döviz kurları, altın, emtia |
52
+ | Crypto | BtcTurk | [btcturk.com](https://www.btcturk.com/) | Kripto para verileri |
53
+ | Fund | TEFAS | [tefas.gov.tr](https://www.tefas.gov.tr/) | Yatırım fonu verileri |
54
+ | Inflation | TCMB | [tcmb.gov.tr](https://www.tcmb.gov.tr/) | Enflasyon verileri |
55
+ | VIOP | İş Yatırım | [isyatirim.com.tr](https://www.isyatirim.com.tr/) | Vadeli işlem ve opsiyon |
56
+ | Companies | KAP | [kap.org.tr](https://www.kap.org.tr/) | Şirket bilgileri ve bildirimleri |
57
+
58
+ ## ⚠️ Önemli Uyarılar
59
+
60
+ ### Veri Kaynakları Hakkında
61
+ Bu kütüphane aracılığıyla erişilen veriler, yukarıda listelenen üçüncü taraf kaynaklara aittir. Veriler ilgili kaynakların kullanım koşullarına tabidir.
62
+
63
+ ### Ticari Kullanım
64
+ **Bu kütüphane yalnızca kişisel ve eğitim amaçlı kullanım için tasarlanmıştır.**
65
+
66
+ Ticari kullanım için:
67
+ - İlgili veri kaynağı sağlayıcılarından açık izin almanız gerekmektedir
68
+ - Bu kütüphanenin yazarları, verilerin izinsiz ticari kullanımından sorumlu değildir
69
+
70
+ ### Referans Proje
71
+ Bu proje, [borsapy](https://github.com/saidsurucu/borsapy) Python kütüphanesinden ilham alınarak TypeScript'e port edilmiştir.
54
72
 
55
73
  ## Lisans
56
74
 
57
- Apache 2.0
75
+ Apache 2.0 - Detaylar için [LICENSE](LICENSE) dosyasına bakınız.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "borsajs",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Turkish financial markets data library - yfinance-like API for BIST stocks, forex, crypto, and more",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",