ccxt-ir 4.3.46.0.1__py2.py3-none-any.whl

ccxt/okexchange.py

@@ -0,0 +1,349 @@
+# -*- coding: utf-8 -*-
+
+# PLEASE DO NOT EDIT THIS FILE, IT IS GENERATED AND WILL BE OVERWRITTEN:
+# https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md#how-to-contribute-code
+
+from ccxt.base.exchange import Exchange
+from ccxt.abstract.okexchange import ImplicitAPI
+from ccxt.base.types import Int, Market, OrderBook, Strings, Ticker, Tickers
+from typing import List
+
+
+class okexchange(Exchange, ImplicitAPI):
+
+    def describe(self):
+        return self.deep_extend(super(okexchange, self).describe(), {
+            'id': 'okexchange',
+            'name': 'OK-EX',
+            'country': ['IR'],
+            'rateLimit': 1000,
+            'version': '1',
+            'certified': False,
+            'pro': False,
+            'has': {
+                'CORS': None,
+                'spot': True,
+                'margin': False,
+                'swap': False,
+                'future': False,
+                'option': False,
+                'addMargin': False,
+                'cancelAllOrders': False,
+                'cancelOrder': False,
+                'cancelOrders': False,
+                'createDepositAddress': False,
+                'createOrder': False,
+                'createStopLimitOrder': False,
+                'createStopMarketOrder': False,
+                'createStopOrder': False,
+                'editOrder': False,
+                'fetchBalance': False,
+                'fetchBorrowInterest': False,
+                'fetchBorrowRateHistories': False,
+                'fetchBorrowRateHistory': False,
+                'fetchClosedOrders': False,
+                'fetchCrossBorrowRate': False,
+                'fetchCrossBorrowRates': False,
+                'fetchCurrencies': False,
+                'fetchDepositAddress': False,
+                'fetchDeposits': False,
+                'fetchFundingHistory': False,
+                'fetchFundingRate': False,
+                'fetchFundingRateHistory': False,
+                'fetchFundingRates': False,
+                'fetchIndexOHLCV': False,
+                'fetchIsolatedBorrowRate': False,
+                'fetchIsolatedBorrowRates': False,
+                'fetchLedger': False,
+                'fetchLedgerEntry': False,
+                'fetchLeverageTiers': False,
+                'fetchMarkets': True,
+                'fetchMarkOHLCV': False,
+                'fetchMyTrades': False,
+                'fetchOHLCV': True,
+                'fetchOpenInterestHistory': False,
+                'fetchOpenOrders': False,
+                'fetchOrder': False,
+                'fetchOrderBook': True,
+                'fetchOrders': False,
+                'fetchOrderTrades': 'emulated',
+                'fetchPositions': False,
+                'fetchPremiumIndexOHLCV': False,
+                'fetchTicker': True,
+                'fetchTickers': True,
+                'fetchTime': False,
+                'fetchTrades': False,
+                'fetchTradingFee': False,
+                'fetchTradingFees': False,
+                'fetchWithdrawals': False,
+                'setLeverage': False,
+                'setMarginMode': False,
+                'transfer': False,
+                'withdraw': False,
+            },
+            'comment': 'This comment is optional',
+            'urls': {
+                'logo': 'https://cdn.arz.digital/cr-odin/img/exchanges/okexchange/64x64.png',
+                'api': {
+                    'public': 'https://api.ok-ex.io',
+                    'ohlcv': 'https://azapi.ok-ex.io',
+                },
+                'www': 'https://ok-ex.io/',
+                'doc': [
+                    'https://docs.ok-ex.io',
+                ],
+            },
+            'timeframes': {
+                '1m': '1m',
+                '5m': '5m',
+                '15m': '15m',
+                '30m': '30m',
+                '1h': '1h',
+                '2h': '2h',
+                '4h': '4h',
+                '6h': '6h',
+                '12h': '12h',
+                '1d': '1d',
+                '3d': '3d',
+                '1w': '1w',
+            },
+            'api': {
+                'public': {
+                    'get': {
+                        'oapi/v1/market/tickers': 1,
+                        'oapi/v1/otc/tickers': 1,
+                        'sno/oapi/market/candle': 1,
+                        'oapi/v1/market/orderbook': 1,
+                    },
+                },
+            },
+            'fees': {
+                'trading': {
+                    'tierBased': False,
+                    'percentage': True,
+                    'maker': self.parse_number('0.001'),
+                    'taker': self.parse_number('0.001'),
+                },
+            },
+        })
+
+    def fetch_markets(self, symbols: Strings = None, params={}) -> List[Market]:
+        """
+        retrieves data on all markets for okexchange
+        :see: https://docs.ok-ex.io/#available-coin
+        :param dict [params]: extra parameters specific to the exchange API endpoint
+        :returns dict[]: an array of objects representing market data
+        """
+        response = self.publicGetOapiV1MarketTickers(params)
+        markets = self.safe_value(response, 'tickers')
+        result = []
+        for i in range(0, len(markets)):
+            market = self.parse_market(markets[i])
+            result.append(market)
+        return result
+
+    def parse_market(self, market) -> Market:
+        id = self.safe_string(market, 'symbol')
+        symbol = self.safe_string(market, 'symbol')
+        baseId, quoteId = symbol.split('-')
+        base = self.safe_currency_code(baseId)
+        quote = self.safe_currency_code(quoteId)
+        baseId = baseId.lower()
+        quoteId = quoteId.lower()
+        return {
+            'id': id,
+            'symbol': base + '/' + quote,
+            'base': base,
+            'quote': quote,
+            'settle': None,
+            'baseId': baseId,
+            'quoteId': quoteId,
+            'settleId': None,
+            'type': 'spot',
+            'spot': True,
+            'margin': False,
+            'swap': False,
+            'future': False,
+            'option': False,
+            'active': True,
+            'contract': False,
+            'linear': None,
+            'inverse': None,
+            'contractSize': None,
+            'expiry': None,
+            'expiryDatetime': None,
+            'strike': None,
+            'optionType': None,
+            'precision': {
+                'amount': None,
+                'price': None,
+            },
+            'limits': {
+                'leverage': {
+                    'min': None,
+                    'max': None,
+                },
+                'amount': {
+                    'min': None,
+                    'max': None,
+                },
+                'price': {
+                    'min': None,
+                    'max': None,
+                },
+                'cost': {
+                    'min': None,
+                    'max': None,
+                },
+            },
+            'created': None,
+            'info': market,
+        }
+
+    def fetch_tickers(self, symbols: Strings = None, params={}) -> Tickers:
+        """
+        fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
+        :see: https://docs.ok-ex.io/#available-coin
+        :param str[]|None symbols: unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
+        :param dict [params]: extra parameters specific to the exchange API endpoint
+        :returns dict: a dictionary of `ticker structures <https://docs.ccxt.com/#/?id=ticker-structure>`
+        """
+        self.load_markets()
+        if symbols is not None:
+            symbols = self.market_symbols(symbols)
+        response = self.publicGetOapiV1MarketTickers(params)
+        markets = self.safe_value(response, 'tickers')
+        result = {}
+        for index in range(0, len(markets)):
+            ticker = self.parse_ticker(markets[index])
+            symbol = ticker['symbol']
+            result[symbol] = ticker
+        return self.filter_by_array_tickers(result, 'symbol', symbols)
+
+    def fetch_ticker(self, symbol: str, params={}) -> Ticker:
+        """
+        fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+        :see: https://docs.ok-ex.io/#available-coin
+        :param str symbol: unified symbol of the market to fetch the ticker for
+        :param dict [params]: extra parameters specific to the exchange API endpoint
+        :returns dict: a `ticker structure <https://docs.ccxt.com/#/?id=ticker-structure>`
+        """
+        ticker = self.fetch_tickers([symbol])
+        return ticker[symbol]
+
+    def parse_ticker(self, ticker, market: Market = None) -> Ticker:
+        #
+        #     {
+        #      symbol: "USDT-IRT",
+        #      last: "61338.0",
+        #      best_ask: "61338.0",
+        #      best_bid: "61338.0",
+        #      open_24h: "61419",
+        #      high_24h: 61739,
+        #      low_24h: 60942,
+        #      vol_24h_pair: 11017655160,
+        #      vol_24h: 17968,
+        #      ts: 1715074621
+        #     }
+        #
+        marketType = 'spot'
+        marketId = self.safe_string(ticker, 'symbol')
+        symbol = self.safe_symbol(marketId, market, None, marketType)
+        high = self.safe_string(ticker, 'high_24h')
+        low = self.safe_string(ticker, 'low_24h')
+        bid = self.safe_string(ticker, 'best_bid')
+        ask = self.safe_string(ticker, 'best_ask')
+        open = self.safe_string(ticker, 'open_24h')
+        last = self.safe_string(ticker, 'last')
+        quoteVolume = None
+        baseVolume = None
+        if symbol != 'USDT-IRT':
+            quoteVolume = self.safe_string(ticker, 'vol_24h_pair')
+            baseVolume = self.safe_string(ticker, 'vol_24h')
+        else:
+            ticker['ts'] = ticker['ts'] * 1000
+            high = low
+        timestamp = self.safe_integer(ticker, 'ts')
+        return self.safe_ticker({
+            'symbol': symbol.replace('-', '/'),
+            'timestamp': timestamp,
+            'datetime': None,
+            'high': high,
+            'low': low,
+            'bid': self.safe_string(bid, 0),
+            'bidVolume': None,
+            'ask': self.safe_string(ask, 0),
+            'askVolume': None,
+            'vwap': None,
+            'open': open,
+            'close': last,
+            'last': last,
+            'previousClose': None,
+            'change': None,
+            'percentage': None,
+            'average': None,
+            'baseVolume': baseVolume,
+            'quoteVolume': quoteVolume,
+            'info': ticker,
+        }, market)
+
+    def fetch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
+        """
+        fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+        :see: https://docs.ok-ex.io/#trade
+        :param str symbol: unified symbol of the market to fetch OHLCV data for
+        :param str timeframe: the length of time each candle represents
+        :param int [since]: timestamp in ms of the earliest candle to fetch
+        :param int [limit]: the maximum amount of candles to fetch
+        :param dict [params]: extra parameters specific to the exchange API endpoint
+        :returns int[][]: A list of candles ordered, open, high, low, close, volume
+        """
+        self.load_markets()
+        market = self.market(symbol)
+        endTime = Date.now()
+        request = {
+            'symbol': symbol.replace('/', ''),
+            'startTime': endTime - 24 * 60 * 60 * 1000,
+            'endTime': endTime,
+            'interval': '1m',
+            'limit': 500,
+            'prov': 0,
+        }
+        if since is not None:
+            request['startTime'] = since
+        if limit is not None:
+            request['limit'] = limit
+        if timeframe is not None:
+            request['interval'] = timeframe
+        response = self.publicGetSnoOapiMarketCandle(request)
+        ohlcvs = self.safe_list(response, 'data', [])
+        return self.parse_ohlcvs(ohlcvs, market, timeframe, since, limit)
+
+    def fetch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
+        """
+        fetches information on open orders with bid(buy) and ask(sell) prices, volumes and other data for multiple markets
+        :see: https://docs.ok-ex.io/#orderbooks
+        :param str[]|None symbols: list of unified market symbols, all symbols fetched if None, default is None
+        :param int [limit]: max number of entries per orderbook to return, default is None
+        :param dict [params]: extra parameters specific to the exchange API endpoint
+        :returns dict: a dictionary of `order book structures <https://docs.ccxt.com/#/?id=order-book-structure>` indexed by market symbol
+        """
+        self.load_markets()
+        market = self.market(symbol)
+        request = {
+            'symbol': market['symbol'].replace('/', ''),
+        }
+        response = self.publicGetOapiV1MarketOrderbook(request)
+        orderBook = self.safe_dict(response, 'books', {})
+        timestamp = Date.now()
+        return self.parse_order_book(orderBook, symbol, timestamp)
+
+    def sign(self, path, api='public', method='GET', params={}, headers=None, body=None):
+        query = self.omit(params, self.extract_params(path))
+        url = self.urls['api']['public'] + '/' + path
+        if path == 'sno/oapi/market/candle':
+            url = self.urls['api']['ohlcv'] + '/' + path + '?' + self.urlencode(query)
+        if path == 'oapi/v1/market/orderbook':
+            url = url + '?' + self.urlencode(query)
+        headers = {'Content-Type': 'application/json'}
+        return {'url': url, 'method': method, 'body': body, 'headers': headers}