Class: DhanHQ::BaseAPI

Inherits:

Object

• Object
• DhanHQ::BaseAPI

Includes:

APIHelper, AttributeHelper

Defined in:

lib/DhanHQ/core/base_api.rb

Overview

Base class for all API resource classes. Delegates HTTP requests to Client and exposes helpers shared by resource wrappers.

Direct Known Subclasses

BaseResource, Resources::Edis, Resources::ExpiredOptionsData, Resources::ForeverOrders, Resources::Funds, Resources::HistoricalData, Resources::Holdings, Resources::IPSetup, Resources::IcebergOrders, Resources::Instruments, Resources::KillSwitch, Resources::MarginCalculator, Resources::MarketFeed, Resources::OptionChain, Resources::Orders, Resources::PnlExit, Resources::Positions, Resources::Profile, Resources::Statements, Resources::SuperOrders, Resources::TraderControl, Resources::Trades, Resources::TwapOrders

Constant Summary

API_TYPE =

Default API type used when a subclass does not override #initialize.

:non_trading_api

HTTP_PATH =

Root path prepended to each endpoint segment.

""

Instance Attribute Summary

• #client ⇒ Object readonly

  Returns the value of attribute client.

Instance Method Summary

• #delete(endpoint) ⇒ Hash, Array

  Perform a DELETE request via Client.

• #get(endpoint, params: {}) ⇒ Hash, Array

  Perform a GET request via Client.

• #initialize(api_type: self.class::API_TYPE) ⇒ BaseAPI constructor

  Initializes the BaseAPI with the appropriate Client instance.

• #post(endpoint, params: {}) ⇒ Hash, Array

  Perform a POST request via Client.

• #put(endpoint, params: {}) ⇒ Hash, Array

  Perform a PUT request via Client.

Methods included from AttributeHelper

#camelize_keys, #inspect, #normalize_keys, #snake_case, #titleize_keys

Methods included from APIHelper

#handle_response

Constructor Details

#initialize(api_type: self.class::API_TYPE) ⇒ BaseAPI

Initializes the BaseAPI with the appropriate Client instance

Parameters:

• api_type (Symbol) (defaults to: self.class::API_TYPE) —

  API type (:order_api, :data_api, :non_trading_api)

# File 'lib/DhanHQ/core/base_api.rb', line 21

def initialize(api_type: self.class::API_TYPE)
  @client = DhanHQ::Client.new(api_type: api_type)
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.

# File 'lib/DhanHQ/core/base_api.rb', line 16

def client
  @client
end

Instance Method Details

#delete(endpoint) ⇒ Hash, Array

Perform a DELETE request via Client

Parameters:

• endpoint (String) —

  API endpoint

Returns:

• (Hash, Array) —

  The parsed API response

# File 'lib/DhanHQ/core/base_api.rb', line 59

def delete(endpoint)
  formatted_params = format_params(endpoint, {})
  handle_response(client.delete(build_path(endpoint), formatted_params))
end

#get(endpoint, params: {}) ⇒ Hash, Array

Perform a GET request via Client

Parameters:

• endpoint (String) —

  API endpoint

• params (Hash) (defaults to: {}) —

  Query parameters

Returns:

• (Hash, Array) —

  The parsed API response

# File 'lib/DhanHQ/core/base_api.rb', line 30

def get(endpoint, params: {})
  formatted_params = format_params(endpoint, params)
  handle_response(client.get(build_path(endpoint), formatted_params))
end

#post(endpoint, params: {}) ⇒ Hash, Array

Perform a POST request via Client

Parameters:

• endpoint (String) —

  API endpoint

• params (Hash) (defaults to: {}) —

  Request body

Returns:

• (Hash, Array) —

  The parsed API response

# File 'lib/DhanHQ/core/base_api.rb', line 40

def post(endpoint, params: {})
  formatted_params = format_params(endpoint, params)
  handle_response(client.post(build_path(endpoint), formatted_params))
end

#put(endpoint, params: {}) ⇒ Hash, Array

Perform a PUT request via Client

Parameters:

• endpoint (String) —

  API endpoint

• params (Hash) (defaults to: {}) —

  Request body

Returns:

• (Hash, Array) —

  The parsed API response

# File 'lib/DhanHQ/core/base_api.rb', line 50

def put(endpoint, params: {})
  formatted_params = format_params(endpoint, params)
  handle_response(client.put(build_path(endpoint), formatted_params))
end