Metadata-Version: 2.1
Name: tradingfeatures
Version: 0.6.0
Summary: A useful tool to download market history from popular exchanges.
Home-page: https://github.com/realiti4/tradingfeatures
Author: Onur Cetinkol
Author-email: realiti44@gmail.com
License: UNKNOWN
Description: # tradingfeatures
        A useful tool to download market history from popular exchanges.
        
        
        ## Installation
        
            pip install tradingfeatures
        
        or	
        
            pip install git+https://github.com/realiti4/tradingfeatures.git@master --upgrade
        
        ## Example
        - `.get()`: Returns most recent history amount you pass.
        - `.get_history()`: Downloads all avaliable history for that api.
        - `.update()`: Takes a csv file path and updates it.
        
        You can use `.get()`, `.get_history()` and `.update()` with all avaliable apis. Currently supported:
        
        * `bitfinex`
        * `bitstamp`
        * `binance`
          * `binance.funding`
        * `bitmex`
          * `bitmex.funding`
          * `bitmex.quote`
        
        Supported symbols: `btcusd`, `ethusd`, `ltcusd`. These are guaranteed to work with every module. You can stil use any symbol that an exchange supports. But same pair is different for each exchange of course. Using an unsupported symbold will give you a warning, but it should work just fine as long as you are using a correct symbol for that api.
        
        
        ### Get history with .get()
        
            import pandas as pd
            from tradingfeatures import bitfinex, bitstamp, binance, bitmex
        
            bitfinex = bitfinex()
        
            df = bitfinex.get(2000)
            
            df2 = bitfinex.get(2000, symbol='ethusd')   # Default is btcusd, you can pass others in symbol parameter
        
        Just pass how much data you want. It will return the amount in most recent 1h data. Currently only 1h data is supported. If history amount is above api limit, `.get()` will run `.get_history()` under the hood, so you don't need to worry about it. But if you want everything and don't want to guess how much data avaliable on each exchange, just run `.get_history()` and get everything.
        
        ### Download all available history with .get_history()
        The tool will download all avaliable history while respecting request per minute limits. Using it easy, and it takes couple of minutes for 1h data.
        
            import pandas as pd
            from tradingfeatures import bitfinex, bitstamp, binance, bitmex
        
            bitstamp = bitstamp()
            
            df = bitstamp.get_hist()
            df.to_csv('bitstamp_1h.csv') 
        
        ### Updating a csv file with .update()
        
            import pandas as pd
            from tradingfeatures import bitfinex, bitstamp, binance, bitmex
        
            bitstamp = bitstamp()
            
            bitstamp.update_csv('bitstamp.csv')    
        
        Update takes a path variable to csv file and updates it.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
