Class: DhanHQ::Resources::MarginCalculator

Inherits:
BaseAPI
  • Object
show all
Defined in:
lib/DhanHQ/resources/margin_calculator.rb

Overview

Resource client for invoking the margin calculator endpoint.

Constant Summary collapse

API_TYPE =

Calculator results are served via the trading API.

:order_api
HTTP_PATH =

Base path for the calculator endpoint.

"/v2/margincalculator"

Instance Attribute Summary

Attributes inherited from BaseAPI

#client

Instance Method Summary collapse

Methods inherited from BaseAPI

#delete, #get, #initialize, #post, #put

Methods included from AttributeHelper

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

Methods included from APIHelper

#handle_response

Constructor Details

This class inherits a constructor from DhanHQ::BaseAPI

Instance Method Details

#calculate(params) ⇒ Hash

Calculate margin requirements for an order.

Parameters:

  • params (Hash) —

    Request parameters for margin calculation.

Returns:

  • (Hash) —

    API response containing margin details.



17
18
19
 
# File 'lib/DhanHQ/resources/margin_calculator.rb', line 17

def calculate(params)
  post("", params: params)
end

#calculate_multi(params) ⇒ Hash

Calculate margin requirements for multiple scripts in one request.

Parameters:

  • params (Hash) —

    Request parameters including scripList, includePosition, includeOrder.

Returns:

  • (Hash) —

    API response containing combined margin details with hedge benefit.



26
27
28
 
# File 'lib/DhanHQ/resources/margin_calculator.rb', line 26

def calculate_multi(params)
  post("/multi", params: params)
end