Read Margins

HTTP

Example

curl https://apix.stocksdeveloper.in/trading/readPlatformMargins \
   -H "api-key: <your-api-key>" \
   -d "pseudoAccount=ACC_NAME"

The response is JSON, in the format shown under Response. Each margin carries the Margin fields listed below.

Python

Signature

def read_platform_margins(self, pseudo_account):

Example

response = autotrader.read_platform_margins('XX1234')

if response.success():
	# response.result is a list of PlatformMargin objects
	for m in response.result:
		print(m.category, m.funds, m.available)
else:
	print("Message: {0}".format(response.message))

response.result is a list of margin objects. Read each field with object.property notation. Each object exposes the Margin fields below.

Java

Signature

/**
 * Read margins from the trading account mapped to the given pseudo account.
 *
 * @param pseudoAccount pseudo account id
 * @return trading platform margins
 */
IOperationResponse<Set<PlatformMargin>>
	readPlatformMargins(final String pseudoAccount);

Example

IOperationResponse<Set<PlatformMargin>> response =
    this.autotrader.readPlatformMargins("ACC_NAME");

Set<PlatformMargin> margins = null;
if (response.success()) {
    margins = response.getResult();
}

Use getResult() to get the set of margins. Each object exposes the Margin fields below through getters such as getAvailable().

C#

Signature

/// <summary>
/// Read margins from the trading account mapped to the given pseudo account.
/// </summary>
/// <param name="pseudoAccount"> pseudo account id </param>
/// <returns> trading platform margins </returns>
IOperationResponse<ISet<PlatformMargin>> ReadPlatformMargins(
	string pseudoAccount);

Example

IOperationResponse<ISet<PlatformMargin>> response = 
	autoTrader.ReadPlatformMargins("XX1234");

foreach (PlatformMargin p in response.Result)
	Console.WriteLine("{0}", p);

Use the Result property to get the set of margins. Each object exposes the Margin fields below as properties such as Available.

Excel

Signature

Excel exposes one function per field and category. They all take the same arguments:

Public Function GetMarginAvailable(pseudoAccount As String, _
	category As String) As Double

Every field in Margin fields has a matching GetMargin<Field> function (for example GetMarginFundsEquity, GetMarginAvailableAll).

AmiBroker

Signature

AmiBroker exposes one function per field and category. They all take the same arguments:

function getMarginAvailableEquity(pseudoAccount)

Example

fundsEquity = getMarginFundsEquity(AT_ACCOUNT);
availableAll = getMarginAvailableAll(AT_ACCOUNT);

Every field in Margin fields has a matching getMargin<Field> function.

MetaTrader

Signature

MetaTrader exposes one function per field and category. They all take the same arguments:

double getMarginAvailableEquity(string pseudoAccount)

Example

double fundsEquity = getMarginFundsEquity(AT_ACCOUNT);
double availableAll = getMarginAvailableAll(AT_ACCOUNT);

Every field in Margin fields has a matching getMargin<Field> function.