tastytrade-api-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '039f4f50b776893b0cf82d0f7a4e74376ced5683c7e4a3328e143be465cd5b80'
+  data.tar.gz: cecafd94ea98b0d2a1adf55c9d4f8694f2ddd3423b21d28fa903dfd2c4b4c6b8
+SHA512:
+  metadata.gz: abcbbcbe2ba28a6c1452af6c8bfeb477857a592fbf5a9453fdc95b5c223a2f20f476f189ca58782cbc430b12b15960ba7a7a50afb63c6f14c8d7829824418886
+  data.tar.gz: bdc8682292370b10fd62e89447bb1fba6857f0539c84fabcedd0b06d88fa935d8383d755c868974e2fe7ed33229c2cbce8f29a23cff3405a57fa9e365a90bb03

data/lib/tastytrade/authentication.rb

@@ -0,0 +1,77 @@
+require 'tastytrade/util'
+require 'httparty'
+
+module Tastytrade
+  module Authentication
+    include Util
+
+    attr_reader :client_id, :secret, :redirect_uri, :authorization_code, :access_token, :refresh_token,
+                :access_token_expires_at
+
+    def default_headers
+      { 'Content-Type': 'application/x-www-form-urlencoded' }
+    end
+
+    # Returns a hash with access_token, refresh_token, expires_in, etc.
+    # Used for trusted partner applications that have obtained an authorization code.
+    def request_access_token(authorization_grant_code)
+      options = {
+        body: {
+          'grant_type' => 'authorization_code',
+          'code' => authorization_grant_code,
+          'client_id' => client_id,
+          'client_secret' => secret,
+          'redirect_uri' => redirect_uri
+        },
+        headers: default_headers
+      }
+
+      response = HTTParty.post(
+        "#{Tastytrade::BASE_URL}/oauth/token",
+        options
+      )
+
+      unless response_success?(response)
+        raise Tastytrade::APIError.new(
+          "Unable to retrieve access tokens from API - #{response.code} - #{response.body}"
+        )
+      end
+
+      update_tokens(response)
+      response
+    end
+
+    # Refresh tokens never expire per TastyTrade docs.
+    def refresh_access_token
+      options = {
+        body: {
+          'grant_type' => 'refresh_token',
+          'refresh_token' => refresh_token,
+          'client_secret' => secret
+        },
+        headers: default_headers
+      }
+
+      response = HTTParty.post(
+        "#{Tastytrade::BASE_URL}/oauth/token",
+        options
+      )
+
+      update_tokens(response)
+      response
+    end
+
+    private
+
+    def update_tokens(args={})
+      raise_error("#{args['error_code']} - #{args['error_description']}") if args.has_key?('error_code')
+
+      # Refresh tokens never expire per TastyTrade documentation
+      @access_token = args['access_token']
+      @refresh_token = args['refresh_token'] if args['refresh_token']
+      @access_token_expires_at = Time.now + args['expires_in'].to_i
+
+      args
+    end
+  end
+end

data/lib/tastytrade/client.rb

@@ -0,0 +1,49 @@
+require 'tastytrade/authentication'
+require 'tastytrade/error'
+require 'tastytrade/version'
+require 'tastytrade/operations/account_transactions/get_total_fees'
+require 'tastytrade/operations/account_transactions/get_transaction'
+require 'tastytrade/operations/account_transactions/list_transactions'
+require 'tastytrade/operations/customer_account_info/get_customer'
+require 'tastytrade/operations/customer_account_info/list_customer_accounts'
+require 'tastytrade/operations/customer_account_info/get_account'
+
+module Tastytrade
+  class Client
+    include Tastytrade::Authentication
+    include Tastytrade::Error
+
+    def initialize(**args)
+      @access_token = args[:access_token]
+      @refresh_token = args[:refresh_token]
+      @access_token_expires_at = args[:access_token_expires_at]
+      @client_id = args[:client_id] || raise_error('client_id is required!')
+      @secret = args[:secret] || raise_error('secret is required!')
+      @redirect_uri = args[:redirect_uri] || raise_error('redirect_uri is required!')
+    end
+
+    def get_total_fees(account_number:, **options)
+      Operations::AccountTransactions::GetTotalFees.new(self).call(account_number:, **options)
+    end
+
+    def get_transaction(account_number:, id:)
+      Operations::AccountTransactions::GetTransaction.new(self).call(account_number:, id:)
+    end
+
+    def list_transactions(account_number:, **options)
+      Operations::AccountTransactions::ListTransactions.new(self).call(account_number:, **options)
+    end
+
+    def get_customer
+      Operations::CustomerAccountInfo::GetCustomer.new(self).call
+    end
+
+    def list_customer_accounts
+      Operations::CustomerAccountInfo::ListCustomerAccounts.new(self).call
+    end
+
+    def get_account(account_number:)
+      Operations::CustomerAccountInfo::GetAccount.new(self).call(account_number:)
+    end
+  end
+end

data/lib/tastytrade/error.rb

@@ -0,0 +1,23 @@
+module Tastytrade
+  class APIError < StandardError
+  end
+
+  class RateLimitError < StandardError
+  end
+
+  class NotAuthorizedError < StandardError
+  end
+
+  class BadRequestError < StandardError
+  end
+
+  module Error
+    module_function
+
+    def raise_error(message, klass=Tastytrade::APIError)
+      error = klass.new(message)
+      error.set_backtrace(caller)
+      raise error
+    end
+  end
+end

data/lib/tastytrade/operations/account_transactions/get_total_fees.rb

@@ -0,0 +1,24 @@
+require 'tastytrade/operations/base_operation'
+
+module Tastytrade
+  module Operations
+    module AccountTransactions
+      class GetTotalFees < BaseOperation
+
+        # Calls GET /accounts/{account_number}/transactions/total-fees
+        #
+        # Options:
+        #   date: String - "YYYY-MM-DD" (default: today)
+        def call(account_number:, date: nil)
+          query = date ? { date: date } : nil
+
+          perform_api_get_request(
+            url: "#{Tastytrade::BASE_URL}/accounts/#{account_number}/transactions/total-fees",
+            query: query
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/tastytrade/operations/account_transactions/get_transaction.rb

@@ -0,0 +1,18 @@
+require 'tastytrade/operations/base_operation'
+
+module Tastytrade
+  module Operations
+    module AccountTransactions
+      class GetTransaction < BaseOperation
+
+        # Calls GET /accounts/{account_number}/transactions/{id}
+        def call(account_number:, id:)
+          perform_api_get_request(
+            url: "#{Tastytrade::BASE_URL}/accounts/#{account_number}/transactions/#{id}"
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/tastytrade/operations/account_transactions/list_transactions.rb

@@ -0,0 +1,113 @@
+require 'tastytrade/operations/base_operation'
+
+module Tastytrade
+  module Operations
+    module AccountTransactions
+      class ListTransactions < BaseOperation
+
+        VALID_SORT_VALUES = %w[Asc Desc].freeze
+
+        VALID_TYPES = [
+          'Administrative Transfer',
+          'Money Movement',
+          'Receive Deliver',
+          'Trade'
+        ].freeze
+
+        VALID_SUB_TYPES = [
+          'ACAT', 'Assignment', 'Balance Adjustment', 'Cash Merger',
+          'Cash Settled Assignment', 'Cash Settled Exercise', 'Credit Interest',
+          'Debit Interest', 'Deposit', 'Dividend', 'Exercise', 'Expiration',
+          'Fee', 'Forward Split', 'Fully Paid Stock Lending Income',
+          'Futures Settlement', 'Mark to Market', 'Maturity', 'Reverse Split',
+          'Reverse Split Removal', 'Special Dividend', 'Stock Merger',
+          'Stock Merger Removal', 'Symbol Change', 'Transfer', 'Withdrawal'
+        ].freeze
+
+        VALID_INSTRUMENT_TYPES = %w[
+          Bond Cryptocurrency Equity EquityOffering EquityOption
+          Future FutureOption Index Unknown Warrant
+        ].freeze
+
+        VALID_ACTIONS = [
+          'Buy', 'Buy to Close', 'Buy to Open',
+          'Sell', 'Sell to Close', 'Sell to Open'
+        ].freeze
+
+        # Calls GET /accounts/{account_number}/transactions
+        #
+        # Options:
+        #   sort:               String  - "Asc" or "Desc" (default: "Desc")
+        #   type:               String  - single transaction type (mutually exclusive with types:)
+        #   types:              Array   - multiple transaction types (mutually exclusive with type:)
+        #   sub_type:           Array   - transaction sub-types (passed as 'sub-type[]')
+        #   start_date:         String  - "YYYY-MM-DD"
+        #   end_date:           String  - "YYYY-MM-DD"
+        #   instrument_type:    String
+        #   symbol:             String
+        #   underlying_symbol:  String
+        #   action:             String
+        #   partition_key:      String
+        #   futures_symbol:     String
+        #   start_at:           String  - "YYYY-MM-DDTHH:MM:SS"
+        #   end_at:             String  - "YYYY-MM-DDTHH:MM:SS"
+        #   page_offset:        Integer - for pagination
+        def call(account_number:, **options)
+          validate_options!(options)
+
+          query = build_query(options)
+
+          perform_api_get_request(
+            url: "#{Tastytrade::BASE_URL}/accounts/#{account_number}/transactions",
+            query: query.empty? ? nil : query
+          )
+        end
+
+        private
+
+        def validate_options!(options)
+          if options[:type] && options[:types]
+            raise ArgumentError, "'type' and 'types' are mutually exclusive"
+          end
+
+          if options[:sort] && !VALID_SORT_VALUES.include?(options[:sort])
+            raise ArgumentError, "sort must be one of: #{VALID_SORT_VALUES.join(', ')}"
+          end
+
+          if options[:type] && !VALID_TYPES.include?(options[:type])
+            raise ArgumentError, "type must be one of: #{VALID_TYPES.join(', ')}"
+          end
+
+          if options[:types]
+            invalid = Array(options[:types]).reject { |t| VALID_TYPES.include?(t) }
+            raise ArgumentError, "invalid types: #{invalid.join(', ')}" if invalid.any?
+          end
+
+          if options[:action] && !VALID_ACTIONS.include?(options[:action])
+            raise ArgumentError, "action must be one of: #{VALID_ACTIONS.join(', ')}"
+          end
+        end
+
+        def build_query(options)
+          query = {}
+          query[:sort]               = options[:sort]              if options[:sort]
+          query[:type]               = options[:type]              if options[:type]
+          query[:types]              = options[:types]             if options[:types]
+          query['sub-type']          = options[:sub_type]          if options[:sub_type]
+          query['start-date']        = options[:start_date]        if options[:start_date]
+          query['end-date']          = options[:end_date]          if options[:end_date]
+          query['instrument-type']   = options[:instrument_type]   if options[:instrument_type]
+          query[:symbol]             = options[:symbol]            if options[:symbol]
+          query['underlying-symbol'] = options[:underlying_symbol] if options[:underlying_symbol]
+          query[:action]             = options[:action]            if options[:action]
+          query['partition-key']     = options[:partition_key]     if options[:partition_key]
+          query['futures-symbol']    = options[:futures_symbol]    if options[:futures_symbol]
+          query['start-at']          = options[:start_at]          if options[:start_at]
+          query['end-at']            = options[:end_at]            if options[:end_at]
+          query['page-offset']       = options[:page_offset]       if options[:page_offset]
+          query
+        end
+      end
+    end
+  end
+end

data/lib/tastytrade/operations/base_operation.rb

@@ -0,0 +1,62 @@
+require 'tastytrade/error'
+require 'tastytrade/util'
+
+module Tastytrade
+  module Operations
+    class BaseOperation
+      include Tastytrade::Error
+      include Util
+
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      private
+
+      def debug_output?
+        ENV['DEBUG_OUTPUT'].to_s == 'true'
+      end
+
+      def handle_api_error(response)
+        if response.code == 429
+          raise Tastytrade::RateLimitError.new(response.body)
+        elsif response.code == 401
+          raise Tastytrade::NotAuthorizedError.new(response.body)
+        elsif response.code == 404
+          raise Tastytrade::BadRequestError.new(response.body)
+        end
+
+        error_message = response['error'].to_s
+        raise Tastytrade::APIError.new("#{response.code}: #{error_message}")
+      rescue JSON::ParserError
+        raise Tastytrade::APIError.new(
+          "Unable to parse error response from TastyTrade API: #{response.code} - #{response.body} | #{response}"
+        )
+      end
+
+      def parse_response(response)
+        raise ArgumentError unless response.is_a?(HTTParty::Response)
+        handle_api_error(response) unless response_success?(response)
+
+        JSON.parse(response.body)
+      end
+
+      def perform_api_get_request(url:, query: nil)
+        options = {
+          headers: {
+            'Authorization': "Bearer #{client.access_token}",
+            'Accept': 'application/json'
+          }
+        }
+        options.merge!(query: query) if query
+        options.merge!(debug_output: $stdout) if debug_output?
+
+        response = HTTParty.get(url, options)
+
+        parse_response(response)
+      end
+    end
+  end
+end

data/lib/tastytrade/operations/customer_account_info/get_account.rb

@@ -0,0 +1,18 @@
+require 'tastytrade/operations/base_operation'
+
+module Tastytrade
+  module Operations
+    module CustomerAccountInfo
+      class GetAccount < BaseOperation
+
+        # Calls GET /customers/me/accounts/{account_number}
+        def call(account_number:)
+          perform_api_get_request(
+            url: "#{Tastytrade::BASE_URL}/customers/me/accounts/#{account_number}"
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/tastytrade/operations/customer_account_info/get_customer.rb

@@ -0,0 +1,16 @@
+require 'tastytrade/operations/base_operation'
+
+module Tastytrade
+  module Operations
+    module CustomerAccountInfo
+      class GetCustomer < BaseOperation
+
+        # Calls GET /customers/me
+        def call
+          perform_api_get_request(url: "#{Tastytrade::BASE_URL}/customers/me")
+        end
+
+      end
+    end
+  end
+end

data/lib/tastytrade/operations/customer_account_info/list_customer_accounts.rb

@@ -0,0 +1,16 @@
+require 'tastytrade/operations/base_operation'
+
+module Tastytrade
+  module Operations
+    module CustomerAccountInfo
+      class ListCustomerAccounts < BaseOperation
+
+        # Calls GET /customers/me/accounts
+        def call
+          perform_api_get_request(url: "#{Tastytrade::BASE_URL}/customers/me/accounts")
+        end
+
+      end
+    end
+  end
+end

data/lib/tastytrade/util.rb

@@ -0,0 +1,11 @@
+require 'tastytrade/error'
+
+module Tastytrade
+  module Util
+    module_function
+
+    def response_success?(response)
+      response.code.to_s =~ /^2\d\d/
+    end
+  end
+end

data/lib/tastytrade/version.rb

@@ -0,0 +1,4 @@
+module Tastytrade
+  VERSION = '0.1.0'
+  BASE_URL = 'https://api.tastyworks.com'
+end

data/lib/tastytrade-api-ruby.rb

@@ -0,0 +1 @@
+require 'tastytrade'

data/lib/tastytrade.rb

@@ -0,0 +1,14 @@
+require 'httparty'
+
+require 'tastytrade/version'
+require 'tastytrade/error'
+require 'tastytrade/util'
+require 'tastytrade/authentication'
+require 'tastytrade/operations/base_operation'
+require 'tastytrade/operations/account_transactions/get_total_fees'
+require 'tastytrade/operations/account_transactions/get_transaction'
+require 'tastytrade/operations/account_transactions/list_transactions'
+require 'tastytrade/client'
+
+module Tastytrade
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: tastytrade-api-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Winston Kotzan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a gem for connecting to the OAuth/JSON-based TastyTrade API.
+  See https://developer.tastytrade.com/ for the official documentation and to create
+  your developer account.
+email:
+- wak@wakproductions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tastytrade-api-ruby.rb
+- lib/tastytrade.rb
+- lib/tastytrade/authentication.rb
+- lib/tastytrade/client.rb
+- lib/tastytrade/error.rb
+- lib/tastytrade/operations/account_transactions/get_total_fees.rb
+- lib/tastytrade/operations/account_transactions/get_transaction.rb
+- lib/tastytrade/operations/account_transactions/list_transactions.rb
+- lib/tastytrade/operations/base_operation.rb
+- lib/tastytrade/operations/customer_account_info/get_account.rb
+- lib/tastytrade/operations/customer_account_info/get_customer.rb
+- lib/tastytrade/operations/customer_account_info/list_customer_accounts.rb
+- lib/tastytrade/util.rb
+- lib/tastytrade/version.rb
+homepage: https://github.com/wakproductions/tastytrade-api-ruby
+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.3.26
+signing_key: 
+specification_version: 4
+summary: This is a simple gem for connecting to the TastyTrade OAuth API
+test_files: []