Read Orders

HTTP

Example

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

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

Python

Signature

def read_platform_orders(self, pseudo_account):

Example

response = autotrader.read_platform_orders('XX1234')

if response.success():
	# response.result is a list of PlatformOrder objects
	for o in response.result:
		print(o.id, o.independent_symbol, o.status)
else:
	print("Message: {0}".format(response.message))

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

Java

Signature

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

Example

IOperationResponse<Set<PlatformOrder>> response =
    this.autotrader.readPlatformOrders("ACC_NAME");

Set<PlatformOrder> orders = null;
if (response.success()) {
    orders = response.getResult();
}

Use getResult() to get the set of orders. Each object exposes the Order fields below through getters such as getStatus().

C#

Signature

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

Example

IOperationResponse<ISet<PlatformOrder>> response = 
	autoTrader.ReadPlatformOrders("XX1234");

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

Use the Result property to get the set of orders. Each object exposes the Order fields below as properties such as Status.

Excel

Signature

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

Public Function GetOrderStatus(pseudoAccount As String, _
	orderId As String) As String

Every field in Order fields has a matching GetOrder<Field> function.

AmiBroker

Signature

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

function getOrderStatus(pseudoAccount, orderId)

Example

// orderId is the id returned by placeOrder
status = getOrderStatus(AT_ACCOUNT, orderId);
price = getOrderPrice(AT_ACCOUNT, orderId);

Every field in Order fields has a matching getOrder<Field> function.

MetaTrader

Signature

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

string getOrderStatus(string pseudoAccount, string orderId)

Example

// orderId is the id returned by placeOrder
string status = getOrderStatus(AT_ACCOUNT, orderId);
double price = getOrderPrice(AT_ACCOUNT, orderId);

Every field in Order fields has a matching getOrder<Field> function.