degiro_client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da9cf0fe579f0f1c213a32b17c2901db5381d1d0b8b4098eea76a5df983f8cef
+  data.tar.gz: e35647671e6e281746b231a0d0c988b32daa46c22375451a72db36ec1b97d11d
+SHA512:
+  metadata.gz: a69fc835f4f1cbb58cdb361a8edfca33eaada0c8db553f6b0a8fb9ff83550451ca5c877d2ee52361ce55bcc3f07eab19b4d8c3819e8848c04a3e97075d9a5c97
+  data.tar.gz: decada6030e3f01130769a877266998708b2dbf8452f6c996e7535ce16a72d9b21269242ccd8a6a45e13d3a461a452d88b511ad2516d8b671369cb0d153bbc79

data/lib/degiro/client.rb

@@ -0,0 +1,36 @@
+require 'forwardable'
+
+require_relative 'connection.rb'
+require_relative 'create_order.rb'
+require_relative 'find_product_by_id.rb'
+require_relative 'find_products.rb'
+require_relative 'get_cash_funds.rb'
+require_relative 'get_orders.rb'
+require_relative 'get_portfolio.rb'
+require_relative 'get_transactions.rb'
+
+module DeGiro
+  class Client
+    extend Forwardable
+
+    def_delegators :@create_order,       :create_buy_order, :create_sell_order
+    def_delegators :@find_product_by_id, :find_product_by_id
+    def_delegators :@find_products,      :find_products
+    def_delegators :@get_cash_funds,     :get_cash_funds
+    def_delegators :@get_orders,         :get_orders
+    def_delegators :@get_portfolio,      :get_portfolio
+    def_delegators :@get_transactions,   :get_transactions
+
+    def initialize(login:, password:)
+      connection = Connection.new(login, password)
+
+      @create_order       = CreateOrder.new(connection)
+      @find_product_by_id = FindProductById.new(connection)
+      @find_products      = FindProducts.new(connection)
+      @get_cash_funds     = GetCashFunds.new(connection)
+      @get_orders         = GetOrders.new(connection)
+      @get_portfolio      = GetPortfolio.new(connection)
+      @get_transactions   = GetTransactions.new(connection)
+    end
+  end
+end

data/lib/degiro/connection.rb

@@ -0,0 +1,43 @@
+require 'json'
+require 'faraday'
+require 'faraday-cookie_jar'
+
+require_relative 'urls_map.rb'
+require_relative 'user_data.rb'
+require_relative 'errors.rb'
+
+module DeGiro
+  class Connection
+    extend Forwardable
+
+    def_delegators :@conn, :get, :post
+    attr_reader :urls_map, :user_data, :session_id
+
+    BASE_TRADER_URL = 'https://trader.degiro.nl'.freeze
+
+    def initialize(login, password)
+      @conn = Faraday.new(url: BASE_TRADER_URL) do |builder|
+        builder.use :cookie_jar
+        builder.use Faraday::Response::RaiseError
+        builder.adapter Faraday.default_adapter
+      end
+
+      response = @conn.post('/login/secure/login') do |req|
+        req.headers['Content-Type'] = 'application/json'
+        req.body = {
+          username: login,
+          password: password,
+          isPassCodeReset: false,
+          isRedirectToMobile: false,
+          queryParams: { reason: 'session_expired' }
+        }.to_json
+      end
+
+      @session_id = response.headers['set-cookie'][/JSESSIONID=(.*?);/m, 1]
+      raise MissingSessionIdError, 'Could not find valid session id' if @session_id == '' || @session_id.nil?
+
+      @urls_map = UrlsMap.new(JSON.parse(@conn.get('/login/secure/config').body))
+      @user_data = UserData.new(JSON.parse(@conn.get("#{@urls_map['pa_url']}/client?sessionId=#{@session_id}").body)["data"])
+    end
+  end
+end

data/lib/degiro/create_order.rb

@@ -0,0 +1,66 @@
+require 'json'
+
+module DeGiro
+  class CreateOrder
+    BUY_SELL    = { buy: 0, sell: 1 }.freeze
+    ORDER_TYPES = { limited: 0, stop_limited: 1, market_order: 2, stop_loss: 3 }.freeze
+    TIME_TYPES  = { day: 1, permanent: 3 }.freeze
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def create_buy_order(product_id:, size:, price:)
+      order = order(BUY_SELL[:buy], product_id, size, price)
+      confirmation_id = JSON.parse(check_order(order).body)['confirmationId']
+      confirm_order(order, confirmation_id)
+    end
+
+    def create_sell_order(product_id:, size:, price:)
+      order = order(BUY_SELL[:sell], product_id, size, price)
+      confirmation_id = JSON.parse(check_order(order).body)['confirmationId']
+      confirm_order(order, confirmation_id)
+    end
+
+    private
+
+    def order(type, product_id, size, price)
+      {
+        buysell:   type,
+        orderType: ORDER_TYPES[:limited],
+        productId: product_id,
+        size:      size,
+        timeType:  TIME_TYPES[:permanent],
+        price:     price
+      }
+    end
+
+    def check_order(order)
+      @connection.post(check_order_url) do |req|
+        req.headers['Content-Type'] = 'application/json; charset=UTF-8'
+        req.body = order.to_json
+      end
+    end
+
+    def confirm_order(order, confirmation_id)
+      @connection.post(confirm_order_url(confirmation_id)) do |req|
+        req.headers['Content-Type'] = 'application/json; charset=UTF-8'
+        req.body = order.to_json
+      end
+    end
+
+    def check_order_url
+      "#{@connection.urls_map['trading_url']}/v5/checkOrder" \
+      ";jsessionid=#{@connection.session_id}" \
+      "?intAccount=#{@connection.user_data['int_account']}" \
+      "&sessionId=#{@connection.session_id}"
+    end
+
+    def confirm_order_url(confirmation_id)
+      "#{@connection.urls_map['trading_url']}/v5/order/#{confirmation_id}" \
+      ";jsessionid=#{@connection.session_id}" \
+      "?intAccount=#{@connection.user_data['int_account']}" \
+      "&sessionId=#{@connection.session_id}"
+    end
+  end
+end

data/lib/degiro/errors.rb

@@ -0,0 +1,9 @@
+module DeGiro
+  class MissingSessionIdError < StandardError; end
+
+  class MissingUrlError < StandardError; end
+  class IncorrectUrlError < StandardError; end
+
+  class MissingUserFieldError < StandardError; end
+  class IncorrectUserFieldError < StandardError; end
+end

data/lib/degiro/find_product_by_id.rb

@@ -0,0 +1,37 @@
+require 'json'
+
+module DeGiro
+  class FindProductById
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def find_product_by_id(id:)
+      parse_product(JSON.parse(find_by_id(id).body))
+    end
+
+    private
+
+    def find_by_id(product_id)
+      @connection.post(url) do |req|
+        req.headers['Content-Type'] = 'application/json; charset=UTF-8'
+        req.body = [product_id].to_json
+      end
+    end
+
+    def parse_product(response)
+      {
+        id:          response['data'].values[0]['id'].to_s,
+        ticker:      response['data'].values[0]['symbol'].to_s,
+        exchange_id: response['data'].values[0]['exchangeId'].to_s,
+        isin:        response['data'].values[0]['isin'].to_s
+      }
+    end
+
+    def url
+      "#{@connection.urls_map['product_search_url']}/v5/products/info" \
+      "?intAccount=#{@connection.user_data['int_account']}" \
+      "&sessionId=#{@connection.session_id}"
+    end
+  end
+end

data/lib/degiro/find_products.rb

@@ -0,0 +1,34 @@
+require 'json'
+
+module DeGiro
+  class FindProducts
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def find_products(search_text:, limit: 7)
+      params = URI.encode_www_form(searchText: search_text, limit: limit)
+      parse_products(JSON.parse(@connection.get(url(params)).body))
+    end
+
+    private
+
+    def parse_products(response)
+      response['products'].map do |product|
+        {
+          id:          product['id'].to_s,
+          ticker:      product['symbol'],
+          exchange_id: product['exchangeId'],
+          isin:        product['isin']
+        }
+      end
+    end
+
+    def url(params)
+      "#{@connection.urls_map['product_search_url']}/v5/products/lookup" \
+      "?intAccount=#{@connection.user_data['int_account']}" \
+      "&sessionId=#{@connection.session_id}" \
+      "&#{params}"
+    end
+  end
+end

data/lib/degiro/get_cash_funds.rb

@@ -0,0 +1,32 @@
+require 'json'
+
+module DeGiro
+  class GetCashFunds
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get_cash_funds
+      params = URI.encode_www_form(cashFunds: 0)
+      parse_cash_funds(JSON.parse(@connection.get(url(params)).body))
+    end
+
+    private
+
+    def parse_cash_funds(response)
+      funds = response['cashFunds']['value'].map do |cash|
+        {
+          currency: cash['value'].find { |field| field['name'] == 'currencyCode' }['value'],
+          amount:   cash['value'].find { |field| field['name'] == 'value' }['value']
+        }
+      end
+      Hash[funds.map { |cash| [cash[:currency], cash[:amount]] }]
+    end
+
+    def url(params)
+      "#{@connection.urls_map['trading_url']}/v5/update/" \
+      "#{@connection.user_data['int_account']};jsessionid=#{@connection.session_id}" \
+      "?#{params}"
+    end
+  end
+end

data/lib/degiro/get_orders.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module DeGiro
+  class GetOrders
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get_orders
+      params = URI.encode_www_form(orders: 0, historicalOrders: 0, transactions: 0)
+      parse_orders(JSON.parse(@connection.get(url(params)).body))
+    end
+
+    private
+
+    def parse_orders(response)
+      response['orders']['value'].map do |order|
+        {
+          id:         order['id'],
+          type:       order['value'].find { |field| field['name'] == 'buysell' }['value'],
+          size:       order['value'].find { |field| field['name'] == 'size' }['value'],
+          price:      order['value'].find { |field| field['name'] == 'price' }['value'],
+          product_id: order['value'].find { |field| field['name'] == 'productId' }['value'].to_s,
+          product:    order['value'].find { |field| field['name'] == 'product' }['value']
+        }
+      end
+    end
+
+    def url(params)
+      "#{@connection.urls_map['trading_url']}/v5/update/" \
+      "#{@connection.user_data['int_account']};jsessionid=#{@connection.session_id}" \
+      "?#{params}"
+    end
+  end
+end

data/lib/degiro/get_portfolio.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module DeGiro
+  class GetPortfolio
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get_portfolio
+      params = URI.encode_www_form(portfolio: 0)
+      parse_portfolio(JSON.parse(@connection.get(url(params)).body))
+    end
+
+    private
+
+    def parse_portfolio(response)
+      portfolio = response['portfolio']['value'].map do |order|
+        {
+          size:       order['value'].find { |field| field['name'] == 'size' }['value'],
+          value:      order['value'].find { |field| field['name'] == 'price' }['value'],
+          product_id: order['value'].find { |field| field['name'] == 'id' }['value'].to_s
+        }
+      end
+      portfolio.select { |entry| entry[:size] > 0 }
+    end
+
+    def url(params)
+      "#{@connection.urls_map['trading_url']}/v5/update/" \
+      "#{@connection.user_data['int_account']};jsessionid=#{@connection.session_id}" \
+      "?#{params}"
+    end
+  end
+end

data/lib/degiro/get_transactions.rb

@@ -0,0 +1,40 @@
+require 'date'
+require 'json'
+
+module DeGiro
+  class GetTransactions
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get_transactions(from: (Date.today - (365 * 5)).strftime('%d/%m/%Y'), to: Date.today.strftime('%d/%m/%Y'))
+      params = URI.encode_www_form(fromDate: from, toDate: to)
+      parse_transactions(JSON.parse(@connection.get(url(params)).body))
+    end
+
+    private
+
+    def parse_transactions(response)
+      response['data']
+        .sort_by { |transaction| transaction['date'] }
+        .reverse
+        .map do |transaction|
+          {
+            id:         transaction['id'],
+            type:       transaction['buysell'],
+            size:       transaction['quantity'].abs,
+            price:      transaction['price'],
+            product_id: transaction['productId'].to_s
+          }
+        end
+    end
+
+    def url(params)
+      "#{@connection.urls_map['reporting_url']}/v4/transactions" \
+      '?orderId=&product=&groupTransactionsByOrder=false' \
+      "&intAccount=#{@connection.user_data['int_account']}" \
+      "&sessionId=#{@connection.session_id}" \
+      "&#{params}"
+    end
+  end
+end

data/lib/degiro/urls_map.rb

@@ -0,0 +1,26 @@
+require_relative 'errors.rb'
+
+module DeGiro
+  class UrlsMap
+    URL_NAMES = [
+      'paUrl',
+      'productSearchUrl',
+      'productTypesUrl',
+      'reportingUrl',
+      'tradingUrl',
+      'vwdQuotecastServiceUrl'
+    ].freeze
+
+    def initialize(data)
+      @map = URL_NAMES.each_with_object({}) do |url_name, acc|
+        raise MissingUrlError, "Could not find url '#{url_name}'" unless data.key?(url_name)
+        acc[url_name.gsub(/(.)([A-Z])/, '\1_\2').downcase] = data[url_name]
+      end
+    end
+
+    def [](url_name)
+      raise IncorrectUrlError, "Could not find url '#{url_name}'" unless @map.key?(url_name)
+      @map[url_name]
+    end
+  end
+end

data/lib/degiro/user_data.rb

@@ -0,0 +1,22 @@
+require_relative 'errors.rb'
+
+module DeGiro
+  class UserData
+    USER_FIELDS = [
+      'id',
+      'intAccount'
+    ].freeze
+
+    def initialize(data)
+      @map = USER_FIELDS.each_with_object({}) do |user_field, acc|
+        raise MissingUserFieldError, "Could not find user field '#{user_field}'" unless data.key?(user_field)
+        acc[user_field.gsub(/(.)([A-Z])/, '\1_\2').downcase] = data[user_field]
+      end
+    end
+
+    def [](user_field)
+      raise IncorrectUserFieldError, "Could not find user field '#{user_field}'" unless @map.key?(user_field)
+      @map[user_field]
+    end
+  end
+end

data/lib/degiro/version.rb

@@ -0,0 +1,3 @@
+module DeGiro
+  VERSION = '0.0.2'.freeze
+end

data/lib/degiro.rb

@@ -0,0 +1 @@
+require_relative 'degiro/client.rb'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: degiro_client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Grzegorz Błaszczyk
+- Tom Van Eyck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: faraday-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+description: Ruby Client for the unofficial DeGiro API
+email:
+- grzegorz.blaszczyk@gmail.com
+- tomvaneyck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/degiro.rb
+- lib/degiro/client.rb
+- lib/degiro/connection.rb
+- lib/degiro/create_order.rb
+- lib/degiro/errors.rb
+- lib/degiro/find_product_by_id.rb
+- lib/degiro/find_products.rb
+- lib/degiro/get_cash_funds.rb
+- lib/degiro/get_orders.rb
+- lib/degiro/get_portfolio.rb
+- lib/degiro/get_transactions.rb
+- lib/degiro/urls_map.rb
+- lib/degiro/user_data.rb
+- lib/degiro/version.rb
+homepage: https://github.com/grzegorzblaszczyk/degiro
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Ruby Client for the unofficial DeGiro API
+test_files: []