Skip to content

Positions

Summary

Provides access to methods of the positions collection.

Signature 

1
public abstract interface Positions

Namespace

cAlgo.API

Examples

1
 int totalPositions = Positions.Count;

1
 Position position =  Positions.Find("myLabel", Symbol, TradeType.Buy);

1
 Position[] positions = Positions.FindAll("myLabel", Symbol, TradeType.Buy);

1
 Positions.Opened += PositionsOnOpened;

1
 totalPositions = api.Positions.Count

1
 position =  api.Positions.Find("myLabel", api.Symbol, TradeType.Buy)

1
 positions = api.Positions.FindAll("myLabel", Symbol, TradeType.Buy)

1
 api.Positions.Opened += self.on_position_opened

See Also

Methods

Find (3)

Find (1 of 3)

Summary

Find a position by its label.

Signature 

1
public abstract Position Find(string label)

Parameters

Name Type Description
label string Label to search by

Return Value

Position

Examples

1
 var position = Positions.Find("myLabel");

1
 position = api.Positions.Find("myLabel")

Find (2 of 3)

Summary

Find a position by its label and symbol name.

Signature 

1
public abstract Position Find(string label, string symbolName)

Parameters

Name Type Description
label string Label to search by
symbolName string Symbol name to search by

Return Value

Position

Examples

1
 var position = Positions.Find("myLabel", "EURUSD");

1
 position = api.Positions.Find("myLabel", "EURUSD")

Find (3 of 3)

Summary

Find a position by its label, symbol name and trade type

Signature 

1
public abstract Position Find(string label, string symbolName, TradeType tradeType)

Parameters

Name Type Description
label string Label to search by
symbolName string Symbol name to search by
tradeType TradeType Trade type to search by

Return Value

Position

Examples

1
 var position = Positions.Find("myLabel", "EURUSD", TradeType.Buy);

1
 position = api.Positions.Find("myLabel", "EURUSD", TradeType.Buy)

FindAll (3)

FindAll (1 of 3)

Summary

Find all positions with this label.

Signature 

1
public abstract Position[] FindAll(string label)

Parameters

Name Type Description
label string Label to search by

Return Value

Position[]

Examples

1
2
3
4
5
6
 var positions = Positions.FindAll("myLabel");
 foreach (var position in positions)
 {
     double? newStopLoss = position.StopLoss ?? 10;
     ModifyPosition(position, newStopLoss, position.TakeProfit);
 }

1
2
3
4
 positions = api.Positions.FindAll("myLabel")
 for position in positions:
     newStopLoss = position.StopLoss if position.StopLoss is not None else 10
     api.ModifyPosition(position, newStopLoss, position.TakeProfit)

FindAll (2 of 3)

Summary

Find all positions with this label and symbol name.

Signature 

1
public abstract Position[] FindAll(string label, string symbolName)

Parameters

Name Type Description
label string Label to search by
symbolName string Symbol name to search by

Return Value

Position[]

Examples

1
2
3
4
5
6
 var positions = Positions.FindAll("myLabel", "EURUSD");
 foreach (var position in positions)
 {
     double? newStopLoss = position.StopLoss ?? 10;
     ModifyPosition(position, newStopLoss, position.TakeProfit);
 }

1
2
3
4
 positions = api.Positions.FindAll("myLabel", "EURUSD")
 for position in positions:
     newStopLoss = position.StopLoss if position.StopLoss is not None else 10
     api.ModifyPosition(position, newStopLoss, position.TakeProfit)

FindAll (3 of 3)

Summary

Finds all the positions of this label, symbol name and trade type.

Signature 

1
public abstract Position[] FindAll(string label, string symbolName, TradeType tradeType)

Parameters

Name Type Description
label string Label to search by
symbolName string Symbol name to search by
tradeType TradeType Trade type to search by

Return Value

Position[]

Examples

1
2
3
4
5
6
 var positions = Positions.FindAll("myLabel", "EURUSD", TradeType.Buy);
 foreach (var position in positions)
 {
     double? newStopLoss = position.StopLoss ?? 10;
     ModifyPosition(position, newStopLoss, position.TakeProfit);
 }

1
2
3
4
 positions = api.Positions.FindAll("myLabel", "EURUSD", TradeType.Buy)
 for position in positions:
     newStopLoss = position.StopLoss if position.StopLoss is not None else 10
     api.ModifyPosition(position, newStopLoss, position.TakeProfit)

FindById

Summary

Find Position by Id.

Signature 

1
public abstract Position FindById(int id)

Parameters

Name Type Description
id int Position Id

Return Value

Position

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
 using cAlgo.API;
 namespace cAlgo.Robots;
 [Robot(AccessRights = AccessRights.None)]
 public class Test : Robot
 {
     protected override void OnStart()
     {
         const int positionId = 342343;
         if (Positions.FindById(positionId) is {} position)
             Print($"Position NetProfit: {position.NetProfit}");
     }
 }

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
 import clr
 clr.AddReference("cAlgo.API")
 # Import cAlgo API types
 from cAlgo.API import *
 # Import trading wrapper functions
 from robot_wrapper import *
 class Test():
     def on_start(self):
         positionId = 342343
         position = api.Positions.FindById(positionId)
         if position is not None:
             print(f"Position NetProfit: {position.NetProfit}")

Properties

Item

Signature 

1
public abstract Position Item {get;}

Return Value

Position

Count

Summary

The total number of open positions.

Signature 

1
public abstract int Count {get;}

Return Value

int

Examples

1
 int totalPositions = Positions.Count;

1
 totalPositions = api.Positions.Count

Events

Closed

Summary

Occurs each time a position is closed.

Signature 

1
public abstract event Action<PositionClosedEventArgs> Closed;

Examples

1
2
3
4
5
6
7
8
9
 protected override void OnStart()
  {
      Positions.Closed += OnPositionClosed;
  }
  private void OnPositionClosed(PositionClosedEventArgs args)
  {
      var position = args.Position;
      Print("Position closed with {0} profit", position.GrossProfit);
  }

1
2
3
4
5
 def on_start(self):
     api.Positions.Closed += self.on_position_closed
 def on_position_closed(self, args):
     position = args.Position
     print(f"Position closed with {position.GrossProfit} profit")

Opened

Summary

Occurs each time a position is opened.

Signature 

1
public abstract event Action<PositionOpenedEventArgs> Opened;

Examples

1
2
3
4
5
6
7
8
 protected override void OnStart()
  {
      Positions.Opened += OnPositionOpened;
  }
  private void OnPositionOpened(PositionOpenedEventArgs args)
  {
      Print("Position opened {0}", args.Position.Label);
  }

1
2
3
4
 def on_start(self):
     api.Positions.Opened += self.on_position_opened
 def on_position_opened(self, args):
     print(f"Position opened {args.Position.Label}")

Modified

Summary

Occurs each time a position is modified.

Signature 

1
public abstract event Action<PositionModifiedEventArgs> Modified;