All requests to the Signal API require an API key, and also a system id number. (You can find your trading system's ID number beside the system's name on the main system page.)

Here is an example API request. It tells C2 to SELL SHORT 5 contracts of the June 2015 E-Mini S&P futures contract, at 2099.25 limit. The order is a DAY order:

{
        "apikey":   "1kuBw5575981fsghHuA65756wy8HuAshe",
        "systemid": "89959688",
        "signal":{
                   "action": "SSHORT",
                   "quant": 2,
                   "symbol": "@ESM5",
                   "typeofsymbol": "future",
                   "limit": 2099.25,
                   "duration": "DAY"
                }
}

All C2 responses are well-formed JSON. The response I receive for the example above is:

{
   "ok" : 1,
   "signal" : {
      "market" : "0",
      "signalid" : "94956394",
      "stoploss" : "",
      "comments" : null,
      "day" : "1",
      "systemid" : "89959688",
      "parkUntilYYYYMMDDHHMM" : null,
      "symbol" : "@ESM5",
      "conditionalupon" : null,
      "duration" : "DAY",
      "description" : "E-MINI S&P 500 [CME Chicago Mercantile Exchange]",
      "targetocagroupid" : null,
      "decimalprecision" : "2",
      "expiresat" : "1434057300",
      "pointvalue" : "50",
      "parkUntilSecs" : null,
      "typeofsymbol" : "future",
      "currency" : "USD",
      "quant" : "2",
      "limit" : "2099.25",
      "gtc" : "0",
      "profittarget" : "",
      "action" : "SSHORT",
      "ocaid" : null
   },
   "signalid" : "94956394",
   "elapsed_time" : "0.6114"
}

There are a few important things to notice about the C2 response.

First, C2 tells me whether the API request I made triggered any sort of error, or if it was ok. In this case, the signal request was accepted, because ok was 1.

Notice also that C2 returned a signalid number for me (94956394). This is useful because with this number I can refer to the signal in subsequent calls. For example, I can cancel-replace the order (i.e. change the limit price from 2099.25 to some other value), or cancel it completely. In a later section of this document, I will show you how to use your own signal id numbering scheme, if you choose not to use C2's signal ids.

Finally, notice that C2 echoed back to me in JSON format the signal I created. C2 filled in for my convenience a bunch of information I didn't bother to supply when I created the signal originally (the symbol description, for example, or the point value.)

You can submit market orders, limit orders, or stop orders. Here I submit a market order to buy to open (BTO) 2 shares of IBM stock at the market. The following is a DAY order.

curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
            "systemid": "89959688",
            "signal":{
                       "action": "BTO",
                       "quant": 2,
                       "symbol": "IBM",
                       "typeofsymbol": "stock",
                       "market": 1,
                       "duration": "DAY"
                    }
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/submitSignal'

Here is an order to buy at limit price 12.22, good til cancel (GTC).

curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
            "systemid": "89959688",
            "signal":{
                       "action": "BTO",
                       "quant": 2,
                       "symbol": "IBM",
                       "typeofsymbol": "stock",
                       "limit": 12.22,
                       "duration": "GTC"
                    }
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/submitSignal'

Summary of submitSignal parameters

The two examples above show us some of the parameters you can use when sending signals to C2. However, there are many others:

C2 creates a signalid each time you create a new buy/sell signal. It reports back to you the signalid it created, so that you can refer to the signal again.

However, some programmers might prefer to use their own signalid numbering scheme, and submit a signalid to C2 along with the signal. In these cases, C2 still assigns a global signalid to your signal, but you will be able to refer back to the signal created with either the "local" id you submitted, or the global number C2 creates.

Here is an example of what happens when you use your own signal numbering scheme. Remember, it is completely optional to assign your own signalid numbers. Most programmers will probably want to use the signalids automatically assigned by C2.

	
curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
            "systemid": "89959688",
            "signal":{
                       "action": "BTO",
                       "quant": 2,
                       "symbol": "GOLD",
                       "typeofsymbol": "stock",
                       "limit": 31.05,
                       "duration": "GTC",
                       "signalid":1011
                    }
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/submitSignal'

Here is what C2 returns to the above:

	
{
   "ok" : 1,
   "signal" : {
      "market" : "0",
      "localsignalid" : "1011",
      "stoploss" : "",
      "signalid" : "94958342",
      "comments" : null,
      "day" : "0",
      "systemid" : "89959688",
      "parkUntilYYYYMMDDHHMM" : null,
      "symbol" : "GOLD",
      "conditionalupon" : null,
      "duration" : "GTC",
      "targetocagroupid" : null,
      "expiresat" : "2147483640",
      "pointvalue" : 1,
      "parkUntilSecs" : null,
      "typeofsymbol" : "stock",
      "currency" : "USD",
      "quant" : "2",
      "limit" : "31.05",
      "gtc" : "1",
      "profittarget" : "",
      "action" : "BTO",
      "ocaid" : null
   },
   "signalid" : "1011",
   "elapsed_time" : "0.5497"
}

Once you know a signalid, either by supplying it to C2, or by parsing it out from the JSON C2 returns, it is easy to make a conditional order. A conditional order is an order that becomes valid only once the original (parent) order is traded.

To create a conditional order, include a parameter: conditionalupon. Like this:

	
curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
            "systemid": "89959688",
            "signal":{
                       "action": "STC",
                       "quant": 2,
                       "symbol": "GOLD",
                       "typeofsymbol": "stock",
                       "limit": 39.99,
                       "duration": "GTC",
                       "conditionalupon":1011
                    }
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/submitSignal'

You can construct conditional orders in this way -- that is by referring to a parent order's signalid within the conditionalupon parameter.

There is an alternate way to create conditionals which might please programmers. You can deliver a set of nested JSON, linking parent to child with the conditionalUponSignal parameter. Like this:

	
curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
            "systemid": "89959688",
            "signal":{
                       "action": "STC",
                       "quant": 2,
                       "symbol": "SWY",
                       "typeofsymbol": "stock",
                       "limit": 150,
                       "duration": "DAY",
                       "conditionalUponSignal": { "action": "BTO", "quant": 2, "symbol": "SWY",	"typeofsymbol": "stock", "limit": 22.22, "duration": "DAY" }
                    }
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/submitSignal'

Notice what we did in the example above. We told C2 to create a Sell-to-close order, but make it conditional upon a Buy-to-open.

It's a pain in the ass to create an entry order as a "parent," then two separate conditional child orders: a stop-loss and a profit target. Why not do it all in one swoop? Like this:

		curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
            "systemid": "89959688",
            "signal":{
                       "action": "BTO",
                       "quant": 2,
                       "symbol": "ANN",
                       "typeofsymbol": "stock",
                       "market": 1,
                       "duration": "GTC",
                       "profittarget": "49.25",
                       "stoploss": "40.00"
                    }
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/submitSignal'
	

The response to the example above looks like this:

{
   "ok" : 1,
   "signal" : {
      "market" : "1",
      "profittargetsignalid" : "94958589",
      "signalid" : "94958587",
      "stoploss" : "40.00",
      "comments" : null,
      "day" : "0",
      "systemid" : "89959688",
      "parkUntilYYYYMMDDHHMM" : null,
      "symbol" : "ANN",
      "conditionalupon" : null,
      "duration" : "GTC",
      "targetocagroupid" : "94958588",
      "expiresat" : "2147483640",
      "pointvalue" : 1,
      "parkUntilSecs" : null,
      "typeofsymbol" : "stock",
      "stoplosssignalid" : "94958591",
      "currency" : "USD",
      "ticktime" : "14:46:56t",
      "quant" : "2",
      "gtc" : "1",
      "profittarget" : "49.25",
      "action" : "BTO",
      "ocaid" : null
   },
   "signalid" : "94958587",
   "elapsed_time" : "0.0465"
}
	

A few things to notice about the response above.

The stop loss and profit target are each assigned a separate signalid by C2 (94958589 and 94958591 respectively), and thus can be referred to later. (For example, perhaps you will want to adjust your stop loss?)

You will also notice C2 created a One-Cancels-All (OCA) group(targetocagroupid = 94958588). The profit target and stop loss are both part of the same OCA group. This means that when one is canceled, expired, or traded, the other is canceled.

You can always create your own OCA groups by adding the following parameter to your signal package submitted to C2:

Alternately, if you don't want C2 to automatically group your bracket orders into an OCA group, just include the following parameter in your signal packet:
"forcenooca": 1

Cancel orders like this:

curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
            "systemid": "89959688",
            "signalid":	"94958591"
                    
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/cancelSignal'

	

Here C2 tells us our request to cancel was processed successfully:

{
   "ok" : 1,
   "signal" : {
      "market" : "0",
      "strike" : null,
      "signalid" : "94958591",
      "expir" : null,
      "personid" : "3",
      "underlying" : null,
      "day" : "0",
      "killedwhen" : "0",
      "tradeprice" : "0",
      "expiredwhen" : "0",
      "systemid" : "89959688",
      "symbol" : null,
      "islimit" : "0",
      "tradedwhen" : "0",
      "typeofsymbol" : null,
      "putcall" : null,
      "guid" : "94958591",
      "quant" : "2",
      "gtc" : "1",
      "stop" : "40",
      "postedwhen" : "1434048449",
      "signalexpiresat" : "1528656449",
      "action" : "STC"
   },
   "signalid" : "94958591",
   "title" : "Signal canceled",
   "elapsed_time" : "0.2656",
   "message" : "Signal 94958591 successfully canceled"
}
	

Here is an example of a cancel request that was not successful:

{
   "ok" : 0,
   "signal" : {
      "market" : "1",
      "strike" : null,
      "signalid" : "94958587",
      "expir" : null,
      "personid" : "3",
      "underlying" : null,
      "day" : "0",
      "killedwhen" : "0",
      "tradeprice" : "47.56",
      "expiredwhen" : "0",
      "systemid" : "89959688",
      "symbol" : null,
      "islimit" : null,
      "tradedwhen" : "1434048449",
      "typeofsymbol" : "stock",
      "putcall" : null,
      "guid" : "94958587",
      "quant" : "2",
      "gtc" : "1",
      "stop" : null,
      "postedwhen" : "1434048449",
      "signalexpiresat" : "2147483640",
      "action" : "BTO"
   },
   "signalid" : "94958587",
   "title" : "Signal was traded",
   "elapsed_time" : "0.0032",
   "message" : "Signal could not be canceled"
}
	

It is common to change a working order's price. For instance, you might want to change the limit price of your profit target, which has not yet been reached; or the stop price of not-yet-triggered stop loss. Rather than requiring two steps to achieve this (by first, canceling a specific signal; and second, submitting a replacement order), you can achieve the same functionality in one step, by using the parameter called cancel-and-replace, or xreplace. Like this:

curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
            "systemid": "89959688",
            "signal":{
                       "action": "STC",
                       "quant": 2,
                       "symbol": "GM",
                       "typeofsymbol": "stock",
                       "limit": 46.99,
                       "duration": "GTC",
                       "xreplace": 94932375,
                       "leave_oca_intact": 1
                   }
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/submitSignal'

	

This call returns:

{
   "ok" : 1,
   "signal" : {
      "market" : "0",
      "signalid" : "94959254",
      "stoploss" : "",
      "comments" : null,
      "day" : "0",
      "systemid" : "89959688",
      "parkUntilYYYYMMDDHHMM" : null,
      "symbol" : "GM",
      "conditionalupon" : null,
      "duration" : "GTC",
      "targetocagroupid" : null,
      "expiresat" : "2147483640",
      "pointvalue" : 1,
      "parkUntilSecs" : null,
      "typeofsymbol" : "stock",
      "currency" : "USD",
      "xreplace" : "94932375",
      "quant" : "2",
      "limit" : "46.99",
      "gtc" : "1",
      "profittarget" : "",
      "action" : "STC",
      "ocaid" : null
   },
   "signalid" : "94959254",
   "elapsed_time" : "0.8412"
}
	

Notice the leave_oca_intact parameter. This is optional. If provided, it should be 0 or 1. When set to 1, this tells C2 that, if you are xreplacing a member of an One-Cancels-Another (OCA) group, you should leave the group intact (i.e. do not automatically cancel the sibling order in the OCA group.)

If the signal you are xreplacing is not part of an OCA group, this parameter is ignored.

You can retrieve a list of all strategies for which the API key has real-time access. (This typically means systems you have subscribed to, or which you own.)

curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe"
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/listAllSystems'
	

A typical response might look like this:

{
   "response" : [
      {
         "longDescription" : "And here is my Long description.\n\nI love carriage returns.\n\n",
         "system_id" : "83186981",
         "systemName" : "Your Trading System",
         "monthlyFee" : "11",
         "createdWhen" : "2013-09-26 16:19:23",
         "isAlive" : "1",
         "shortDescription" : "This is my so called \"short\" description, complete with umlaût.",
         "freeTrialPeriodDays" : "22",
         "creatorScreenName" : "MatthewKlein"
      },
            {
         "longDescription" : "Clone of system 84690231 as of Thu Jun 11 08:03:29 2015 ET",
         "system_id" : "94946805",
         "systemName" : "Clone of system 84690231",
         "monthlyFee" : "50",
         "createdWhen" : "2014-01-15 05:13:17",
         "isAlive" : "1",
         "shortDescription" : "Clone of system 84690231 as of Thu Jun 11 08:03:29 2015 ET",
         "freeTrialPeriodDays" : "10",
         "creatorScreenName" : "MatthewKlein"
      },
      {
         "longDescription" : "Zeus takes a position in stocks with the goal of achieving a 5%-10% return within a few days or weeks. All trades have a profits targets posted once the position is open.\nHowever, if you can assume a little more risk than most systems, the system can provide good returns over time.",
         "system_id" : "87753456",
         "systemName" : "ZeusTrade",
         "monthlyFee" : "0",
         "createdWhen" : "2014-05-26 06:50:45",
         "isAlive" : "1",
         "shortDescription" : "Zues specializing in trading stocks and ETFs. ",
         "freeTrialPeriodDays" : "0",
         "creatorScreenName" : "NirKertis2"
      },
      {
         "longDescription" : "This system generates a random trade every minute for futures, stocks, and forex. Use it for testing C2 connectivity or for your own software development purposes. Do not trade it with real money.",
         "system_id" : "1234",
         "systemName" : "C2 Test System (Random)",
         "monthlyFee" : "0",
         "createdWhen" : "2015-06-11 16:22:22",
         "isAlive" : "1",
         "shortDescription" : "This system generates a random trade every minute for futures, stocks, and forex. Use it for testing C2 connectivity or for your own software development purposes. Do not trade it with real money.",
         "freeTrialPeriodDays" : "0",
         "creatorScreenName" : "RandomNumberGenera"
      },
      {
         "longDescription" : null,
         "system_id" : "86425852",
         "systemName" : "Yo Yo Ma",
         "monthlyFee" : "0",
         "createdWhen" : "2014-03-12 10:28:15",
         "isAlive" : "1",
         "shortDescription" : "",
         "freeTrialPeriodDays" : "0",
         "creatorScreenName" : "MatthewKlein"
      }
   ]
}
	

You can retrieve position information about a system like this:

curl -d '{
    "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
    "systemid": "94959200"
 }' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/requestTrades'
	

Alternately to request only open positions, use this:

curl -d '{
    "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
    "systemid": "94959200"
 }' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/requestTradesOpen'
	

The response to either will look something like this:

{
  "response" : 
   [
	   {
	      "closeVWAP_timestamp" : "1434055203",
	      "strike" : "0",
	      "open_or_closed" : "closed",
	      "expir" : "",
	      "openVWAP_timestamp" : "1434055203",
	      "underlying" : "",
	      "closing_price_VWAP" : "45.00000",
	      "putcall" : "",
	      "quant_closed" : "80",
	      "long_or_short" : "long",
	      "markToMarket_time" : "",
	      "trade_id" : "91826329",
	      "symbol" : "GPRO",
	      "opening_price_VWAP" : "56.49000",
	      "quant_opened" : "80",
	      "closedWhen" : "2015-02-09 10:40:08",
	      "instrument" : "stock",
	      "ptValue" : "1",
	      "PL" : "-919",
	      "closedWhenUnixTimeStamp" : "1423496408",
	      "openedWhen" : "2015-01-13 09:48:37",
	      "symbol_description" : "GOPRO INC. CLASS A COMMON STOS"
	   },
	   {
	      "closeVWAP_timestamp" : "1434055203",
	      "strike" : "0",
	      "open_or_closed" : "closed",
	      "expir" : "",
	      "openVWAP_timestamp" : "1434055203",
	      "underlying" : "",
	      "closing_price_VWAP" : "52.74000",
	      "putcall" : "",
	      "long_or_short" : "short",
	      "quant_closed" : "200",
	      "markToMarket_time" : "",
	      "trade_id" : "90607847",
	      "symbol" : "EVR",
	      "opening_price_VWAP" : "50.60000",
	      "quant_opened" : "200",
	      "closedWhen" : "2014-11-18 10:10:41",
	      "instrument" : "stock",
	      "ptValue" : "1",
	      "PL" : "428",
	      "closedWhenUnixTimeStamp" : "1416323441",
	      "openedWhen" : "2014-11-04 12:06:29",
	      "symbol_description" : "EVERCORE PARTNERS"
	   },
	   {
	      "closeVWAP_timestamp" : "1434055203",
	      "strike" : "0",
	      "open_or_closed" : "open",
	      "expir" : "",
	      "openVWAP_timestamp" : "1434055203",
	      "underlying" : "",
	      "closing_price_VWAP" : "56.43",
	      "putcall" : "",
	      "long_or_short" : "long",
	      "quant_closed" : "150",
	      "markToMarket_time" : "2015-06-11 16:40:03",
	      "trade_id" : "94369671",
	      "symbol" : "EWY",
	      "opening_price_VWAP" : "58.23390",
	      "quant_opened" : "250",
	      "closedWhen" : "",
	      "instrument" : "stock",
	      "ptValue" : "1",
	      "PL" : "-451",
	      "closedWhenUnixTimeStamp" : "",
	      "openedWhen" : "2015-05-12 09:38:19",
	      "symbol_description" : "ISHARES MSCI KOREA CAPPED IND"
	   },
	   {
	      "closeVWAP_timestamp" : "1434055204",
	      "strike" : "0",
	      "open_or_closed" : "closed",
	      "expir" : "",
	      "openVWAP_timestamp" : "1434055204",
	      "underlying" : "",
	      "closing_price_VWAP" : "149.30000",
	      "putcall" : "",
	      "long_or_short" : "long",
	      "quant_closed" : "40",
	      "markToMarket_time" : "",
	      "trade_id" : "92028409",
	      "symbol" : "UVXY",
	      "opening_price_VWAP" : "128.01250",
	      "quant_opened" : "40",
	      "closedWhen" : "2015-01-29 10:16:56",
	      "instrument" : "stock",
	      "ptValue" : "1",
	      "PL" : "852",
	      "closedWhenUnixTimeStamp" : "1422544616",
	      "openedWhen" : "2015-01-22 09:30:06",
	      "symbol_description" : "PROSHARES ULTRA VIX SHORT-TERM"
	   }
	]
}

	

You can retrieve all working signals (i.e. signals that have not yet traded, been canceled, or expired) within a system like this:

curl -d '{
    "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
    "systemid": "94959200"
 }' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/retrieveSignalsWorking'
	

A typical response might look like this:

{
   "response" : [
      {
         "isLimitOrder" : "150",
         "symbol" : "SWY",
         "strike" : null,
         "status" : "working",
         "name" : "SAFEWAY",
         "isStopOrder" : null,
         "instrument" : "stock",
         "posted_time_unix" : "1434114076",
         "underlying" : null,
         "isMarketOrder" : "0",
         "tif" : "DAY",
         "putcall" : null,
         "action" : "BTO",
         "expiration" : null,
         "quant" : "1",
         "signal_id" : "94974799",
         "posted_time" : "2015-06-12 09:01:16"
      },
      {
         "isLimitOrder" : "22.22",
         "symbol" : "SWY",
         "strike" : null,
         "status" : "working",
         "name" : "SAFEWAY",
         "isStopOrder" : null,
         "instrument" : "stock",
         "posted_time_unix" : "1434114075",
         "underlying" : null,
         "isMarketOrder" : "0",
         "tif" : "DAY",
         "putcall" : null,
         "action" : "BTO",
         "expiration" : null,
         "quant" : "2",
         "signal_id" : "94974798",
         "posted_time" : "2015-06-12 09:01:15"
      },
      {
         "isLimitOrder" : "39.99",
         "symbol" : "GOLD",
         "strike" : null,
         "status" : "working",
         "name" : "RANDGOLD RESOURCES",
         "isStopOrder" : null,
         "instrument" : "stock",
         "posted_time_unix" : "1434047839",
         "underlying" : null,
         "isMarketOrder" : "0",
         "tif" : "GTC",
         "putcall" : null,
         "action" : "STC",
         "expiration" : null,
         "quant" : "2",
         "signal_id" : "94958448",
         "posted_time" : "2015-06-11 14:37:19"
      }
   ]
}
	

You can retrieve all historical signals ever submitted within a system. Because the response can be quite large, you should filter your request using a time-based filter parameter, like this:

curl -d '{
            "apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
            "systemid": "89959688",
            "filter_type":	"time_posted",
            "filter_date_time_start": "2015-06-11 00:00:00",
            "filter_date_time_end": "2015-06-13 11:00:00"
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/retrieveSignalsAll'
	

A typical response might look like this:

	{
   "response" : [
      {
         "canceled_time_unix" : "0",
         "isLimitOrder" : "150",
         "strike" : null,
         "status" : "working",
         "expired_time_unix" : "0",
         "traded_time" : "",
         "expired_time" : "0",
         "underlying" : null,
         "isMarketOrder" : "0",
         "putcall" : null,
         "tif" : "DAY",
         "expiration" : null,
         "quant" : "1",
         "canceled_time" : "",
         "symbol" : "SWY",
         "name" : "SAFEWAY",
         "isStopOrder" : null,
         "instrument" : "stock",
         "posted_time_unix" : "1434114076",
         "action" : "BTO",
         "traded_time_unix" : "0",
         "signal_id" : "94974799",
         "posted_time" : "2015-06-12 09:01:16"
      },
      {
         "canceled_time_unix" : "0",
         "isLimitOrder" : "22.22",
         "strike" : null,
         "status" : "working",
         "expired_time_unix" : "0",
         "traded_time" : "",
         "expired_time" : "0",
         "underlying" : null,
         "isMarketOrder" : "0",
         "putcall" : null,
         "tif" : "DAY",
         "expiration" : null,
         "quant" : "2",
         "canceled_time" : "",
         "symbol" : "SWY",
         "name" : "SAFEWAY",
         "isStopOrder" : null,
         "instrument" : "stock",
         "posted_time_unix" : "1434114075",
         "action" : "BTO",
         "traded_time_unix" : "0",
         "signal_id" : "94974798",
         "posted_time" : "2015-06-12 09:01:15"
      }
   ]
}
	

Depending on your trading goals, it may be simpler to tell Collective2 which symbols you want to hold in your C2 Model Account portfolio, and how large to make each position, rather than delivering specific buy and sell "signals."

If you use our Position Maintenance API, Collective2 will be responsible for placing whatever individual buy and sell signals are required to make your Model Account have only the positions you desire. C2 will use market orders -- only when relevant markets are open -- to achieve the position goals you set. See below for examples of how you can set (and get) your system's desired positions.

Each call to setDesiredPositions must include a list of hash elements (i.e. a list of associative arrays). Each hash element contains: symbol, typeofsymbol, and quant. Positive quantities are long positions. Negative quantities are short positions. (Note the exception, below: a special type of element denoting an empty portfolio with no positions whatsoever.)

Here is an example of how you can call setDesiredPositions:

curl -d '{
"apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
"systemid": "94679653",
"positions": 	[
					{ 
						"symbol"		: "@ESM5",
						"typeofsymbol"	: "future",
						"quant"			: "-4"
					},
					{
						"symbol"		: "EURUSD",
						"typeofsymbol"	: "forex",
						"quant"			: "-3"
					},
					{
						"symbol"		: "AAPL",
						"typeofsymbol"	: "stock",
						"quant"			: "211"
					}

				]
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/setDesiredPositions'

	

This call returns:

{
    "response": [
        {
            "underlying": null,
            "symbol": "EURUSD",
            "putcall": null,
            "strike": null,
            "typeofsymbol": "forex",
            "quant": "-3",
            "expir": null
        },
        {
            "underlying": null,
            "symbol": "@ESM5",
            "putcall": null,
            "strike": null,
            "typeofsymbol": "future",
            "quant": "-4",
            "expir": null
        },
        {
            "underlying": null,
            "symbol": "AAPL",
            "putcall": null,
            "strike": null,
            "typeofsymbol": "stock",
            "quant": "211",
            "expir": null
        }
    ]
}
	

Here is how you tell setDesiredPositions that you want no positions within a strategy:

curl -d '{
"apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
"systemid": "94679653",
"positions": 	[
					{ 
						"symbol"  : "flat",
						"typeofsymbol"  : "flat",
						"quant"  : "0"
					}

				]
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/setDesiredPositions'

	

Here is how you tell setDesiredPositions to stop automatically maintaining positions. Note that this is different than telling C2 to maintain a flat position.

curl -d '{
"apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
"systemid": "94679653",
"positions": 	[
					{ 
						"symbol"			: "stop",
						"typeofsymbol"	: "stop",
						"quant"			: "0"
					}

				]
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/setDesiredPositions'

	

You can query your strategy's desired positions. Note that the information returned here will be whichever data you most recently sent via setDesiredPositions. This does not necessarily return a strategy's current positions. For that, see Retrieving open and closed position information.

Here is an example of how you can call getDesiredPositions:

curl -d '{
"apikey":   "1kuBwZmJpHHHgJAHFSYGYFSYGHf1nvOV4hSGPWVwy8HuAshe",
"systemid": "94679653"
}' -H "Content-Type: application/json" 'https://collective2.com/world/apiv3/getDesiredPositions'

	

This call returns:

{
    "response": [
        {
            "underlying": null,
            "symbol": "EURUSD",
            "putcall": null,
            "strike": null,
            "typeofsymbol": "forex",
            "quant": "-3",
            "expir": null
        },
        {
            "underlying": null,
            "symbol": "@ESM5",
            "putcall": null,
            "strike": null,
            "typeofsymbol": "future",
            "quant": "-4",
            "expir": null
        },
        {
            "underlying": null,
            "symbol": "AAPL",
            "putcall": null,
            "strike": null,
            "typeofsymbol": "stock",
            "quant": "211",
            "expir": null
        }
    ]
}