Modules-README.yml

# Modules
# vi: set filetype=yaml syntax=yaml noai ts=2 sw=2 ic:
# state: working | failing | obsolete | removed
---
- module: AEX.pm
  state: working
  added: TBD
  changed: 2022-10-18
  removed: ~
  urls:
    - https://live.euronext.com/en/search_instruments/
    - https://live.euronext.com/en/ajax/getDetailedQuote/
    - https://live.euronext.com/en/intraday_chart/getDetailedQuoteAjax/
  apikey: false
  notes: ~
  testfile: aex.t
  testcases:
    - AD
    - AMG
    - LVMH
    - XS0937858271
    - NL0000009165
#
- module: AIAHK.pm
  state: working
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: aiahk.t
  testcases:
    - ABD-AUS.EQ
    - AIG-EUSC.U
    - FID-JP.ADV
    - SCH-HKEQ
#
- module: ASEGR.pm
  state: failing
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: >-
    Broken and recommended for removal. All active securities are tested to be available
    from YahooJSON (and possibly other sources).
  testfile: asegr.t
  testcases:
#
- module: ASX.pm
  state: working
  added: TBD
  changed: 2020-10-12
  removed: ~
  urls:
  apikey: false
  notes: >-
    Most securities are available from YahooJSON (and possibly other sources).
  testfile: asx.t
  testcases:
    - WES
    - BOQ
    - XRO
    - IAG
    - TLS
    - NABHA
    - XAO
#
- module: AlphaVantage.pm
  state: working
  added:
  changed: 2019-12-01
  removed:
  urls:
    - https://www.alphavantage.co/query?function=GLOBAL_QUOTE&apikey=$ALPHAVANTAGE_API_KEY&symbol=
  apikey: true
  notes: |
    Module to acquire data from https://www.alphavantage.co/.
    Users must first request an API key and set the environment
    variable ALPHAVANTAGE_API_KEY.
  testfile: alphavantage.t
  testcases:
    - IBM
    - CSCO
    - SOLB.BR
    - SAP.DE
    - TD.TO
    - LSE.L
    - VFIAX
    - T
    - DIVO11.SA
    - OGZD.IL
    - TWTR
    - AAPL
    - ORCL
    - FB
    - CMCSA
    - INTC
    - NFLX
    - TSLA
    - NOK
    - BAC
    - GOOG
    - F
    - AXP
    - ERIC-B.STO
#
- module: BMONesbittBurns.pm
  state: failing
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: BSEIndia.pm
  state: working
  added: 2020-06-27
  changed:
  removed:
  urls:
    - https://www.bseindia.com/download/BhavCopy/Equity/EQ_ISINCODE_${DDMMYY}.zip
  methods:
    - india
    - bseindia
  apikey: false
  notes: |
    Module to fetch equity quotes from https://www.bseindia.com/
  testfile: bseindia.t
  testcases:
    - 500010
    - 532540
    - INE009A01021
    - INE062A01020
#
- module: BSERO.pm
  state: failing
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Bloomberg.pm
  state: working
  added: 
  changed: 2022-04-17
  removed: 
  urls: https://www.bloomberg.com/quote/
  apikey: false
  notes: 
  testfile: bloomberg.t
  testcases: 
    - MSFT:US
    - AMZN:US
    - AAPL:US
    - GOOGL:US
    - FB:US
#
- module: Bourso.pm
  state: working
  added:
  changed: 2023-05-22
  removed:
  urls: https://www.boursorama.com/cours/$stock
  apikey: false
  notes: The test file checks for specific values returned and may falsly report errors when the information correctly returned from the URL changes.
  testfile: bourso.t
  testcases:
    - MP-802941
    - 1rPAF
    - MSFT
    - FF11-SOLB
    - 2rPDE000CX0QLH6
    - 1rPFR0010371401
    - 1rPCAC
    - 1rTBX4
    - FR0010037341
#
- module: CSE.pm
  state: failing
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Cdnfundlibrary.pm
  state: failing
  added: TBD
  changed: 2019-12-01
  removed: ~
  urls:
    - https://www.fundlibrary.com/MutualFunds/GetFundSearchResults?cifscCategoryId=0&fundCompanyId=0&fundTypeId=0&isGradeA=true&isGradeB=true&isGradeC=true&isGradeD=true&isGradeE=true&sortBy=Default&page=0&searchText=
  apikey: false
  notes: ~
  testfile: cdnfundlibrary.t
  testcases:
    - NBC887
    - TDB3533
#
- module: Citywire.pm
  state: failing
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Cominvest.pm
  state: failing
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Currencies.pm
  state: working
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: CurrencyRates/AlphaVantage.pm
  state: working
  Added: TBD
  changed: 2022-11-23
  removed: ~
  urls: https://www.alphavantage.co/query?function=CURRENCY_EXCHANGE_RATE
  apikey: true
  notes: |
    Recently modified for Issue #229 in PR #230
    The commit/PR was reverted 2022-11-23 (PR #249), AlphaVantage changed
    the CURRENCY_EXCHANGE_RATE to no longer require a premium API Key.
  testfile: currency.t
  testcases:
    - GBP IQD
    - AUD AUD
#
- module: CurrencyRates/YahooJSON.pm
  state: working
  Added: 2023-04-09
  changed: 2023-05-26
  removed: ~
  urls: https://query2.finance.yahoo.com/v11/finance/quoteSummary/...?modules=price
  apikey: false
  notes: |
    URL is constructed by adding "$from$to%3DX" to Yahoo URL.
    Can be used for crypto by adding "$from-$to" to the URL.
  testfile: currency.t
  testcases:
    - USD EUR
    - GBP IDR
    - IDR CAD
    - AUD AUD
#
- module: DWS.pm
  state: working
  added: TBD
  changed: 2022-09-28
  removed: ~
  urls: https://www.deami.de/dps/ff/prices.aspx
  apikey: false
  notes: Test file checks that name returned in JSON matches hard coded value in dws.t
  testfile: dws.t
  testcases:
    - 848646
    - DE0008486465
    - LU0358627221
#
- module: Deka.pm
  state: working
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: deka.t
  testcases:
    - DE0008474511
    - LU0051755006
#
- module: Fondsweb.pm
  state: working
  added: TBD
  changed: 2022-11-21
  removed: ~
  urls: https://www.fondsweb.com/de/
  apikey: false
  notes: ~
  testfile: fondsweb.t
  testcases:
    - LU0804734787
    - DE0008491002
    - DE0008474503
    - DE0008491051
    - DE0009805507
#
- module: FTPortfolios.pm
  state: failing
  added: TBD
  changed: ~
  removed: 2021-01-03
  urls: https://www.ftportfolios.com/
  apikey: false
  notes: Commit 2f0f6bd removed module and testfile. Last commit with module is 75412c0.
  testfile: ftportfolios.t
  testcases:
#
- module: FTfunds.pm
  state: working
  added: 2014-03-02
  changed: 2023-04-09
  removed: ~
  urls:
    - https://markets.ft.com/data/funds/tearsheet/summary?s=
    - http://funds.ft.com/UnlistedTearsheet/Summary?s=
  apikey: false
  notes: 
    - Added date is an estimate. According to Git log it first appeared in commit fdd204b.
  testfile: ftfunds.t
  testcases:
    - GB0031834814
    - GB0030881337
    - GB0003865176
    - GB00B7W6PR65
#
- module: Fidelity.pm
  state: working
  added: TBD
  changed: 2020-03-21
  removed: ~
  urls:
    - https://fundresearch.fidelity.com/mutual-funds/fidelity-funds-daily-pricing-yields/download
  apikey: false
  notes: ~
  testfile: fidelity.t
  testcases:
    - FGRIX
    - FNMIX
    - FASGX
    - FEQTX
#
- module: FidelityFixed.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: FinanceCanada.pm
  state: Not Working
  added: Unknown
  changed: ~
  removed: 2020-10-10
  urls:
  apikey: false
  notes: Removed in commit b22963e664a6455ef83620cf05f875bf4a65ea3a.
  testfile: TBD
  testcases:
#
- module: Finanzpartner.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Fool.pm
  state: working
  added: 2001-05-08
  changed: 2019-06-21
  removed:
  urls:
    - http://caps.fool.com/Ticker/{$symbol}.aspx
  apikey: false
  notes: ~
  testfile: fool.t
  testcases:
    - MSFT
    - AMZN
    - AAPL
    - GOOGL
    - GOOG
    - FB
    - CSCO
    - INTC
    - CMCSA
    - PEP
    - BRK-A
    - SEB
    - NVR
    - BKNG
#
- module: Fundata.pm
  state: TBD
  added: TBD
  change: TBD
  removed:
  urls:
    - http://idata.fundata.com/MutualFunds/FundSnapshot.aspx?IID={$symbol}
  apikey: false
  notes: ~
  testfile: fundata.t
  testcases:
    - 301871
    - 234263
#
- module: GoldMoney.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: HEX.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: HU.pm
  state: failing
  added: TBD
  changed: 2019-06-22
  removed: ~
  urls:
    - http://www.bamosz.hu/alapoldal?isin=
    - http://www.bet.hu/topmenu/kereskedesi_adatok/product_search?isinquery=
  methods:
    - bamosz
    - bse
    - hu
  apikey: false
  notes: |
    The URL http://www.bamosz.hu/alapoldal?isin= is for Mutual Funds.
    The URL http://www.bet.hu/... is for Equities.
    The equity URL is no longer working.
    May need to try changing the equity URL to
    https://www.bet.hu/oldalak/ceg_adatlap/$security/<symbol>
    Changed failing Fund test case 2019-06-22.
  testfile: hu.t
  testcases:
    - OTP
    - HU0000705280
    - HU0000702709
    - ZOL
#
- module: IEXCloud.pm
  state: working
  added: 2019-06-16
  changed: 2019-06-16
  removed:
  urls:
    - https://cloud.iexapis.com/v1/stock/{$symbol}/quote?token={$token}
  apikey: true
  notes: |
    Module retrieves data from IEX Trading (https://iextrading.com/).
    For API Key - https://iextrading.com/developer/ and set the
    environment variable IEXCLOUD_API_KEY.
  testfile: iexcloud.t
  testcases:
    - MSFT
    - AMZN
    - AAPL
    - GOOGL
    - GOOG
    - FB
    - CSCO
    - INTC
    - CMCSA
    - PEP
    - BRK.A
    - SEB
    - NVR
    - BKNG
    - IBKR
#
- module: IndiaMutual.pm
  state: working
  added: TBD
  changed: ~
  removed: ~
  urls: https://www.amfiindia.com/spages/NAVAll.txt
  apikey: false
  notes: ~
  testfile: indiamutual.t
  testcases:
    - 102676
    - 103131
    - 101599
    - INF194K01W88
    - INF090I01FN7
    - INF082J01127
#
- module: LeRevenu.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: ManInvestments.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: MorningstarCH.pm
  state: working
  added: 2019-03-02
  changed: 2022-05-10
  removed:
  urls:
    - https://www.morningstar.ch/ch/funds/SecuritySearchResults.aspx?search=
    - https://www.morningstar.ch/ch/funds/snapshot/snapshot.aspx?id=
  apikey: false
  notes: Module to acquire data from https://www.morningstar.ch/.
  testfile: morningstarCH.t
  testcases:
    - CH0012056260
    - CH0014933193
    - CH0002788567
    - BOGUS
#
- module: MorningstarJP.pm
  state: working
  added: TBD
  changed: 2023-04-08
  removed: ~
  urls: https://www.wealthadvisor.co.jp/FundData/DownloadStdYmd.do?fnc=
  apikey: false
  notes: ~
  testfile: morningstarJP.t
  testcases:
    - 2009100101
    - 2002013108
#
- module: MorningstarUK.pm
  state: working
  added: TBD
  changed: 2023-05-20
  removed: ~
  urls:
  apikey: false
  notes: Renamed from MStaruk.pm 2023-05-20
  testfile: morningstarUK.t
  testcases:
#
- module: NSEIndia.pm
  state: working
  added: 2020-06-27
  changed:
  removed:
  urls:
    - https://archives.nseindia.com/content/historical/EQUITIES/${YYYY}/${MMM}/cm${DDMMMYYYY}bhav.csv.zip
  methods:
    - india
    - nseindia
  apikey: false
  notes: |
    Module to fetch equity quotes from https://www.nseindia.com/
  testfile: nseindia.t
  testcases:
    - HDFC
    - TCS
    - INE009A01021
    - INE062A01020
#
- module: NZX.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Oslobors.pm
  state: working
  added: 2020-02-06
  changed: 2020-02-06
  removed:
  urls:
    - https://www.oslobors.no/ob/servlets/components?type=table&source=feed.omff.FUNDS&view=REALTIME&columns=ITEM%2C+PRICECHANGEPCT%2C+PRICE%2C+DATE%2C+QUOTATIONCURRENCY&filter=ITEM_SECTOR%3D%3Ds
  apikey: false
  notes: |
    Module to fetch mutual fund data from oslobors.no
  testfile: oslobors.t
  testcases:
    - OD-HORIA.OSE
    - DK-EUROP.OSE
    - ST-VEKST.OSE
#
- module: Platinum.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: SEB.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Sinvestor.pm
  state: working
  added: 2022-10-19
  changed: 2022-10-27
  removed: ~
  urls: https://web.s-investor.de/app/aktien.htm?INST_ID=0000057
  apikey: false
  notes: shares and funds from various sources
  testfile: sinvestor.t
  testcases:
    - DE0008404005
    - NL0011540547
    - FR0000120628
    - DE0009809566
    - DE0008491002
#
- module: SIXfunds.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: SIXshares.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: StockHouseCanada.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: TMX.pm
  state: working
  added: TBD
  changed: 2022-11-23
  removed: ~
  urls: https://app-money.tmx.com/graphql
  apikey: false
  notes: ~
  testfile: tmx.t
  testcases:
    - STN
    - BCE
    - BMO
    - HBI:US
#
- module: TNetuk.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Tradegate.pm
  state: working
  added: 2022-10-19
  changed: 2022-10-27
  removed: ~
  urls: https://web.s-investor.de/app/aktien.htm?INST_ID=0000057
  apikey: false
  notes: share quotes from the Tradegate platform
  testfile: tradegate.t
  testcases:
    - DE0008404005
    - NL0011540547
    - FR0000120628
    - XS0937858271
    - NL0000009165
#
- module: Tradeville.pm
  state: failing
  added: ~
  changed: ~
  removed: ~
  urls: https://tradeville.ro/actiuni/actiuni-
  apikey: false
  notes: |
    Issue #269 indicates the URL no longer works.
    Suggested https://bvb.ro/FinancialInstruments/Details/FinancialInstrumentsDetails.aspx?s=
    If we change to the bvb.ro URL, should the module be renamed to BVB.pm?
    We probably should manually validate the test cases are still valid.
  testfile: tradeville.t
  testcases:
    - TLV
    - BRD
    - SNP
#
- module: TSP.pm
  state: working
  added: 2005-03-02
  changed: 2022-07-29
  removed:
  urls:
    - https://www.tsp.gov/fund-performance/
  apikey: false
  notes:
  testfile: tsp.t
  testcases:
    - C
    - F
    - G
    - I
    - S
    - L2030
    - L2035
    - L2040
    - L2045
    - L2050
    - L2055
    - L2060
    - L2065
    - LINCOME
#
- module: Tdefunds.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Tdwaterhouse.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: Tiaacref.pm
  state: working
  added: 2000-05-14
  changed: 2020-10-11
  removed: ~
  urls:
    - https://www.tiaa.org/public/investment-performance 
  apikey: false
  notes: ~
  testfile: tiaacref.t
  testcases:
    - QCBMIX
    - TEMLX
    - TLFIX
    - TSBPX
    - W156#
    - W323#
    - W464#
    - W719#
#
- module: TesouroDireto.pm
  state: working
  added: 2022-02-06
  changed: ~
  removed: ~
  urls:
    - https://www.tesourodireto.com.br/titulos/precos-e-taxas.htm
  apikey: false
  notes: ~
  testfile: tesouro_direto.t
  testcases:
    - Tesouro Prefixado 2026
    - Tesouro IPCA+ 2045
#
- module: TreasuryDirect.pm
  state: working
  added: 2022-07-20
  changed:
  removed:
  urls:
    - https://www.treasurydirect.gov/GA-FI/FedInvest/todaySecurityPriceDate.htm
  apikey: false
  notes: Retrieve Treasury bond quotes by CUSIP from treasurydirect.gov
  testfile: treasurydirect.t
  testcases:
    - 912810QT8
    - 912810QY7
#
- module: Troweprice.pm
  state: working
  added: TBD
  changed: 2020-10-11
  removed: ~
  urls: https://www3.troweprice.com/fb2/ppfweb/downloadPrices.do
  apikey: false
  notes: data available elsewhere -- marked for deprecation
  testfile: troweprice.t
  testcases:
    - PRFDX
    - PRIDX
    - TEUIX
    - RPGEX
    - GTFBX
#
- module: Trustnet.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: TwelveData.pm
  state: working
  added: 2023-05-26
  changed:
  removed:
  urls:
    - https://api.twelvedata.com/quote?symbol={$symbol}&apikey={$token}
  apikey: true
  notes: |
    API Required.  Register at https://twelvedata.com.
  testfile: twelvedata.t
  testcases:
    - MSFT
    - AMZN
    - AAPL
    - GOOGL
    - META
    - BRK.A
#
- module: USFedBonds.pm
  state: failing
  added: ~
  changed: ~
  removed: 2022-07-21
  urls: https://www.treasurydirect.gov/indiv/tools/tools_savingsbondvalues_historical.htm
  apikey: false
  notes: URL returns an HTTP 404 status code. Could not find a viable replacement URL.
  testfile: usfedbonds.t
  testcases:
    - E197001.200606
    - E194112.200610
    - E194105.200610
    - S196712.202006
#
- module: Union.pm
  state: working
  added: TBD
  changed: 2022-07-18
  removed: ~
  urls: https://legacy-apps.union-investment.de/handle?generate=true&action=doDownloadSearch&start_time=...
  apikey: false
  notes: symbol has changed from WKN to ISIN
  testfile: union.t
  testcases:
    - DE0008491002
#
- module: UserAgent.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: VWD.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: XETRA.pm
  state: working
  added: ~
  changed: 2022-10-27
  removed: ~
  urls: https://web.s-investor.de/app/aktien.htm?INST_ID=0000057
  apikey: false
  notes: share quotes from the XETRA platform
  testfile: xetra.t
  testcases:
    - DE0008404005
    - NL0011540547
    - FR0000120628
    - XS0937858271
    - NL0000009165
#
- module: YahooJSON.pm
  state: working
  added:
  changed: 2023-05-25
  removed:
  urls:
    - https://query2.finance.yahoo.com/v11/finance/quoteSummary/...?modules=price,summaryDetail,defaultKeyStatistics
  apikey: false
  notes: |
    Module to get data from Yahoo's API
    See issue https://github.com/finance-quote/finance-quote/issues/264
    Dependability of Yahoo REST API has been
    spotty.
  testfile: yahoojson.t
  testcases:
    - SUZLON.BO
    - ANDHRABANK.BO
    - RECLTD.NS
    - AMZN
    - SOLB.BR
    - ^DJI
    - BEL20.BR
    - INGDIRECTFNE.BC
    - AENA.MC
    - CFR.JO
#
- module: YahooYQL.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#
- module: ZA.pm
  state: working
  added: 
  changed: 2022-05-10
  removed: ~
  urls: https://www.sharenet.co.za/jse/$symbol
  apikey: false
  notes: 
    - Module to acquire data from https://www.sharenet.co.za, PR #208
  testfile: za.t
  testcases:
    - AGL
    - AMS
#
- module: ZA_UnitTrusts.pm
  state: TBD
  added: TBD
  changed: ~
  removed: ~
  urls:
  apikey: false
  notes: ~
  testfile: TBD
  testcases:
#