{"__v":3,"_id":"5694070ebcd0a90d0044d2a6","category":{"__v":7,"_id":"56914e9bd47b020d002225ac","pages":["5691500e3c4f510d00ec9baa","5691543972f2810d007e4cc1","5692a6d74c4d6d0d00f7cb4b","5694070ebcd0a90d0044d2a6","56952386fcb1032d0089df94","5695238fcaa32519009c4114","569923123da4370d009d20c9"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-09T18:16:59.760Z","from_sync":false,"order":1,"slug":"rest-api","title":"Accounts"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"563cc7119799fb0d00047685","user":"563cc6fa8894d20d00014ea3","version":{"__v":16,"_id":"563cc7119799fb0d00047688","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-11T19:48:30.744Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"http","code":"GET /v1/users/02e57c7d-d071-4c63-b491-1194a9939ea5/accountSummary/02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456 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"},{"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\" 'https://api.drivewealth.io/v1/users/02e57c7d-d071-4c63-b491-1194a9939ea5/accountSummary/02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456'","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"accountID\": \"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456\",\n    \"accountNo\": \"DWTE000005\",\n  \t\"tradingType\": \"CASH\",\n    \"lastUpdated\": \"2016-02-03T17:14:24.786Z\",\n   \t\"cash\": {\n        \"cashAvailableForTrade\": 20905.94,\n        \"cashAvailableForWithdrawal\": 20905.94,\n        \"cashBalance\": 20905.94\n    },\n    \"equity\": {\n        \"equityValue\": 4231.45,\n        \"equityPositions\": [\n            {\n                \"symbol\": \"BABA\",\n                \"instrumentID\": \"90b7618e-be49-483b-99f4-fe4720be2706\",\n                \"openQty\": 0.5,\n                \"costBasis\": 31.53,\n                \"marketValue\": 31.55,\n                \"side\": \"B\",\n                \"priorClose\": 65.06,\n                \"availableForTradingQty\": 0.5,\n                \"avgPrice\": 63.06,\n                \"mktPrice\": 63.1,\n                \"unrealizedPL\": 0.02,\n                \"unrealizedDayPLPercent\": 0.06,\n                \"unrealizedDayPL\": 0.02\n            },\n            {\n                \"symbol\": \"AMZN\",\n                \"instrumentID\": \"06926627-e950-48f3-9c53-b679f61120ec\",\n                \"openQty\": 0.81,\n                \"costBasis\": 436.31,\n                \"marketValue\": 432.61,\n                \"side\": \"B\",\n                \"priorClose\": 551.66,\n                \"availableForTradingQty\": 0.81,\n                \"avgPrice\": 538.66,\n                \"mktPrice\": 534.09,\n                \"unrealizedPL\": -3.7,\n                \"unrealizedDayPLPercent\": -0.85,\n                \"unrealizedDayPL\": -3.7\n            },\n            {\n                \"symbol\": \"GOOG\",\n                \"instrumentID\": \"68277cc0-6106-4f3c-849b-1298ba964aba\",\n                \"openQty\": 0.304,\n                \"costBasis\": 225.96,\n                \"marketValue\": 224.18,\n                \"side\": \"B\",\n                \"priorClose\": 765.16,\n                \"availableForTradingQty\": 0.154,\n                \"avgPrice\": 743.29,\n                \"mktPrice\": 737.43,\n                \"unrealizedPL\": -1.78,\n                \"unrealizedDayPLPercent\": -0.79,\n                \"unrealizedDayPL\": -1.78\n            },\n            {\n                \"symbol\": \"KO\",\n                \"instrumentID\": \"c771f9bc-a745-4d66-bcf3-bed0d2749aac\",\n                \"openQty\": 11.8122,\n                \"costBasis\": 499.89,\n                \"marketValue\": 501.55,\n                \"side\": \"B\",\n                \"priorClose\": 42.44,\n                \"availableForTradingQty\": 11.8122,\n                \"avgPrice\": 42.32,\n                \"mktPrice\": 42.46,\n                \"unrealizedPL\": 1.66,\n                \"unrealizedDayPLPercent\": 0.05,\n                \"unrealizedDayPL\": 0.24\n            },\n            {\n                \"symbol\": \"ACH\",\n                \"instrumentID\": \"675cc7c2-e24b-42fa-9d1f-4b3a97ae8d2f\",\n                \"openQty\": 370,\n                \"costBasis\": 2778.7,\n                \"marketValue\": 2967.4,\n                \"side\": \"B\",\n                \"priorClose\": 7.54,\n                \"availableForTradingQty\": 370,\n                \"avgPrice\": 7.51,\n                \"mktPrice\": 8.02,\n                \"unrealizedPL\": 188.7,\n                \"unrealizedDayPLPercent\": 6.37,\n                \"unrealizedDayPL\": 177.6\n            },\n            {\n                \"symbol\": \"CAR\",\n                \"instrumentID\": \"72c7ccde-af52-46ce-800b-99e5121baa5e\",\n                \"openQty\": 3,\n                \"costBasis\": 77.55,\n                \"marketValue\": 74.16,\n                \"side\": \"B\",\n                \"priorClose\": 24.29,\n                \"availableForTradingQty\": 3,\n                \"avgPrice\": 25.85,\n                \"mktPrice\": 24.72,\n                \"unrealizedPL\": -3.39,\n                \"unrealizedDayPLPercent\": 1.77,\n                \"unrealizedDayPL\": 1.29\n            }\n        ]\n    },\n    \"orders\": [\n        {\n            \"orderID\": \"DB.bbcc8c6e-0c78-4b93-bc2e-1b25fe2ba87f\",\n            \"orderNo\": \"DBAZ000011\",\n            \"createdWhen\": \"2016-02-03T17:14:21.938Z\",\n            \"symbol\": \"GOOG\",\n            \"cumQty\": 0,\n            \"orderStatus\": \"0\",\n            \"orderType\": \"3\",\n            \"orderQty\": 0.15,\n            \"limitPrice\": 0,\n            \"side\": \"S\",\n            \"orderCashAmt\": 0,\n            \"stopPrice\": 650\n        }\n    ],\n    \"transactions\": [\n        {\n            \"orderId\": \"DB.24ced443-a948-4ab7-b89b-c22c2df18bfa\",\n            \"orderNo\": \"DBAJ000025\",\n            \"symbol\": \"AMZN\",\n            \"cumQty\": 0.81,\n            \"orderStatus\": \"2\",\n            \"orderType\": \"1\",\n            \"orderQty\": 0.81,\n            \"limitPrice\": 0,\n            \"stopPrice\": 0,\n            \"executedPrice\": 538.65,\n            \"side\": \"B\",\n            \"createdWhen\": \"2016-02-03T17:02:28.520Z\",\n            \"updatedWhen\": \"2016-02-03T17:02:29.515Z\",\n            \"updatedReason\": \"market_order-buy-filled\",\n            \"commission\": 0.99,\n            \"isoTimeRestingOrderExpires\": \"2016-02-03T21:00:00.000Z\",\n            \"executedWhen\": \"2016-02-03T17:02:29.515Z\",\n            \"orderCashAmt\": 0\n        },\n        {\n            \"orderId\": \"DB.bbcc8c6e-0c78-4b93-bc2e-1b25fe2ba87f\",\n            \"orderNo\": \"DBAZ000011\",\n            \"symbol\": \"GOOG\",\n            \"cumQty\": 0,\n            \"orderStatus\": \"0\",\n            \"orderType\": \"3\",\n            \"orderQty\": 0.15,\n            \"limitPrice\": 0,\n            \"stopPrice\": 650,\n            \"side\": \"S\",\n            \"createdWhen\": \"2016-02-03T17:14:21.938Z\",\n            \"updatedReason\": \"stop-sell-new\",\n            \"commission\": 0,\n            \"orderCashAmt\": 0\n        },\n        {\n            \"orderId\": \"DB.fa888c1f-6697-440d-abd8-f30ac329f865\",\n            \"orderNo\": \"DBJA000023\",\n            \"symbol\": \"GOOG\",\n            \"cumQty\": 0.304,\n            \"orderStatus\": \"2\",\n            \"orderType\": \"1\",\n            \"orderQty\": 0.304,\n            \"limitPrice\": 0,\n            \"stopPrice\": 0,\n            \"executedPrice\": 743.29,\n            \"side\": \"B\",\n            \"createdWhen\": \"2016-02-03T17:02:57.562Z\",\n            \"updatedWhen\": \"2016-02-03T17:02:58.153Z\",\n            \"updatedReason\": \"market_order-buy-filled\",\n            \"commission\": 0.99,\n            \"isoTimeRestingOrderExpires\": \"2016-02-03T21:00:00.000Z\",\n            \"executedWhen\": \"2016-02-03T17:02:58.153Z\",\n            \"orderCashAmt\": 0\n        },\n        {\n            \"orderId\": \"DB.f0139a6b-cc5f-4da9-8cd3-9e33da7ec591\",\n            \"orderNo\": \"DBXZ000011\",\n            \"symbol\": \"BABA\",\n            \"cumQty\": 0.5,\n            \"orderStatus\": \"2\",\n            \"orderType\": \"1\",\n            \"orderQty\": 0.5,\n            \"limitPrice\": 0,\n            \"stopPrice\": 0,\n            \"executedPrice\": 63.06,\n            \"side\": \"B\",\n            \"createdWhen\": \"2016-02-03T17:02:40.962Z\",\n            \"updatedWhen\": \"2016-02-03T17:02:42.293Z\",\n            \"updatedReason\": \"market_order-buy-filled\",\n            \"commission\": 0.99,\n            \"isoTimeRestingOrderExpires\": \"2016-02-03T21:00:00.000Z\",\n            \"executedWhen\": \"2016-02-03T17:02:42.293Z\",\n            \"orderCashAmt\": 0\n        }\n    ]\n}","name":"OK (Cash Account)"},{"name":"OK (Margin Account)","status":200,"language":"json","code":"{\n    \"accountID\": \"cb260aca-2bb6-42f0-819e-4cafb17d3383.1465398654474\",\n    \"accountNo\": \"DWGW000003\",\n    \"tradingType\": \"MARGIN\",\n    \"lastUpdated\": \"2016-07-18T17:40:08.110Z\",\n    \"cash\": {\n        \"cashAvailableForTrade\": 3608.44,\n        \"cashAvailableForWithdrawal\": 1804.22,\n        \"cashBalance\": 1724.7\n    },\n    \"margin\": {\n        \"marginRequirement\": 0.5,\n        \"longMarketValue\": 512.09,\n        \"debitBalance\": -1971.36,\n        \"equity\": 2483.45,\n        \"equityFraction\": 1,\n        \"equityRequired\": 179.2315,\n        \"restricted\": false,\n        \"daySMA\": 12937.85,\n        \"rtExcessEquity\": 1804.22,\n        \"effectiveSMA\": 1804.22,\n        \"restingOrders\": 1000\n    },\n    \"equity\": {\n        \"equityValue\": 512.09,\n        \"equityPositions\": [\n            {\n                \"symbol\": \"A\",\n                \"instrumentID\": \"2cbd5648-7afa-4347-8c82-743fd74a123a\",\n                \"openQty\": 10,\n                \"costBasis\": 200,\n                \"marketValue\": 467.3,\n                \"side\": \"B\",\n                \"priorClose\": 46.67,\n                \"availableForTradingQty\": 10,\n                \"avgPrice\": 20,\n                \"mktPrice\": 46.73,\n                \"unrealizedPL\": 267.3,\n                \"unrealizedDayPLPercent\": 0.13,\n                \"unrealizedDayPL\": 0.6\n            },\n            {\n                \"symbol\": \"C\",\n                \"instrumentID\": \"33f9801d-51f2-41a3-bca5-22ea6003f5ac\",\n                \"openQty\": 1,\n                \"costBasis\": 42.57,\n                \"marketValue\": 44.79,\n                \"side\": \"B\",\n                \"priorClose\": 44.33,\n                \"availableForTradingQty\": 1,\n                \"avgPrice\": 42.57,\n                \"mktPrice\": 44.79,\n                \"unrealizedPL\": 2.22,\n                \"unrealizedDayPLPercent\": 1.04,\n                \"unrealizedDayPL\": 0.46\n            }\n        ]\n    },\n    \"orders\": [\n        {\n            \"orderID\": \"DG.cea3903e-bd7b-46c7-9126-ee2122bb1a2c\",\n            \"orderNo\": \"DGKY000013\",\n            \"createdWhen\": \"2016-07-18T17:40:06.493Z\",\n            \"symbol\": \"BA\",\n            \"cumQty\": 0,\n            \"orderStatus\": \"0\",\n            \"orderType\": \"2\",\n            \"orderQty\": 1000,\n            \"isoTimeRestingOrderExpires\": \"2016-07-18T20:00:00.000Z\",\n            \"limitPrice\": 1,\n            \"side\": \"B\",\n            \"orderCashAmt\": 0,\n            \"stopPrice\": 0\n        }\n    ],\n    \"transactions\": [\n        {\n            \"orderId\": \"DG.cea3903e-bd7b-46c7-9126-ee2122bb1a2c\",\n            \"orderNo\": \"DGKY000013\",\n            \"symbol\": \"BA\",\n            \"cumQty\": 0,\n            \"orderStatus\": \"0\",\n            \"orderType\": \"2\",\n            \"orderQty\": 1000,\n            \"limitPrice\": 1,\n            \"stopPrice\": 0,\n            \"side\": \"B\",\n            \"createdWhen\": \"2016-07-18T17:40:06.493Z\",\n            \"updatedReason\": \"limit-buy-new\",\n            \"commission\": 0,\n            \"isoTimeRestingOrderExpires\": \"2016-07-18T20:00:00.000Z\",\n            \"orderCashAmt\": 0\n        }\n    ]\n}"},{"name":"OK (Margin Account - IN CALL)","status":200,"language":"json","code":"{\n    \"accountID\": \"cb260aca-2bb6-42f0-819e-4cafb17d3383.1465398654474\",\n    \"accountNo\": \"DWGW000003\",\n    \"tradingType\": \"MARGIN\",\n    \"lastUpdated\": \"2016-07-18T18:02:32.565Z\",\n    \"cash\": {\n        \"cashAvailableForTrade\": 0,\n        \"cashAvailableForWithdrawal\": 0,\n        \"cashBalance\": -2286.28\n    },\n    \"margin\": {\n        \"marginRequirement\": 0.5,\n        \"longMarketValue\": 2920,\n        \"debitBalance\": 2033.64,\n        \"equity\": 886.36,\n        \"equityFraction\": 0.3,\n        \"restricted\": true,\n        \"daySMA\": 11435.35,\n        \"rtExcessEquity\": -135.64,\n        \"effectiveSMA\": -135.64,\n        \"noBuyingPowerReason\": \"HOUSE_CALL\",\n        \"marginCall\": {\n            \"marginCallType\": \"HOUSE\",\n            \"marginCallTriggerType\": \"ACCT_MAINT\",\n            \"equityRequired\": 1022,\n            \"callAmount\": 135.64\n        },\n        \"restingOrders\": 0\n    },\n    \"equity\": {\n        \"equityValue\": 2920,\n        \"equityPositions\": [\n            {\n                \"symbol\": \"A\",\n                \"instrumentID\": \"2cbd5648-7afa-4347-8c82-743fd74a123a\",\n                \"openQty\": 10,\n                \"costBasis\": 200,\n                \"marketValue\": 200,\n                \"side\": \"B\",\n                \"priorClose\": 46.67,\n                \"availableForTradingQty\": 10,\n                \"avgPrice\": 20,\n                \"mktPrice\": 20,\n                \"unrealizedPL\": 0,\n                \"unrealizedDayPLPercent\": -57.15,\n                \"unrealizedDayPL\": -266.7\n            },\n            {\n                \"symbol\": \"BA\",\n                \"instrumentID\": \"2d041ba3-f310-43b2-9c29-583572012e0a\",\n                \"openQty\": 30,\n                \"costBasis\": 4005,\n                \"marketValue\": 2700,\n                \"side\": \"B\",\n                \"priorClose\": 132.39,\n                \"availableForTradingQty\": 30,\n                \"avgPrice\": 133.5,\n                \"mktPrice\": 90,\n                \"unrealizedPL\": -1305,\n                \"unrealizedDayPLPercent\": -32.58,\n                \"unrealizedDayPL\": -1305\n            },\n            {\n                \"symbol\": \"C\",\n                \"instrumentID\": \"33f9801d-51f2-41a3-bca5-22ea6003f5ac\",\n                \"openQty\": 1,\n                \"costBasis\": 42.57,\n                \"marketValue\": 20,\n                \"side\": \"B\",\n                \"priorClose\": 44.33,\n                \"availableForTradingQty\": 1,\n                \"avgPrice\": 42.57,\n                \"mktPrice\": 20,\n                \"unrealizedPL\": -22.57,\n                \"unrealizedDayPLPercent\": -54.88,\n                \"unrealizedDayPL\": -24.33\n            }\n        ]\n    },\n    \"orders\": [],\n    \"transactions\": [\n        {\n            \"orderId\": \"DG.0a2c2066-9ad8-42fa-b516-0dcde69a3267\",\n            \"orderNo\": \"DGZV000031\",\n            \"symbol\": \"BA\",\n            \"cumQty\": 0,\n            \"orderStatus\": \"8\",\n            \"orderType\": \"1\",\n            \"orderQty\": 100,\n            \"limitPrice\": 0,\n            \"stopPrice\": 0,\n            \"side\": \"B\",\n            \"createdWhen\": \"2016-07-18T17:55:59.787Z\",\n            \"updatedReason\": \"0617 Margin account cannot BUY insufficient funds. Instrument leverage requirement rule. BA 0.5 DGZV000031 marginBuyingPower= 4608.87 cashRequiredForRegT=6676.5 clientCashComponent=2304.44 purchaseRequiredEquity=13352.99 commission=-2.99 sumRestingNotional=0 sumRestingComission=0 ordersInStreet=\",\n            \"commission\": 0,\n            \"isoTimeRestingOrderExpires\": \"2016-07-18T20:00:00.000Z\",\n            \"orderCashAmt\": 0\n        },\n        {\n            \"orderId\": \"DG.cea3903e-bd7b-46c7-9126-ee2122bb1a2c\",\n            \"orderNo\": \"DGKY000013\",\n            \"symbol\": \"BA\",\n            \"cumQty\": 0,\n            \"orderStatus\": \"4\",\n            \"orderType\": \"2\",\n            \"orderQty\": 1000,\n            \"limitPrice\": 1,\n            \"stopPrice\": 0,\n            \"side\": \"B\",\n            \"createdWhen\": \"2016-07-18T17:40:06.493Z\",\n            \"updatedReason\": \"limit-buy-canceled\",\n            \"commission\": 0,\n            \"isoTimeRestingOrderExpires\": \"2016-07-18T20:00:00.000Z\",\n            \"orderCashAmt\": 0\n        },\n        {\n            \"orderId\": \"DG.1197b409-3eab-4ef1-bf54-e08ab2867f8c\",\n            \"orderNo\": \"DGSB000039\",\n            \"symbol\": \"BA\",\n            \"cumQty\": 20,\n            \"orderStatus\": \"2\",\n            \"orderType\": \"1\",\n            \"orderQty\": 20,\n            \"limitPrice\": 0,\n            \"stopPrice\": 0,\n            \"executedPrice\": 133.5,\n            \"side\": \"B\",\n            \"createdWhen\": \"2016-07-18T17:57:26.438Z\",\n            \"updatedWhen\": \"2016-07-18T17:57:26.779Z\",\n            \"updatedReason\": \"market_order-buy-filled\",\n            \"commission\": 2.99,\n            \"isoTimeRestingOrderExpires\": \"2016-07-18T20:00:00.000Z\",\n            \"executedWhen\": \"2016-07-18T17:57:26.779Z\",\n            \"orderCashAmt\": 0\n        },\n        {\n            \"orderId\": \"DG.fd9a2acf-0ad0-47c1-b9c3-de1d43f9829b\",\n            \"orderNo\": \"DGAX000013\",\n            \"symbol\": \"BA\",\n            \"cumQty\": 10,\n            \"orderStatus\": \"2\",\n            \"orderType\": \"1\",\n            \"orderQty\": 10,\n            \"limitPrice\": 0,\n            \"stopPrice\": 0,\n            \"executedPrice\": 133.5,\n            \"side\": \"B\",\n            \"createdWhen\": \"2016-07-18T17:56:47.254Z\",\n            \"updatedWhen\": \"2016-07-18T17:56:47.602Z\",\n            \"updatedReason\": \"market_order-buy-filled\",\n            \"commission\": 2.99,\n            \"isoTimeRestingOrderExpires\": \"2016-07-18T20:00:00.000Z\",\n            \"executedWhen\": \"2016-07-18T17:56:47.602Z\",\n            \"orderCashAmt\": 0\n        }\n    ]\n}"},{"code":"Account not found [accountID={UNKNOWN_ACCOUNT_ID}]","language":"json","status":404}]},"settings":"","auth":"required","params":[{"_id":"5691500e3c4f510d00ec9bac","ref":"","in":"path","required":true,"desc":"User ID","default":"02e57c7d-d071-4c63-b491-1194a9939ea5","type":"string","name":"userID"},{"_id":"5694070ebcd0a90d0044d2a7","ref":"","in":"path","required":true,"desc":"Account ID","default":"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456","type":"string","name":"accountID"},{"_id":"587544a2713a1b0f001e370a","ref":"","in":"path","required":false,"desc":"Append to end of URL to show only `equity` object.","default":"","type":"string","name":"positions"},{"_id":"58754682967ae00f00164914","ref":"","in":"path","required":false,"desc":"Append to end of URL to show only `cash` object.","default":"","type":"string","name":"cash"},{"_id":"58754682967ae00f00164913","ref":"","in":"path","required":false,"desc":"Append to end of URL to show only `orders` object.","default":"","type":"string","name":"orders"},{"_id":"58754682967ae00f00164912","ref":"","in":"path","required":false,"desc":"Append to end of URL to show only `transactions` object.","default":"","type":"string","name":"transactions"},{"_id":"58754682967ae00f00164911","ref":"","in":"query","required":false,"desc":"Should only be used in conjunction with `transactions` filter.<br />Statuses:<br />• `\"0\"` - New<br />•  `\"1\"` - Partial Fill<br />•  `\"2\"` - Fill<br />•  `\"4\"` - Canceled<br />•  `\"8\"` - Rejected","default":"","type":"string","name":"status"}],"url":"/users/:userID/accountSummary/:accountID"},"isReference":true,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response (Cash Account)\"\n}\n[/block]\nReturns a single account object. Every account has a default list of attributes (unless noted).\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`accountID`\",\n    \"0-1\": \"Account ID\",\n    \"1-0\": \"`accountNo`\",\n    \"1-1\": \"Account number. \",\n    \"2-0\": \"`tradingType`\",\n    \"2-1\": \"Type of Account: `\\\"CASH\\\"` or `\\\"MARGIN\\\"`\",\n    \"3-0\": \"`lastUpdated`\",\n    \"3-1\": \"Time of last update. \",\n    \"4-0\": \"`cash []`\",\n    \"4-1\": \"Object of cash available in the account. \",\n    \"5-0\": \"`cash.cashAvailableForTrade`\",\n    \"5-1\": \"Cash amount available for trading (aka buying power). \",\n    \"6-0\": \"`cash.cashAvailableForWithdrawal`\",\n    \"6-1\": \"Cash amount available for withdrawal. \",\n    \"7-0\": \"`cash.cashBalance`\",\n    \"7-1\": \"Current overall cash balance. \",\n    \"8-0\": \"`equity []`\",\n    \"8-1\": \"Array of position in the account. \",\n    \"9-0\": \"`equity.equityValue`\",\n    \"9-1\": \"Current total market value of the account's open positions. \",\n    \"10-0\": \"`equity.equityPositions`\",\n    \"10-1\": \"Array of current positions.\",\n    \"11-0\": \"`equity.equityPositions.symbol`\",\n    \"11-1\": \"Instrument symbol. \",\n    \"12-0\": \"`equity.equityPositions.instrumentID`\",\n    \"12-1\": \"Instrument ID. \",\n    \"13-0\": \"`equity.equityPositions.openQty`\",\n    \"13-1\": \"Quantity of shares owned. \",\n    \"14-0\": \"`equity.equityPositions.costBasis`\",\n    \"14-1\": \"Cost basis of position. \",\n    \"15-0\": \"`equity.equityPositions.marketValue`\",\n    \"15-1\": \"Current market value of position. \",\n    \"16-0\": \"`equity.equityPositions.side`\",\n    \"16-1\": \"Side of position: `\\\"B\\\"` - Buy or `\\\"S\\\"` - Sell. \",\n    \"17-0\": \"`equity.equityPositions.priorClose`\",\n    \"17-1\": \"Prior close price for this instrument. \",\n    \"18-0\": \"`equity.equityPositions.availableForTradingQty`\",\n    \"18-1\": \"Quantity available for sale. \",\n    \"19-0\": \"`equity.equityPositions.avgPrice`\",\n    \"19-1\": \"Average price of position. \",\n    \"20-0\": \"`equity.equityPositions.mktPrice`\",\n    \"20-1\": \"Current market price of position. \",\n    \"21-0\": \"`equity.equityPositions.unrealizedPL`\",\n    \"21-1\": \"Unrealized profit and loss for position. \",\n    \"22-0\": \"`equity.equityPositions.unrealizedDayPLPercent`\",\n    \"22-1\": \"Unrealized day profit and loss for position in percent. \",\n    \"23-0\": \"`equity.equityPositions.unrealizedDayPL`\",\n    \"23-1\": \"Unrealized day profit and loss for position. \",\n    \"24-0\": \"`orders []`\",\n    \"24-1\": \"Array of resting orders.\",\n    \"25-0\": \"`orders.orderID`\",\n    \"25-1\": \"Order ID. \",\n    \"26-0\": \"`orders.orderNo`\",\n    \"26-1\": \"Order number. \",\n    \"27-0\": \"`orders.createdWhen`\",\n    \"27-1\": \"Timestamp of when order was created. \",\n    \"28-0\": \"`orders.symbol`\",\n    \"28-1\": \"Ticker symbol for order. \",\n    \"29-0\": \"`orders.cumQty`\",\n    \"29-1\": \"Cumulative quantity of shares filled. \",\n    \"30-0\": \"`orders.orderStatus`\",\n    \"30-1\": \"Order status: `\\\"0\\\"` - New, `\\\"1\\\"` - Partial Fill, `\\\"2\\\"` - Fill, `\\\"4\\\"` - Canceled, `\\\"8\\\"` - Rejected. \",\n    \"31-0\": \"`orders.orderType`\",\n    \"31-1\": \"Order type: `\\\"1\\\"` - Market, `\\\"2\\\"` - Limit or `\\\"3\\\"` - Stop. \",\n    \"32-0\": \"`orders.orderQty`\",\n    \"32-1\": \"Quantity of shares requested up to 4 decimal places \",\n    \"33-0\": \"`orders.orderCashAmt`\",\n    \"33-1\": \"Amount of cash requested for an order (fractional shares only). \",\n    \"34-0\": \"`orders.avgPrice`\",\n    \"34-1\": \"Average price.\",\n    \"35-0\": \"`orders.side`\",\n    \"35-1\": \"Side of position: `\\\"B\\\"` - Buy or `\\\"S\\\"` - Sell. \",\n    \"36-0\": \"`orders.isoTimeRestingOrderExpires`\",\n    \"36-1\": \"Expiration of order (limits only). \",\n    \"37-0\": \"`orders.limitPrice`\",\n    \"37-1\": \"Limit price entered (limits only). \",\n    \"38-0\": \"`orders.stopPrice`\",\n    \"38-1\": \"Stop price entered (stops only). \",\n    \"39-0\": \"`transactions []`\",\n    \"39-1\": \"Array of user's transactions. \",\n    \"40-0\": \"`transactions.orderID`\",\n    \"40-1\": \"Order ID. \",\n    \"41-0\": \"`transactions.orderNo`\",\n    \"41-1\": \"Order number. \",\n    \"42-0\": \"`transactions.symbol`\",\n    \"42-1\": \"Ticker symbol for order. \",\n    \"43-0\": \"`transactions.cumQty`\",\n    \"43-1\": \"Cumulative quantity of shares filled. \",\n    \"44-0\": \"`transactions.orderStatus`\",\n    \"44-1\": \"Order status: `\\\"0\\\"` - New, `\\\"1\\\"` - Partial Fill, `\\\"2\\\"` - Fill, `\\\"4\\\"` - Canceled, `\\\"8\\\"` - Rejected. \",\n    \"45-0\": \"`transactions.orderType`\",\n    \"45-1\": \"Order type: `\\\"1\\\"` - Market, `\\\"2\\\"` - Limit or `\\\"3\\\"` - Stop. \",\n    \"46-0\": \"`transactions.orderQty`\",\n    \"46-1\": \"Quantity of shares requested. \",\n    \"47-0\": \"`transactions.orderCashAmt`\",\n    \"47-1\": \"Amount of cash requested for an order (fractional shares only). \",\n    \"48-0\": \"`transactions.side`\",\n    \"48-1\": \"Side of position: `\\\"B\\\"` - Buy or `\\\"S\\\"` - Sell. \",\n    \"49-0\": \"`transactions.createdWhen`\",\n    \"49-1\": \"Timestamp of when order was created. \",\n    \"50-0\": \"`transactions.updatedReason`\",\n    \"50-1\": \"Reason for update of order. For rejected orders see [Common Order Gateway Error Codes](doc:common-order-gateway-error-codes) for rejected reason. \",\n    \"51-0\": \"`transactions.commission`\",\n    \"51-1\": \"Commission for transaction (if applicable) \",\n    \"52-0\": \"`transactions.executedWhen`\",\n    \"52-1\": \"Timestamp of when order was executed (if applicable). \",\n    \"53-0\": \"`transactions.isoTimeRestingOrderExpires`\",\n    \"53-1\": \"Expiration of order (limits only). \",\n    \"54-0\": \"`transactions.limitPrice`\",\n    \"54-1\": \"Limit price entered (limits only). \",\n    \"55-0\": \"`transactions.stopPrice`\",\n    \"55-1\": \"Stop price entered (stops only). \",\n    \"56-0\": \"`transactions.cancelledWhen`\",\n    \"56-1\": \"Timestamp when order was canceled (if applicable). \"\n  },\n  \"cols\": 2,\n  \"rows\": 57\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response (Margin Account)\"\n}\n[/block]\nReturns a single account object. Every account has a default list of attributes (unless noted).\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`accountID`\",\n    \"0-1\": \"Account ID\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"1-0\": \"`accountNo`\",\n    \"1-1\": \"Account number \",\n    \"2-0\": \"`tradingType`\",\n    \"2-1\": \"Type of Account: `\\\"CASH\\\"` or `\\\"MARGIN\\\"` \",\n    \"3-0\": \"`lastUpdated`\",\n    \"3-1\": \"Time of last update \",\n    \"4-0\": \"`cash []`\",\n    \"4-1\": \"Object of cash available in the account \",\n    \"5-0\": \"`cash.cashAvailableForTrade`\",\n    \"5-1\": \"Cash amount available for trading. AKA - Buying Power = double SMA \",\n    \"6-0\": \"`cash.cashAvailableForWithdrawal`\",\n    \"6-1\": \"Cash amount available for withdrawal. AKA - SMA \",\n    \"7-0\": \"`cash.cashBalance`\",\n    \"7-1\": \"Current overall cash balance \",\n    \"8-0\": \"`margin []`\",\n    \"8-1\": \"Object of margin calculations \",\n    \"9-0\": \"`margin.marginRequirement`\",\n    \"9-1\": \"0.5 (2 to 1 margin/leverage) \",\n    \"10-0\": \"`margin.longMarketValue`\",\n    \"10-1\": \"Long market value - real-time  $ value of current holdings \",\n    \"11-0\": \"`margin.debitBalance`\",\n    \"11-1\": \"Real-time $ value of debt, +$ is debit balance, -$ is credit balance \",\n    \"12-0\": \"`margin.equity`\",\n    \"12-1\": \"Real-time $ value of equity, calculated as long market value – debit balance \",\n    \"13-0\": \"`margin.equityFraction`\",\n    \"13-1\": \"Equity as a fraction of long market value, calculated as equity / long market value \",\n    \"14-0\": \"`margin.equityRequired`\",\n    \"14-1\": \"Minimum equity required to stay above a HOUSE margin call. If the account is in a margin call (HOUSE or EXCHANGE) this field will not appear here, but instead appear in the `marginCall []` section (see table below) \",\n    \"15-0\": \"`margin.restricted`\",\n    \"15-1\": \"`\\\"TRUE\\\"` or `\\\"FALSE\\\"` -  Account becomes restricted if equity is less than 50% of long market value (this is essentially a warning, at 35% the account will be in HOUSE margin call) \",\n    \"16-0\": \"`margin.daySMA`\",\n    \"16-1\": \"Current SMA using traditional calculations – Start with beginning of day SMA and update with deposits and withdrawals as well as stock buys and sells during the day. Deposits increase and withdrawals decrease SMA dollar for dollar. Buys increase and sells decrease SMA by 50% of trade $ value\",\n    \"17-0\": \"`margin.rtExcessEquity`\",\n    \"17-1\": \"Equity in excess of `equityRequired` calculated in real time (more is good) \",\n    \"18-0\": \"`margin.effectiveSMA`\",\n    \"18-1\": \"The lower of `margin.daySMA` and `margin.rtExcessEquity`. This is risk protection for the customer as well as DriveWealth. Using only `margin.daySMA` for lending on margin has the disadvantage that the SMA can become inflated if the market drops from start of day. If customers were to use their entire daySMA to buy stock on a day when the market drops, they are immediately placed into a HOUSE CALL. The `margin.rtExcessEquity` prevents that from happening by lending them only a (reduced) amount that would place them above a HOUSE margin call. That is the risk protection provided to both parties \",\n    \"19-0\": \"`margin.noBuyingPowerReason`\",\n    \"19-1\": \"Reason indicating why the user has no buying power: \\n  * `MIN_MARGIN_EQUITY_NOT_MET` - `margin.equity` is less than $2,000 and `margin.debitBalance` is greater than $0\\n  * `EFFECTIVE_SMA_ZERO` - SMA is $0\\n  * `HOUSE_CALL` -  `margin.equityfFaction` is less than 35% (required house equity)\\n  * `EXCHANGE_CALL` -  `margin.equityfFaction` is less than 25% (required exchange equity)\\n  * `RESTING_ORDERS_WILL_TRIGGER_HOUSE_MARGIN_CALL` - Market dropped after resting orders were placed, and will trigger house call if filled\",\n    \"20-0\": \"`marginCall []`\",\n    \"20-1\": \"Object of margin call calculations.  Will only appear if `noBuyingPowerReason` is equal to `MIN_MARGIN_EQUITY_NOT_MET` or `HOUSE_CALL` or `EXCHANGE_CALL`\",\n    \"21-0\": \"`marginCall.marginCallType`\",\n    \"21-1\": \"`EQUITY` or `HOUSE` or `EXCHANGE`\",\n    \"22-0\": \"`marginCall.marginCallTriggerType`\",\n    \"22-1\": \"`ACCT_MAINT`\",\n    \"23-0\": \"`marginCall.equityRequired`\",\n    \"23-1\": \"Minimum required equity to bring the account above a house margin call \",\n    \"24-0\": \"`marginCall.callAmount`\",\n    \"24-1\": \"Minimum $ amount to be deposited in the account to bring the account above a house margin or equity call\",\n    \"25-0\": \"`restingOrders`\",\n    \"25-1\": \"Total $ value committed in resting orders that reduces the `effectiveSMA`  \",\n    \"26-0\": \"`equity []`\",\n    \"26-1\": \"Array of position in the account \",\n    \"27-0\": \"`equity.equityValue`\",\n    \"27-1\": \"Current total market value of the account's open positions \",\n    \"28-0\": \"`equity.equityPositions`\",\n    \"28-1\": \"Array of current positions \",\n    \"29-0\": \"`equity.equityPositions.symbol`\",\n    \"29-1\": \"Instrument symbol \",\n    \"30-0\": \"`equity.equityPositions.instrumentID`\",\n    \"30-1\": \"Instrument ID \",\n    \"31-0\": \"`equity.equityPositions.openQty`\",\n    \"31-1\": \"Quantity of shares owned \",\n    \"32-0\": \"`equity.equityPositions.costBasis`\",\n    \"32-1\": \"Cost basis of position \",\n    \"33-0\": \"`equity.equityPositions.marketValue`\",\n    \"33-1\": \"Current market value of position \",\n    \"34-0\": \"`equity.equityPositions.side`\",\n    \"34-1\": \"Side of position:\\n* `\\\"B\\\"` - Buy\\n* `\\\"S\\\"` - Sell\",\n    \"35-0\": \"`equity.equityPositions.priorClose`\",\n    \"35-1\": \"Prior close price for this instrument \",\n    \"36-0\": \"`equity.equityPositions.availableForTradingQty`\",\n    \"36-1\": \"Quantity available for sale \",\n    \"37-0\": \"`equity.equityPositions.avgPrice`\",\n    \"37-1\": \"Average price of position \",\n    \"38-0\": \"`equity.equityPositions.mktPrice`\",\n    \"38-1\": \"Current market price of position \",\n    \"39-0\": \"`equity.equityPositions.unrealizedPL`\",\n    \"39-1\": \"Unrealized profit and loss for position \",\n    \"40-0\": \"`equity.equityPositions.unrealizedDayPLPercent`\",\n    \"40-1\": \"Unrealized day profit and loss for position in percent \",\n    \"41-0\": \"`equity.equityPositions.unrealizedDayPL`\",\n    \"41-1\": \"Unrealized day profit and loss for position \",\n    \"42-0\": \"`orders []`\",\n    \"42-1\": \"Array of resting orders \",\n    \"43-0\": \"`orders.orderID`\",\n    \"43-1\": \"Order ID \",\n    \"44-0\": \"`orders.orderNo`\",\n    \"44-1\": \"Order number \",\n    \"45-0\": \"`orders.createdWhen`\",\n    \"45-1\": \"Timestamp of when order was created \",\n    \"46-0\": \"`orders.symbol`\",\n    \"46-1\": \"Ticker symbol for order \",\n    \"47-0\": \"`orders.cumQty`\",\n    \"47-1\": \"Cumulative quantity of shares filled \",\n    \"48-0\": \"`orders.orderStatus`\",\n    \"48-1\": \"Order status: \\n* `\\\"0\\\"` - New\\n* `\\\"1\\\"` - Partial Fill\\n* `\\\"2\\\"` - Fill\\n* `\\\"4\\\"` - Canceled\\n* `\\\"8\\\"` - Rejected\",\n    \"49-0\": \"`orders.orderType`\",\n    \"49-1\": \"Order type:\\n* `\\\"1\\\"` - Market\\n* `\\\"2\\\"` - Limit\\n* `\\\"3\\\"` - Stop\",\n    \"50-0\": \"`orders.orderQty`\",\n    \"50-1\": \"Quantity of shares requested up to 4 decimal places \",\n    \"51-0\": \"`orders.orderCashAmt`\",\n    \"51-1\": \"Amount of cash requested for an order (fractional shares only) \",\n    \"52-0\": \"`orders.avgPrice`\",\n    \"52-1\": \"Average price\",\n    \"53-0\": \"`orders.side`\",\n    \"53-1\": \"Side of position:\\n* `\\\"B\\\"` - Buy\\n* `\\\"S\\\"` - Sell\",\n    \"54-0\": \"`orders.isoTimeRestingOrderExpires`\",\n    \"54-1\": \"Expiration of order (limits only) \",\n    \"55-0\": \"`orders.limitPrice`\",\n    \"55-1\": \"Limit price entered (limits only) \",\n    \"56-0\": \"`orders.stopPrice`\",\n    \"56-1\": \"Stop price entered (stops only) \",\n    \"57-0\": \"`transactions []`\",\n    \"57-1\": \"Array of user's transactions \",\n    \"58-0\": \"`transactions.orderID`\",\n    \"58-1\": \"Order ID \",\n    \"59-0\": \"`transactions.orderNo`\",\n    \"59-1\": \"Order number \",\n    \"60-0\": \"`transactions.symbol`\",\n    \"60-1\": \"Ticker symbol for order \",\n    \"61-0\": \"`transactions.cumQty`\",\n    \"61-1\": \"Cumulative quantity of shares filled \",\n    \"62-0\": \"`transactions.orderStatus`\",\n    \"62-1\": \"Order status: \\n* `\\\"0\\\"` - New\\n* `\\\"1\\\"` - Partial Fill\\n* `\\\"2\\\"` - Fill\\n* `\\\"4\\\"` - Canceled\\n* `\\\"8\\\"` - Rejected\",\n    \"63-0\": \"`transactions.orderType`\",\n    \"63-1\": \"Order type:\\n* `\\\"1\\\"` - Market\\n* `\\\"2\\\"` - Limit\\n* `\\\"3\\\"` - Stop\",\n    \"64-0\": \"`transactions.orderQty`\",\n    \"64-1\": \"Quantity of shares requested \",\n    \"65-0\": \"`transactions.orderCashAmt`\",\n    \"65-1\": \"Amount of cash requested for an order (fractional shares only) \",\n    \"66-0\": \"`transactions.side`\",\n    \"66-1\": \"Side of position:\\n* `\\\"B\\\"` - Buy\\n* `\\\"S\\\"` - Sell\",\n    \"67-0\": \"`transactions.createdWhen`\",\n    \"67-1\": \"Timestamp of when order was created \",\n    \"68-0\": \"`transactions.updatedReason`\",\n    \"68-1\": \"Reason for update of order. For rejected orders see [Common Order Gateway Error Codes](doc:common-order-gateway-error-codes) for rejected reason \",\n    \"69-0\": \"`transactions.commission`\",\n    \"69-1\": \"Commission for transaction (if applicable) \",\n    \"70-0\": \"`transactions.executedWhen`\",\n    \"70-1\": \"Timestamp of when order was executed (if applicable) \",\n    \"71-0\": \"`transactions.isoTimeRestingOrderExpires`\",\n    \"71-1\": \"Expiration of order (limits only) \",\n    \"72-0\": \"`transactions.limitPrice`\",\n    \"72-1\": \"Limit price entered (limits only) \",\n    \"73-0\": \"`transactions.stopPrice`\",\n    \"73-1\": \"Stop price entered (stops only) \",\n    \"74-0\": \"`transactions.cancelledWhen`\",\n    \"74-1\": \"Timestamp when order was canceled (if applicable) \"\n  },\n  \"cols\": 2,\n  \"rows\": 75\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Additonal Margin Information\",\n  \"body\": \"http://help.drivewealth.com/customer/en/portal/topics/773020-margin-and-day-trading-rules/articles\"\n}\n[/block]","excerpt":"Provides summary on a specific account.","slug":"account-blotter","type":"endpoint","title":"Account Blotter"}

getAccount Blotter

Provides summary on a specific account.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

userID:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5
User ID
accountID:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456
Account ID
positions:
string
Append to end of URL to show only `equity` object.
cash:
string
Append to end of URL to show only `cash` object.
orders:
string
Append to end of URL to show only `orders` object.
transactions:
string
Append to end of URL to show only `transactions` object.

Query Params

status:
string
Should only be used in conjunction with `transactions` filter.<br />Statuses:<br />• `"0"` - New<br />• `"1"` - Partial Fill<br />• `"2"` - Fill<br />• `"4"` - Canceled<br />• `"8"` - Rejected

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response (Cash Account)" } [/block] Returns a single account object. Every account has a default list of attributes (unless noted). [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`accountID`", "0-1": "Account ID", "1-0": "`accountNo`", "1-1": "Account number. ", "2-0": "`tradingType`", "2-1": "Type of Account: `\"CASH\"` or `\"MARGIN\"`", "3-0": "`lastUpdated`", "3-1": "Time of last update. ", "4-0": "`cash []`", "4-1": "Object of cash available in the account. ", "5-0": "`cash.cashAvailableForTrade`", "5-1": "Cash amount available for trading (aka buying power). ", "6-0": "`cash.cashAvailableForWithdrawal`", "6-1": "Cash amount available for withdrawal. ", "7-0": "`cash.cashBalance`", "7-1": "Current overall cash balance. ", "8-0": "`equity []`", "8-1": "Array of position in the account. ", "9-0": "`equity.equityValue`", "9-1": "Current total market value of the account's open positions. ", "10-0": "`equity.equityPositions`", "10-1": "Array of current positions.", "11-0": "`equity.equityPositions.symbol`", "11-1": "Instrument symbol. ", "12-0": "`equity.equityPositions.instrumentID`", "12-1": "Instrument ID. ", "13-0": "`equity.equityPositions.openQty`", "13-1": "Quantity of shares owned. ", "14-0": "`equity.equityPositions.costBasis`", "14-1": "Cost basis of position. ", "15-0": "`equity.equityPositions.marketValue`", "15-1": "Current market value of position. ", "16-0": "`equity.equityPositions.side`", "16-1": "Side of position: `\"B\"` - Buy or `\"S\"` - Sell. ", "17-0": "`equity.equityPositions.priorClose`", "17-1": "Prior close price for this instrument. ", "18-0": "`equity.equityPositions.availableForTradingQty`", "18-1": "Quantity available for sale. ", "19-0": "`equity.equityPositions.avgPrice`", "19-1": "Average price of position. ", "20-0": "`equity.equityPositions.mktPrice`", "20-1": "Current market price of position. ", "21-0": "`equity.equityPositions.unrealizedPL`", "21-1": "Unrealized profit and loss for position. ", "22-0": "`equity.equityPositions.unrealizedDayPLPercent`", "22-1": "Unrealized day profit and loss for position in percent. ", "23-0": "`equity.equityPositions.unrealizedDayPL`", "23-1": "Unrealized day profit and loss for position. ", "24-0": "`orders []`", "24-1": "Array of resting orders.", "25-0": "`orders.orderID`", "25-1": "Order ID. ", "26-0": "`orders.orderNo`", "26-1": "Order number. ", "27-0": "`orders.createdWhen`", "27-1": "Timestamp of when order was created. ", "28-0": "`orders.symbol`", "28-1": "Ticker symbol for order. ", "29-0": "`orders.cumQty`", "29-1": "Cumulative quantity of shares filled. ", "30-0": "`orders.orderStatus`", "30-1": "Order status: `\"0\"` - New, `\"1\"` - Partial Fill, `\"2\"` - Fill, `\"4\"` - Canceled, `\"8\"` - Rejected. ", "31-0": "`orders.orderType`", "31-1": "Order type: `\"1\"` - Market, `\"2\"` - Limit or `\"3\"` - Stop. ", "32-0": "`orders.orderQty`", "32-1": "Quantity of shares requested up to 4 decimal places ", "33-0": "`orders.orderCashAmt`", "33-1": "Amount of cash requested for an order (fractional shares only). ", "34-0": "`orders.avgPrice`", "34-1": "Average price.", "35-0": "`orders.side`", "35-1": "Side of position: `\"B\"` - Buy or `\"S\"` - Sell. ", "36-0": "`orders.isoTimeRestingOrderExpires`", "36-1": "Expiration of order (limits only). ", "37-0": "`orders.limitPrice`", "37-1": "Limit price entered (limits only). ", "38-0": "`orders.stopPrice`", "38-1": "Stop price entered (stops only). ", "39-0": "`transactions []`", "39-1": "Array of user's transactions. ", "40-0": "`transactions.orderID`", "40-1": "Order ID. ", "41-0": "`transactions.orderNo`", "41-1": "Order number. ", "42-0": "`transactions.symbol`", "42-1": "Ticker symbol for order. ", "43-0": "`transactions.cumQty`", "43-1": "Cumulative quantity of shares filled. ", "44-0": "`transactions.orderStatus`", "44-1": "Order status: `\"0\"` - New, `\"1\"` - Partial Fill, `\"2\"` - Fill, `\"4\"` - Canceled, `\"8\"` - Rejected. ", "45-0": "`transactions.orderType`", "45-1": "Order type: `\"1\"` - Market, `\"2\"` - Limit or `\"3\"` - Stop. ", "46-0": "`transactions.orderQty`", "46-1": "Quantity of shares requested. ", "47-0": "`transactions.orderCashAmt`", "47-1": "Amount of cash requested for an order (fractional shares only). ", "48-0": "`transactions.side`", "48-1": "Side of position: `\"B\"` - Buy or `\"S\"` - Sell. ", "49-0": "`transactions.createdWhen`", "49-1": "Timestamp of when order was created. ", "50-0": "`transactions.updatedReason`", "50-1": "Reason for update of order. For rejected orders see [Common Order Gateway Error Codes](doc:common-order-gateway-error-codes) for rejected reason. ", "51-0": "`transactions.commission`", "51-1": "Commission for transaction (if applicable) ", "52-0": "`transactions.executedWhen`", "52-1": "Timestamp of when order was executed (if applicable). ", "53-0": "`transactions.isoTimeRestingOrderExpires`", "53-1": "Expiration of order (limits only). ", "54-0": "`transactions.limitPrice`", "54-1": "Limit price entered (limits only). ", "55-0": "`transactions.stopPrice`", "55-1": "Stop price entered (stops only). ", "56-0": "`transactions.cancelledWhen`", "56-1": "Timestamp when order was canceled (if applicable). " }, "cols": 2, "rows": 57 } [/block] [block:api-header] { "type": "basic", "title": "Response (Margin Account)" } [/block] Returns a single account object. Every account has a default list of attributes (unless noted). [block:parameters] { "data": { "0-0": "`accountID`", "0-1": "Account ID", "h-0": "Attribute", "h-1": "Description", "1-0": "`accountNo`", "1-1": "Account number ", "2-0": "`tradingType`", "2-1": "Type of Account: `\"CASH\"` or `\"MARGIN\"` ", "3-0": "`lastUpdated`", "3-1": "Time of last update ", "4-0": "`cash []`", "4-1": "Object of cash available in the account ", "5-0": "`cash.cashAvailableForTrade`", "5-1": "Cash amount available for trading. AKA - Buying Power = double SMA ", "6-0": "`cash.cashAvailableForWithdrawal`", "6-1": "Cash amount available for withdrawal. AKA - SMA ", "7-0": "`cash.cashBalance`", "7-1": "Current overall cash balance ", "8-0": "`margin []`", "8-1": "Object of margin calculations ", "9-0": "`margin.marginRequirement`", "9-1": "0.5 (2 to 1 margin/leverage) ", "10-0": "`margin.longMarketValue`", "10-1": "Long market value - real-time $ value of current holdings ", "11-0": "`margin.debitBalance`", "11-1": "Real-time $ value of debt, +$ is debit balance, -$ is credit balance ", "12-0": "`margin.equity`", "12-1": "Real-time $ value of equity, calculated as long market value – debit balance ", "13-0": "`margin.equityFraction`", "13-1": "Equity as a fraction of long market value, calculated as equity / long market value ", "14-0": "`margin.equityRequired`", "14-1": "Minimum equity required to stay above a HOUSE margin call. If the account is in a margin call (HOUSE or EXCHANGE) this field will not appear here, but instead appear in the `marginCall []` section (see table below) ", "15-0": "`margin.restricted`", "15-1": "`\"TRUE\"` or `\"FALSE\"` - Account becomes restricted if equity is less than 50% of long market value (this is essentially a warning, at 35% the account will be in HOUSE margin call) ", "16-0": "`margin.daySMA`", "16-1": "Current SMA using traditional calculations – Start with beginning of day SMA and update with deposits and withdrawals as well as stock buys and sells during the day. Deposits increase and withdrawals decrease SMA dollar for dollar. Buys increase and sells decrease SMA by 50% of trade $ value", "17-0": "`margin.rtExcessEquity`", "17-1": "Equity in excess of `equityRequired` calculated in real time (more is good) ", "18-0": "`margin.effectiveSMA`", "18-1": "The lower of `margin.daySMA` and `margin.rtExcessEquity`. This is risk protection for the customer as well as DriveWealth. Using only `margin.daySMA` for lending on margin has the disadvantage that the SMA can become inflated if the market drops from start of day. If customers were to use their entire daySMA to buy stock on a day when the market drops, they are immediately placed into a HOUSE CALL. The `margin.rtExcessEquity` prevents that from happening by lending them only a (reduced) amount that would place them above a HOUSE margin call. That is the risk protection provided to both parties ", "19-0": "`margin.noBuyingPowerReason`", "19-1": "Reason indicating why the user has no buying power: \n * `MIN_MARGIN_EQUITY_NOT_MET` - `margin.equity` is less than $2,000 and `margin.debitBalance` is greater than $0\n * `EFFECTIVE_SMA_ZERO` - SMA is $0\n * `HOUSE_CALL` - `margin.equityfFaction` is less than 35% (required house equity)\n * `EXCHANGE_CALL` - `margin.equityfFaction` is less than 25% (required exchange equity)\n * `RESTING_ORDERS_WILL_TRIGGER_HOUSE_MARGIN_CALL` - Market dropped after resting orders were placed, and will trigger house call if filled", "20-0": "`marginCall []`", "20-1": "Object of margin call calculations. Will only appear if `noBuyingPowerReason` is equal to `MIN_MARGIN_EQUITY_NOT_MET` or `HOUSE_CALL` or `EXCHANGE_CALL`", "21-0": "`marginCall.marginCallType`", "21-1": "`EQUITY` or `HOUSE` or `EXCHANGE`", "22-0": "`marginCall.marginCallTriggerType`", "22-1": "`ACCT_MAINT`", "23-0": "`marginCall.equityRequired`", "23-1": "Minimum required equity to bring the account above a house margin call ", "24-0": "`marginCall.callAmount`", "24-1": "Minimum $ amount to be deposited in the account to bring the account above a house margin or equity call", "25-0": "`restingOrders`", "25-1": "Total $ value committed in resting orders that reduces the `effectiveSMA` ", "26-0": "`equity []`", "26-1": "Array of position in the account ", "27-0": "`equity.equityValue`", "27-1": "Current total market value of the account's open positions ", "28-0": "`equity.equityPositions`", "28-1": "Array of current positions ", "29-0": "`equity.equityPositions.symbol`", "29-1": "Instrument symbol ", "30-0": "`equity.equityPositions.instrumentID`", "30-1": "Instrument ID ", "31-0": "`equity.equityPositions.openQty`", "31-1": "Quantity of shares owned ", "32-0": "`equity.equityPositions.costBasis`", "32-1": "Cost basis of position ", "33-0": "`equity.equityPositions.marketValue`", "33-1": "Current market value of position ", "34-0": "`equity.equityPositions.side`", "34-1": "Side of position:\n* `\"B\"` - Buy\n* `\"S\"` - Sell", "35-0": "`equity.equityPositions.priorClose`", "35-1": "Prior close price for this instrument ", "36-0": "`equity.equityPositions.availableForTradingQty`", "36-1": "Quantity available for sale ", "37-0": "`equity.equityPositions.avgPrice`", "37-1": "Average price of position ", "38-0": "`equity.equityPositions.mktPrice`", "38-1": "Current market price of position ", "39-0": "`equity.equityPositions.unrealizedPL`", "39-1": "Unrealized profit and loss for position ", "40-0": "`equity.equityPositions.unrealizedDayPLPercent`", "40-1": "Unrealized day profit and loss for position in percent ", "41-0": "`equity.equityPositions.unrealizedDayPL`", "41-1": "Unrealized day profit and loss for position ", "42-0": "`orders []`", "42-1": "Array of resting orders ", "43-0": "`orders.orderID`", "43-1": "Order ID ", "44-0": "`orders.orderNo`", "44-1": "Order number ", "45-0": "`orders.createdWhen`", "45-1": "Timestamp of when order was created ", "46-0": "`orders.symbol`", "46-1": "Ticker symbol for order ", "47-0": "`orders.cumQty`", "47-1": "Cumulative quantity of shares filled ", "48-0": "`orders.orderStatus`", "48-1": "Order status: \n* `\"0\"` - New\n* `\"1\"` - Partial Fill\n* `\"2\"` - Fill\n* `\"4\"` - Canceled\n* `\"8\"` - Rejected", "49-0": "`orders.orderType`", "49-1": "Order type:\n* `\"1\"` - Market\n* `\"2\"` - Limit\n* `\"3\"` - Stop", "50-0": "`orders.orderQty`", "50-1": "Quantity of shares requested up to 4 decimal places ", "51-0": "`orders.orderCashAmt`", "51-1": "Amount of cash requested for an order (fractional shares only) ", "52-0": "`orders.avgPrice`", "52-1": "Average price", "53-0": "`orders.side`", "53-1": "Side of position:\n* `\"B\"` - Buy\n* `\"S\"` - Sell", "54-0": "`orders.isoTimeRestingOrderExpires`", "54-1": "Expiration of order (limits only) ", "55-0": "`orders.limitPrice`", "55-1": "Limit price entered (limits only) ", "56-0": "`orders.stopPrice`", "56-1": "Stop price entered (stops only) ", "57-0": "`transactions []`", "57-1": "Array of user's transactions ", "58-0": "`transactions.orderID`", "58-1": "Order ID ", "59-0": "`transactions.orderNo`", "59-1": "Order number ", "60-0": "`transactions.symbol`", "60-1": "Ticker symbol for order ", "61-0": "`transactions.cumQty`", "61-1": "Cumulative quantity of shares filled ", "62-0": "`transactions.orderStatus`", "62-1": "Order status: \n* `\"0\"` - New\n* `\"1\"` - Partial Fill\n* `\"2\"` - Fill\n* `\"4\"` - Canceled\n* `\"8\"` - Rejected", "63-0": "`transactions.orderType`", "63-1": "Order type:\n* `\"1\"` - Market\n* `\"2\"` - Limit\n* `\"3\"` - Stop", "64-0": "`transactions.orderQty`", "64-1": "Quantity of shares requested ", "65-0": "`transactions.orderCashAmt`", "65-1": "Amount of cash requested for an order (fractional shares only) ", "66-0": "`transactions.side`", "66-1": "Side of position:\n* `\"B\"` - Buy\n* `\"S\"` - Sell", "67-0": "`transactions.createdWhen`", "67-1": "Timestamp of when order was created ", "68-0": "`transactions.updatedReason`", "68-1": "Reason for update of order. For rejected orders see [Common Order Gateway Error Codes](doc:common-order-gateway-error-codes) for rejected reason ", "69-0": "`transactions.commission`", "69-1": "Commission for transaction (if applicable) ", "70-0": "`transactions.executedWhen`", "70-1": "Timestamp of when order was executed (if applicable) ", "71-0": "`transactions.isoTimeRestingOrderExpires`", "71-1": "Expiration of order (limits only) ", "72-0": "`transactions.limitPrice`", "72-1": "Limit price entered (limits only) ", "73-0": "`transactions.stopPrice`", "73-1": "Stop price entered (stops only) ", "74-0": "`transactions.cancelledWhen`", "74-1": "Timestamp when order was canceled (if applicable) " }, "cols": 2, "rows": 75 } [/block] [block:callout] { "type": "info", "title": "Additonal Margin Information", "body": "http://help.drivewealth.com/customer/en/portal/topics/773020-margin-and-day-trading-rules/articles" } [/block]

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 }}