{"_id":"569443761005590d0062cacc","project":"563cc7119799fb0d00047685","user":"563cc6fa8894d20d00014ea3","version":{"_id":"563cc7119799fb0d00047688","__v":17,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"__v":0,"parentDoc":null,"category":{"_id":"56940bc2d8c04d1700e5adb6","__v":8,"pages":["56940ce773f48f0d0075c9df","56941dd246b943190027fdf8","5694325e5f1c951900644d0a","569443761005590d0062cacc","5694450e46b943190027fe45","569511bcfe18811700c9bf59","56951873dcaf0d1700cb86a3","56951a76caa32519009c40f4"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-11T20:08:34.666Z","from_sync":false,"order":5,"slug":"orders","title":"Orders"},"editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-12T00:06:14.463Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"New","code":"/*\nA limit order is successfully accepted when:\n\n1. \"orderQty\" is equal to \"leavesQty\".\n2. \"execType\" and \"ordStatus\" are both equal to \"0\".\n*/\n\n{\n    \"orderID\": \"DA.84a01e35-b69d-4522-bab3-cf2e9c58f932\",\n    \"accountID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456\",\n    \"userID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"cumQty\": 0,\n    \"accountNo\": \"DWTE000005\",\n    \"commission\": 0,\n    \"createdByID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"createdWhen\": \"2016-01-11T23:54:20.336Z\",\n    \"execType\": \"0\",\n    \"grossTradeAmt\": 0,\n    \"instrumentID\": \"675cc7c2-e24b-42fa-9d1f-4b3a97ae8d2f\",\n    \"lastPx\": 0,\n    \"lastQty\": 0,\n    \"leavesQty\": 9,\n    \"orderNo\": \"DAET000027\",\n    \"orderQty\": 9,\n    \"ordStatus\": \"0\",\n    \"ordType\": \"2\",\n    \"price\": 0,\n    \"rateAsk\": 0,\n    \"rateBid\": 0,\n    \"side\": \"B\",\n    \"accountType\": 2,\n    \"autoStop\": 0,\n    \"limitPrice\": 5.5,\n    \"timeInForce\": \"0\",\n    \"isoTimeRestingOrderExpires\": \"2016-01-12T21:00:00.000Z\",\n    \"internalMemo\": \"OGW ACH\",\n    \"amountCash\": 0\n}","language":"json","status":200},{"name":"Executed","status":200,"language":"json","code":"/*\nA limit order is successfully executed when:\n\n1. \"orderQty\" is equal to \"cumQty\".\n2. \"execType\" and \"ordStatus\" are both equal to \"2\".\n*/\n\n{\n    \"orderID\": \"DA.84a01e35-b69d-4522-bab3-cf2e9c58f932\",\n    \"accountID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456\",\n    \"userID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"cumQty\": 9,\n    \"accountNo\": \"DWTE000005\",\n    \"commission\": 0,\n    \"createdByID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"createdWhen\": \"2016-01-11T23:54:20.336Z\",\n    \"execType\": \"0\",\n    \"grossTradeAmt\": 0,\n    \"instrumentID\": \"675cc7c2-e24b-42fa-9d1f-4b3a97ae8d2f\",\n    \"lastPx\": 0,\n    \"lastQty\": 0,\n    \"leavesQty\": 0,\n    \"orderNo\": \"DAET000027\",\n    \"orderQty\": 9,\n    \"ordStatus\": \"0\",\n    \"ordType\": \"2\",\n    \"price\": 0,\n    \"rateAsk\": 0,\n    \"rateBid\": 0,\n    \"side\": \"B\",\n    \"accountType\": 2,\n    \"autoStop\": 0,\n    \"limitPrice\": 5.5,\n    \"timeInForce\": \"0\",\n    \"isoTimeRestingOrderExpires\": \"2016-01-12T21:00:00.000Z\",\n    \"internalMemo\": \"OGW ACH\",\n    \"amountCash\": 0\n}"},{"name":"Cancelled","code":"/*\nA limit order is successfully cancelled when:\n\n1. \"orderQty\" is equal to \"leavesQty\".\n2. \"execType\" and \"ordStatus\" are both equal to \"4\".\n*/\n\n{\n    \"orderID\": \"DA.84a01e35-b69d-4522-bab3-cf2e9c58f932\",\n    \"accountID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456\",\n    \"userID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"cumQty\": 9,\n    \"accountNo\": \"DWTE000005\",\n    \"commission\": 0,\n    \"createdByID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"createdWhen\": \"2016-01-11T23:54:20.336Z\",\n    \"execType\": \"0\",\n    \"grossTradeAmt\": 0,\n    \"instrumentID\": \"675cc7c2-e24b-42fa-9d1f-4b3a97ae8d2f\",\n    \"lastPx\": 0,\n    \"lastQty\": 0,\n    \"leavesQty\": 9,\n    \"orderNo\": \"DAET000027\",\n    \"orderQty\": 9,\n    \"ordStatus\": \"0\",\n    \"ordType\": \"2\",\n    \"price\": 0,\n    \"rateAsk\": 0,\n    \"rateBid\": 0,\n    \"side\": \"B\",\n    \"accountType\": 2,\n    \"autoStop\": 0,\n    \"limitPrice\": 5.5,\n    \"timeInForce\": \"0\",\n    \"isoTimeRestingOrderExpires\": \"2016-01-12T21:00:00.000Z\",\n    \"internalMemo\": \"OGW ACH\",\n    \"amountCash\": 0\n}","language":"json","status":200},{"status":200,"name":"Rejected","code":"/*\nA limit order is rejected when:\n\n1. \"leavestQty\" is equal to \"0\".\n2. \"execType\" and \"ordStatus\" are both equal to \"8\".\n3. \"ordRejReason\" will be present with reason. E.g. \"0202 Specified orderQty is invalid.\".\n*/\n\n{\n    \"orderID\": \"DA.84a01e35-b69d-4522-bab3-cf2e9c58f932\",\n    \"accountID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456\",\n    \"userID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"cumQty\": 0,\n    \"accountNo\": \"DWTE000005\",\n    \"commission\": 0,\n    \"closedWhen\": \"2016-01-12T00:03:32.187Z\",\n    \"createdByID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5\",\n    \"createdWhen\": \"2016-01-12T00:03:32.187Z\",\n    \"execType\": \"8\",\n    \"grossTradeAmt\": 0,\n    \"instrumentID\": \"675cc7c2-e24b-42fa-9d1f-4b3a97ae8d2f\",\n    \"lastPx\": 0,\n    \"lastQty\": 0,\n    \"leavesQty\": 0,\n    \"orderNo\": \"DAET000027\",\n    \"orderQty\": 900000,\n    \"ordRejReason\": \"0202 Specified orderQty is invalid.\",\n    \"ordStatus\": \"8\",\n    \"ordType\": \"2\",\n    \"price\": 0,\n    \"rateAsk\": 0,\n    \"rateBid\": 0,\n    \"side\": \"B\",\n    \"accountType\": 2,\n    \"autoStop\": 0,\n    \"limitPrice\": 5.5,\n    \"timeInForce\": \"0\",\n    \"isoTimeRestingOrderExpires\": \"2016-01-12T21:00:00.000Z\",\n    \"internalMemo\": \"OGW ACH\",\n    \"amountCash\": 0\n}","language":"json"}]},"settings":"","examples":{"codes":[{"language":"http","code":"GET /v1/orders/DA.84a01e35-b69d-4522-bab3-cf2e9c58f932 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-13T22:34:53.101Z"},{"language":"curl","code":"curl -X GET -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"x-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z\" 'http://api.drivewealth.io/v1/orders/DA.84a01e35-b69d-4522-bab3-cf2e9c58f932'"}]},"method":"get","auth":"required","params":[{"_id":"56940ce773f48f0d0075c9e0","ref":"","in":"path","required":true,"desc":"Order ID.","default":"DA.84a01e35-b69d-4522-bab3-cf2e9c58f932","type":"string","name":"orderID"}],"url":"/orders/:orderID"},"isReference":true,"order":5,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Limit Order Information Only\",\n  \"body\": \"Even though this endpoint supports three order types (Market, Stop and Limit), this page is just for details on a limit order.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nEvery limit order will return a single order object and have a default list of attributes.\n\n|Attribute|Description|\n|---|---|---|---|\n| `orderID`|Order ID.|\n| `accountID`|User's account ID.|\n| `userID`|User's user ID.|\n| `cumQty`|Cumulative quantity filled.|\n| `accountNo`|Account number.|\n| `comment`|User generated comment.|\n| `commission`|Commission charged, will be `0`.|\n| `createdByID`|User ID of order.|\n| `createdWhen`|Date/time order was created.|\n| `execType`|Execution type: `\"0\"` - New, `\"1\"` - Partial Fill, `\"2\"` - Fill, `\"4\"` - Canceled, `\"8\"` - Rejected.|\n| `grossTradeAmt`|Gross trade amount, will be `0`.|\n| `instrumentID`|Instrument ID.|\n| `leavesQty`|Quantity to be filled.|\n| `orderNo`|Order number.|\n| `orderQty`|Number of shares.|\n| `ordRejReason`| Only displays if the order is rejected.  See [Common Order Gateway Error Codes](doc:common-order-gateway-error-codes) for rejected reason.\n| `ordStatus`|Order status: `\"0\"` - New, `\"1\"` - Partial Fill, `\"2\"` - Fill, `\"4\"` - Canceled, `\"8\"` - Rejected.|\n| `ordType`|Order type: set to `\"3\"`.|\n| `price`|Stop order price to be executed.|\n| `side`|Side of order: `\"B\"` - Buy or `\"S\"` - Sell.|\n| `accountType`|Account type: `\"1\"` - Live or `\"2\"` - Practice.|\n| `timeInForce`|Always set to `\"0\"` - good for day only.|\n| `isoTimeRestingOrderExpires`|Expiration of limit order in UTC format.|\n| `limitPrice`|Price of limit.|\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Limit Order Notes\"\n}\n[/block]\n#### New Limit Order\nA limit order is successfully accepted when:\n\n1. `orderQty` is equal to `leavesQty`.\n2. `execType` and `ordStatus` are both equal to `\"0\"`.\n\n#### Executed Limit Order\nAn executed limit order is successfully when:\n\n1. `orderQty` is equal to `cumQty`.\n2. `execType` and `ordStatus` are both equal to `\"2\"`.\n\n#### Cancelled Limit Order\nA limit order is cancelled when:\n\n1. `orderQty` is equal to `leavesQty`.\n2. `execType` and `ordStatus` are both equal to `\"4\"`.\n\n#### Rejected Limit Order\nA limit order is rejected when:\n\n1. `leavestQty` is equal to `0`.\n2. `execType` and `ordStatus` are both equal to `\"8\"`.\n3. `ordRejReason` will be present with reason. E.g. `\"0202 Specified orderQty is invalid.\"`.","excerpt":"Get the status on a given order.","slug":"get-limit-order","type":"endpoint","title":"Order Status (Limit Order)"}

getOrder Status (Limit Order)

Get the status on a given order.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

orderID:
required
stringDA.84a01e35-b69d-4522-bab3-cf2e9c58f932
Order ID.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Limit Order Information Only", "body": "Even though this endpoint supports three order types (Market, Stop and Limit), this page is just for details on a limit order." } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] Every limit order will return a single order object and have a default list of attributes. |Attribute|Description| |---|---|---|---| | `orderID`|Order ID.| | `accountID`|User's account ID.| | `userID`|User's user ID.| | `cumQty`|Cumulative quantity filled.| | `accountNo`|Account number.| | `comment`|User generated comment.| | `commission`|Commission charged, will be `0`.| | `createdByID`|User ID of order.| | `createdWhen`|Date/time order was created.| | `execType`|Execution type: `"0"` - New, `"1"` - Partial Fill, `"2"` - Fill, `"4"` - Canceled, `"8"` - Rejected.| | `grossTradeAmt`|Gross trade amount, will be `0`.| | `instrumentID`|Instrument ID.| | `leavesQty`|Quantity to be filled.| | `orderNo`|Order number.| | `orderQty`|Number of shares.| | `ordRejReason`| Only displays if the order is rejected. See [Common Order Gateway Error Codes](doc:common-order-gateway-error-codes) for rejected reason. | `ordStatus`|Order status: `"0"` - New, `"1"` - Partial Fill, `"2"` - Fill, `"4"` - Canceled, `"8"` - Rejected.| | `ordType`|Order type: set to `"3"`.| | `price`|Stop order price to be executed.| | `side`|Side of order: `"B"` - Buy or `"S"` - Sell.| | `accountType`|Account type: `"1"` - Live or `"2"` - Practice.| | `timeInForce`|Always set to `"0"` - good for day only.| | `isoTimeRestingOrderExpires`|Expiration of limit order in UTC format.| | `limitPrice`|Price of limit.| [block:api-header] { "type": "basic", "title": "Limit Order Notes" } [/block] #### New Limit Order A limit order is successfully accepted when: 1. `orderQty` is equal to `leavesQty`. 2. `execType` and `ordStatus` are both equal to `"0"`. #### Executed Limit Order An executed limit order is successfully when: 1. `orderQty` is equal to `cumQty`. 2. `execType` and `ordStatus` are both equal to `"2"`. #### Cancelled Limit Order A limit order is cancelled when: 1. `orderQty` is equal to `leavesQty`. 2. `execType` and `ordStatus` are both equal to `"4"`. #### Rejected Limit Order A limit order is rejected when: 1. `leavestQty` is equal to `0`. 2. `execType` and `ordStatus` are both equal to `"8"`. 3. `ordRejReason` will be present with reason. E.g. `"0202 Specified orderQty is invalid."`.

User Information

Try It Out

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