{"_id":"596f729c8ec0a3003882d935","project":"563cc7119799fb0d00047685","version":{"_id":"563cc7119799fb0d00047688","__v":18,"project":"563cc7119799fb0d00047685","createdAt":"2015-11-06T15:28:17.683Z","releaseDate":"2015-11-06T15:28:17.683Z","categories":["563cc7129799fb0d00047689","566f37f37ffa002300c3cd5b","56914e9bd47b020d002225ac","5692b19ffe72e00d00e4f0a8","56940bc2d8c04d1700e5adb6","56940bc83e9d080d00f064f0","56951b2dfcb1032d0089df7a","569522aecaa32519009c410c","569523ce562335190016da97","569523fddcaf0d1700cb86bf","56980e4a8560a60d00e2c3c3","569921a41693520d002e1305","5699323b7465970d00650b82","569e6cc4fbee990d0072d927","56a2768a0aefae0d00b7fe66","5862e862b8b7fa23009665b7","592835c7bc8bca0f000cc9ff","596f693df43cca002e690e1c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"category":{"_id":"596f693df43cca002e690e1c","project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-07-19T14:14:21.484Z","from_sync":false,"order":6,"slug":"algorithmic-orders","title":"Algorithmic Orders"},"user":"569574eccaa32519009c4202","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-19T14:54:20.091Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"New","code":"{\n    \"orderID\": \"EG.4e84e780-eca7-42eb-91b2-86c861af0f25\",\n    \"instrumentID\": \"4bbc7ecc-f232-46a8-9247-0e9c3f74a932\",\n    \"leavesQty\": 100,\n    \"orderNo\": \"EGVA000199\",\n    \"ordType\": \"1\",\n    \"side\": \"B\",\n    \"limitPrice\": 0,\n    \"timeInForce\": \"0\",\n    \"expireTimestamp\": \"2017-07-19T20:00:00.000Z\",\n    \"commissionDesc\": \"Standard Commission\",\n    \"statusPath\": \"/v1/orders/EG.4e84e780-eca7-42eb-91b2-86c861af0f25\"\n}","language":"json","status":200},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"message\": \"Invalid value: instrumentID\"\n}"},{"code":"{\n    \"code\": 401,\n    \"message\": \"Client may not send special order types\"\n}","language":"text","status":401}]},"method":"post","examples":{"codes":[{"code":"POST /v1/orders HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json\nx-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-20T20:50:48.680Z\n\n{\n    \"accountID\":\"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456\",\n    \"accountNo\":\"DWTE000005\",\n    \"userID\":\"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"accountType\":2,\n    \"ordType\":\"1\",\n    \"side\":\"B\",\n    \"instrumentID\":\"4bbc7ecc-f232-46a8-9247-0e9c3f74a932\",\n    \"orderQty\":100,\n    \"comment\":\"POV Order\",\n    \"executionAlgorithm\": \"POV\",\n    \"strategyStart\": \"2017-07-12T13:30:00Z\",\n    \"strategyEnd\": \"2017-07-12T20:00:00Z\",\n    \"povTargetPercentVolume\": \"50\",\n    \"completionPrice\": \"10.01\",\n}","language":"http"},{"language":"curl","code":"curl -X POST -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"x-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-20T20:50:48.680Z\" -d '{\n    \"accountID\":\"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456\",\n    \"accountNo\":\"DWTE000005\",\n    \"userID\":\"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"accountType\":2,\n    \"ordType\":\"1\",\n    \"side\":\"B\",\n    \"instrumentID\":\"4bbc7ecc-f232-46a8-9247-0e9c3f74a932\",\n    \"orderQty\":100,\n    \"comment\":\"POV Order\",\n    \"executionAlgorithm\": \"POV\",\n    \"strategyStart\": \"2017-07-12T13:30:00Z\",\n    \"strategyEnd\": \"2017-07-12T20:00:00Z\",\n    \"povTargetPercentVolume\": \"50\",\n    \"completionPrice\": \"10.01\",\n}' \"http://api.drivewealth.io/v1/orders\""}]},"auth":"required","params":[{"_id":"56940ce773f48f0d0075c9e0","ref":"","in":"body","required":true,"desc":"Instrument ID.","default":"4bbc7ecc-f232-46a8-9247-0e9c3f74a932","type":"string","name":"instrumentID"},{"_id":"569511bcfe18811700c9bf62","ref":"","in":"body","required":true,"desc":"Account ID.","default":"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456","type":"string","name":"accountID"},{"_id":"569511bcfe18811700c9bf61","ref":"","in":"body","required":true,"desc":"Account Number.","default":"DWTE000005","type":"string","name":"accountNo"},{"_id":"569511bcfe18811700c9bf60","ref":"","in":"body","required":true,"desc":"User ID.","default":"02e57c7d-d071-4c63-b491-1194a9939ea5","type":"string","name":"userID"},{"_id":"569511bcfe18811700c9bf5f","ref":"","in":"body","required":true,"desc":"Type of account: `\"1\"` - Practice or `\"2\"` - Live.","default":"2","type":"int","name":"accountType"},{"_id":"569511bcfe18811700c9bf5e","ref":"","in":"body","required":true,"desc":"Type of order: `\"1\"` - Market order. May only be type `\"1\"`.","default":"1","type":"string","name":"ordType"},{"_id":"569511bcfe18811700c9bf5d","ref":"","in":"body","required":true,"desc":"Side of order: `\"B\"` - Buy or `\"S\"` - Sell.","default":"B","type":"string","name":"side"},{"_id":"569511bcfe18811700c9bf5c","ref":"","in":"body","required":true,"desc":"Number of whole shares.  Decimals (fractional shares) not allowed with this order type.","default":"1","type":"int","name":"orderQty"},{"_id":"569511bcfe18811700c9bf5b","ref":"","in":"body","required":true,"desc":"POV Order","default":"POV Order","type":"string","name":"comment"},{"_id":"596f6369961b68002030d699","ref":"","in":"body","required":true,"desc":"Algorithm Order Type.","default":"POV","type":"string","name":"executionAlgorithm"},{"_id":"596f6369961b68002030d698","ref":"","in":"body","required":true,"desc":"Time the strategy begins to enter into the market.","default":"2017-07-12T13:30:00Z","type":"string","name":"strategyStart"},{"_id":"596f6369961b68002030d697","ref":"","in":"body","required":true,"desc":"Time the strategy is to be completed by.","default":"2017-07-12T20:00:00Z","type":"string","name":"strategyEnd"},{"_id":"596f6369961b68002030d694","ref":"","in":"body","required":true,"desc":"Indicates % of market volume to follow.","default":"1-50","type":"string","name":"povTargetPercentVolume"},{"_id":"596f6369961b68002030d693","ref":"","in":"body","required":true,"desc":"Price at which to activate “complete order” logic.","default":"100","type":"string","name":"completionPrice"}],"url":"/orders/"},"isReference":false,"order":2,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nThe response will contain a single order object and is successfully accepted when there is a response (see \"Result Format\"). To get status of this order, see [Get - Market Order](doc:get_market).\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`orderID`\",\n    \"1-0\": \"`instrumentID`\",\n    \"2-0\": \"`leavesQty`\",\n    \"4-0\": \"`ordType`\",\n    \"5-0\": \"`side`\",\n    \"8-0\": \"`ordStatus`\",\n    \"9-0\": \"`expireTimestamp`\",\n    \"0-1\": \"Order ID that will be used to query it's status via [Get - Market Order](doc:get_market).\",\n    \"1-1\": \"Instrument ID.\",\n    \"2-1\": \"Quantity still needing to be executed. will always be the requested order quantity in response.\",\n    \"4-1\": \"Type of order: `\\\"1\\\"` - market order.\",\n    \"5-1\": \"Order side: either `\\\"B\\\"` - Buy or `\\\"S\\\"` - Sell.\",\n    \"8-1\": \"Order status. Will always be `\\\"0\\\"` to response.\",\n    \"9-1\": \"ISO time stamp of when the order will expire.\",\n    \"10-0\": \"`statusPath`\",\n    \"10-1\": \"Path to check status of order\",\n    \"3-0\": \"`orderNo`\",\n    \"3-1\": \"Order Number.\",\n    \"6-0\": \"`limitPrice`\",\n    \"6-1\": \"Limit Price.  Will always be `\\\"0\\\"` to response.\",\n    \"7-0\": \"`timeInForce`\",\n    \"7-1\": \"Time the order is in force, `\\\"0\\\"` - Day, `\\\"1\\\"` - GTC.\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"The order will be rejected if:\\n•\\tThe order specifies cash rather than order quantity\\n•\\tThe order quantity has a fractional component\\n•\\tThe order type is anything other than Market\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Use of Algorithmic Order Types requires specific authorization.  Contact your sales representative for more information.\"\n}\n[/block]","excerpt":"Add a new POV (Volume Participation) order.  Tracks volume from the time the order starts trading and trades according to the specified target participation percentage. Continuous optimizations are made as the order trades to target optimal price and liquidity goals.","slug":"create-order-pov-algo-order","type":"endpoint","title":"Create Order (POV Algo Order)"}

postCreate Order (POV Algo Order)

Add a new POV (Volume Participation) order. Tracks volume from the time the order starts trading and trades according to the specified target participation percentage. Continuous optimizations are made as the order trades to target optimal price and liquidity goals.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

instrumentID:
required
string4bbc7ecc-f232-46a8-9247-0e9c3f74a932
Instrument ID.
accountID:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456
Account ID.
accountNo:
required
stringDWTE000005
Account Number.
userID:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5
User ID.
accountType:
required
integer2
Type of account: `"1"` - Practice or `"2"` - Live.
ordType:
required
string1
Type of order: `"1"` - Market order. May only be type `"1"`.
side:
required
stringB
Side of order: `"B"` - Buy or `"S"` - Sell.
orderQty:
required
integer1
Number of whole shares. Decimals (fractional shares) not allowed with this order type.
comment:
required
stringPOV Order
POV Order
executionAlgorithm:
required
stringPOV
Algorithm Order Type.
strategyStart:
required
string2017-07-12T13:30:00Z
Time the strategy begins to enter into the market.
strategyEnd:
required
string2017-07-12T20:00:00Z
Time the strategy is to be completed by.
povTargetPercentVolume:
required
string1-50
Indicates % of market volume to follow.
completionPrice:
required
string100
Price at which to activate “complete order” logic.

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response" } [/block] The response will contain a single order object and is successfully accepted when there is a response (see "Result Format"). To get status of this order, see [Get - Market Order](doc:get_market). [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`orderID`", "1-0": "`instrumentID`", "2-0": "`leavesQty`", "4-0": "`ordType`", "5-0": "`side`", "8-0": "`ordStatus`", "9-0": "`expireTimestamp`", "0-1": "Order ID that will be used to query it's status via [Get - Market Order](doc:get_market).", "1-1": "Instrument ID.", "2-1": "Quantity still needing to be executed. will always be the requested order quantity in response.", "4-1": "Type of order: `\"1\"` - market order.", "5-1": "Order side: either `\"B\"` - Buy or `\"S\"` - Sell.", "8-1": "Order status. Will always be `\"0\"` to response.", "9-1": "ISO time stamp of when the order will expire.", "10-0": "`statusPath`", "10-1": "Path to check status of order", "3-0": "`orderNo`", "3-1": "Order Number.", "6-0": "`limitPrice`", "6-1": "Limit Price. Will always be `\"0\"` to response.", "7-0": "`timeInForce`", "7-1": "Time the order is in force, `\"0\"` - Day, `\"1\"` - GTC." }, "cols": 2, "rows": 11 } [/block] [block:callout] { "type": "danger", "body": "The order will be rejected if:\n•\tThe order specifies cash rather than order quantity\n•\tThe order quantity has a fractional component\n•\tThe order type is anything other than Market" } [/block] [block:callout] { "type": "warning", "body": "Use of Algorithmic Order Types requires specific authorization. Contact your sales representative for more information." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}