invest_tinkoff 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fec23d110b2a83bb181d43d24178a1a92f3aee95136db9f74f475e6bc20d5069
+  data.tar.gz: 2f23f8028c68369c29c1ef296cbcccbd54cbef310271b8ff8a43111f6da716cf
+SHA512:
+  metadata.gz: 0c5158d70d7a6dbffecd3e2d877f85f1369922b7ee361d71c0905fae5ff4cb7ecd96bd86bbc81df576f4d7e77166063deb8b377de4f996934ee520e420e38fe0
+  data.tar.gz: cdfbeb57431f842ba3dd417c557675c5351a6f1ae95993c5651dc6ec87833bc8ad4ec7582105dd47e44c39400599c12eaa587272574143b79c04e3ccbcbc2444

data/lib/invest_tinkoff/client_base.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class InvestTinkoff::ClientBase
+  include HTTParty
+
+  def initialize token:, broker_account_id:, logger: nil
+    @token = token
+    @broker_account_id = broker_account_id
+    @logger = logger
+  end
+
+  private
+
+  def get_api_request path, query = nil
+    response = self.class.get(
+      path,
+      query: query || base_query,
+      logger: @logger,
+      headers: headers
+    )
+    parse_response response
+  end
+
+  def post_api_request path, body: {}, query: {}
+    response = self.class.post(
+      path,
+      query: base_query.merge(query),
+      body: body.to_json,
+      logger: @logger,
+      headers: headers
+    )
+    parse_response response
+  end
+
+  def headers
+    {
+      'Authorization' => "Bearer #{@token}",
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  def base_query
+    return {} if @broker_account_id.nil?
+
+    { brokerAccountId: @broker_account_id }
+  end
+
+  def parse_response response
+    response.parsed_response
+  end
+end

data/lib/invest_tinkoff/v1/client.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+class InvestTinkoff::V1::Client < InvestTinkoff::ClientBase
+  base_uri 'https://api-invest.tinkoff.ru/openapi/'
+
+  TIME_FORMAT = '%FT%T%:z'
+  CANDLES_INTERVALS = %w[1min 2min 3min 5min 10min 15min 30min hour day week month]
+
+  attr_accessor :broker_account_id
+
+  # token - рабочий API token
+  # broker_account_id (опционально) - идентификатор счета
+  # logger (опиционально) - например: Rails.logger
+  def initialize token:, broker_account_id: nil, logger: nil
+    super(
+      token: token,
+      broker_account_id: broker_account_id,
+      logger: logger
+    )
+  end
+
+  # ==========================================
+  # Операции с заявками
+  # ==========================================
+
+  # Получение списка активных заявок
+  def orders
+    get_api_request '/orders'
+  end
+
+  # Создание лимитной заявки
+  # Пример figi: 'BBG000B9XRY4'
+  # Пример operation: :buy, :sell
+  def orders_limit_order figi:, operation:, lots:, price:
+    post_api_request(
+      '/orders/limit-order',
+      body: {
+        lots: lots,
+        operation: operation.to_s.capitalize,
+        price: price
+      },
+      query: { figi: figi }
+    )
+  end
+
+  # Создание рыночной заявки
+  # Пример figi: 'BBG000B9XRY4'
+  # Пример operation: :buy, :sell
+  def orders_market_order figi:, operation:, lots:
+    post_api_request(
+      '/orders/market-order',
+      body: {
+        lots: lots,
+        operation: operation.to_s.capitalize
+      },
+      query: { figi: figi }
+    )
+  end
+
+  # Отмена заявки
+  def orders_cancel id
+    post_api_request '/orders/cancel', query: { orderId: id }
+  end
+
+  # ==========================================
+  # Операции с портфелем пользователя
+  # ==========================================
+
+  # Получение портфеля клиента
+  def portfolio
+    get_api_request '/portfolio'
+  end
+
+  # Получение валютных активов клиента
+  def portfolio_currencies
+    get_api_request '/portfolio/currencies'
+  end
+
+  # ==========================================
+  # Получении информации по бумагам
+  # ==========================================
+
+  # Получение списка акций
+  def market_stocks
+    get_api_request '/market/stocks'
+  end
+
+  # Получение списка облигаций
+  def market_bonds
+    get_api_request '/market/bonds'
+  end
+
+  # Получение списка ETF
+  def market_etfs
+    get_api_request '/market/etfs'
+  end
+
+  # Получение списка валютных пар
+  def market_currencies
+    get_api_request '/market/currencies'
+  end
+
+  # Получение стакана по FIGI
+  # Пример figi: 'BBG000B9XRY4'
+  def market_orderbook figi:, depth: 20
+    get_api_request '/market/orderbook', { figi: figi, depth: depth }
+  end
+
+  # Получение исторических свечей по FIGI
+  # Пример figi: 'BBG000B9XRY4'
+  # Пример from: Time.zone.now.beginning_of_week
+  # Пример to: Time.zone.now
+  # Пример interval: :1min, :2min, :3min, :5min, :10min, :15min, :30min, :hour, :day, :week, :month
+  def market_candles figi:, from:, to:, interval:
+    raise ArgumentError, 'interval' unless CANDLES_INTERVALS.include? interval.to_s
+
+    get_api_request(
+      '/market/candles',
+      {
+        figi: figi,
+        from: from.strftime(TIME_FORMAT),
+        to: to.strftime(TIME_FORMAT),
+        interval: interval
+      }
+    )
+  end
+
+  # Получение инструмента по FIGI
+  # Пример figi: 'BBG000B9XRY4'
+  def market_search_by_figi figi
+    get_api_request '/market/search/by-figi', { figi: figi }
+  end
+
+  # Получение инструмента по тикеру
+  # Пример tiker: 'AAPL'
+  def market_search_by_ticker ticker
+    get_api_request '/market/search/by-ticker', { ticker: ticker }
+  end
+
+  # ==========================================
+  # Получении информации по операциям
+  # ==========================================
+
+  # Получение списка операций
+  # Пример from: Time.zone.now.beginning_of_week
+  # Пример to: Time.zone.now
+  # Пример figi (опиционально): 'BBG000B9XRY4'
+  def operations from:, to:, figi: nil
+    query = {
+      from: from.strftime(TIME_FORMAT),
+      to: to.strftime(TIME_FORMAT)
+    }
+    query.merge! figi: figi if figi.present?
+    get_api_request '/operations', query
+  end
+
+  # ==========================================
+  # Получении информации по брокерским счетам
+  # ==========================================
+
+  # Получение брокерских счетов клиента
+  def user_accounts
+    get_api_request '/user/accounts'
+  end
+
+  private
+
+  def parse_response response
+    InvestTinkoff::V1::Response.create response
+  end
+end

data/lib/invest_tinkoff/v1/response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+InvestTinkoff::V1::Response = Struct.new(
+  :tracking_id,
+  :status,
+  :payload,
+  :http_code
+)
+
+class InvestTinkoff::V1::Response
+  def self.create response
+    attributes = response.parsed_response || {}
+    new(
+      attributes['trackingId'],
+      attributes['status'],
+      attributes['payload'],
+      response.code
+    )
+  end
+
+  def success?
+    status == 'Ok'
+  end
+end

data/lib/invest_tinkoff/v1/sandbox_client.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class InvestTinkoff::V1::SandboxClient < InvestTinkoff::V1::Client
+  base_uri 'https://api-invest.tinkoff.ru/openapi/sandbox/'
+
+  attr_accessor :broker_account_id
+
+  # token - sandbox API token
+  # broker_account_id (опционально) - идентификатор счета
+  # logger (опиционально) - например: Rails.logger
+  def initialize token:, broker_account_id: nil, logger: nil
+    super(
+      token: token,
+      broker_account_id: broker_account_id,
+      logger: logger
+    )
+    @is_sandbox_created = false
+  end
+
+  # ==========================================
+  # Операции в sandbox
+  # ==========================================
+
+  # Создание счета и выставление баланса по валютным позициям
+  def register
+    return if @is_sandbox_created
+
+    res = post_api_request '/sandbox/register'
+    @is_sandbox_created = true
+    res
+  end
+
+  # Выставление баланса по валютным позициям
+  # Пример currency: :RUB, :USD, :EUR и т.д.
+  def currencies_balance currency:, balance:
+    register
+    body = { currency: currency, balance: balance }
+    post_api_request '/sandbox/currencies/balance', body: body
+  end
+
+  # Выставление баланса по инструментным позициям
+  # Пример figi: 'BBG000B9XRY4'
+  def position_balance figi:, balance:
+    register
+    body = { figi: figi, balance: balance }
+    post_api_request '/sandbox/positions/balance', body: body
+  end
+
+  # Удаление всех позиций клиента
+  def clear
+    register
+    post_api_request '/sandbox/clear'
+  end
+
+  # Удаление счета клиента
+  def remove
+    register
+    post_api_request '/sandbox/remove'
+  end
+end

data/lib/invest_tinkoff/version.rb

@@ -0,0 +1,3 @@
+module InvestTinkoff
+  VERSION = '0.9.0'
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: invest_tinkoff
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Alexander Kalinichev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: Tinkoff Invest Ruby Rest API Gem
+email: alexander.kalinichev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/invest_tinkoff/client_base.rb
+- lib/invest_tinkoff/v1/client.rb
+- lib/invest_tinkoff/v1/response.rb
+- lib/invest_tinkoff/v1/sandbox_client.rb
+- lib/invest_tinkoff/version.rb
+homepage: https://github.com/blackchestnut/invest_tinkoff
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: invest_tinkoff
+test_files: []