{"__v":2,"_id":"569523420c650a230025055e","category":{"__v":3,"_id":"56940bc83e9d080d00f064f0","pages":["56944a695f1c951900644d2e","569523420c650a230025055e","569523592e5eb41700901a7c"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-11T20:08:40.521Z","from_sync":false,"order":5,"slug":"instruments","title":"Instruments"},"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-12T16:01:06.106Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"http","code":"GET /v1/instruments?tradeStatus=1 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\" 'https://api.drivewealth.io/v1/instruments?tradeStatus=1'"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"instrumentID\": \"782ae9a3-0a5b-45f0-a022-956b018cf020\",\n    \"name\": \"0-5 Year TIPS Bond iShares\",\n    \"currencyID\": \"USD\",\n    \"exchangeID\": \"XNAS\",\n    \"limitStatus\": 0,\n    \"instrumentTypeID\": 7,\n    \"isLongOnly\": true,\n    \"marginCurrencyID\": \"USD\",\n    \"orderSizeMax\": 10000,\n    \"orderSizeMin\": 0.0001,\n    \"orderSizeStep\": 0.0001,\n    \"ratePrecision\": 2,\n    \"symbol\": \"STIPP\",\n    \"tags\": [\n      \"bond\",\n      \"etf\",\n      \"ishares\",\n      \"stip\",\n      \"tips\"\n    ],\n    \"tradeStatus\": 1,\n    \"tradingHours\": \"Mon-Fri: 9:30am - 4:00pm ET\",\n    \"uom\": \"shares\",\n    \"urlInvestor\": \"http://www.ishares.com/us/products/239450/ishares-05-year-tips-bond-etf\",\n    \"chaikinPgr\": \"{  \\\"Corrected PGR Value\\\":\\\"0\\\",  \\\"Financial Metrics\\\":\\\"0\\\",  \\\"Earnings Performance\\\":\\\"0\\\",  \\\"Price/Volume Activity\\\":\\\"0\\\",  \\\"Expert Opinions\\\":\\\"0\\\",  \\\"pgrSummaryText\\\":\\\"\\\"}\",\n    \"priorClose\": 0,\n    \"nameLower\": \"0-5 year tips bond ishares\",\n    \"underlyingID\": \"0\",\n    \"marketState\": 2,\n    \"minTic\": 0,\n    \"pipMultiplier\": 1,\n    \"rebateSpread\": 0,\n    \"longOnly\": true\n  },\n  {\n    \"instrumentID\": \"fdf87613-f62d-47a3-b359-7752808f694f\",\n    \"name\": \"1-3 Year Treasury Bond iShares\",\n    \"currencyID\": \"USD\",\n    \"exchangeID\": \"NYSE\",\n    \"limitStatus\": 0,\n    \"instrumentTypeID\": 7,\n    \"isLongOnly\": true,\n    \"marginCurrencyID\": \"USD\",\n    \"orderSizeMax\": 10000,\n    \"orderSizeMin\": 0.0001,\n    \"orderSizeStep\": 0.0001,\n    \"rateAsk\": 84.62,\n    \"rateBid\": 84.61,\n    \"ratePrecision\": 2,\n    \"symbol\": \"SHY\",\n    \"tags\": [\n      \"bonds\",\n      \"etf\",\n      \"government\",\n      \"ishares\",\n      \"shortterm\",\n      \"shy\"\n    ],\n    \"tradeStatus\": 1,\n    \"tradingHours\": \"Mon-Fri: 9:30am - 4:00pm ET\",\n    \"uom\": \"shares\",\n    \"urlInvestor\": \"http://www.ishares.com/us/products/239452/SHY\",\n    \"chaikinPgr\": \"{  \\\"Corrected PGR Value\\\":\\\"0\\\",  \\\"Financial Metrics\\\":\\\"0\\\",  \\\"Earnings Performance\\\":\\\"0\\\",  \\\"Price/Volume Activity\\\":\\\"0\\\",  \\\"Expert Opinions\\\":\\\"0\\\",  \\\"pgrSummaryText\\\":\\\"\\\"}\",\n    \"priorClose\": 84.6,\n    \"nameLower\": \"1-3 year treasury bond ishares\",\n    \"marketState\": 1,\n    \"minTic\": 0,\n    \"pipMultiplier\": 1,\n    \"rebateSpread\": 0,\n    \"longOnly\": true\n  },\n  {\n    \"instrumentID\": \"69473edd-b503-4ea6-be04-513e641bbc60\",\n    \"name\": \"20+ Year Treasury Bond iShares\",\n    \"currencyID\": \"USD\",\n    \"exchangeID\": \"XNAS\",\n    \"limitStatus\": 0,\n    \"instrumentTypeID\": 7,\n    \"isLongOnly\": true,\n    \"marginCurrencyID\": \"USD\",\n    \"orderSizeMax\": 10000,\n    \"orderSizeMin\": 0.0001,\n    \"orderSizeStep\": 0.0001,\n    \"rateAsk\": 124.09,\n    \"rateBid\": 124.08,\n    \"ratePrecision\": 2,\n    \"symbol\": \"TLT\",\n    \"tags\": [\n      \"bond\",\n      \"etf\",\n      \"ishares\",\n      \"tlt\",\n      \"treasury\"\n    ],\n    \"tradeStatus\": 1,\n    \"tradingHours\": \"Mon-Fri: 9:30am - 4:00pm ET\",\n    \"uom\": \"shares\",\n    \"chaikinPgr\": \"{  \\\"Corrected PGR Value\\\":\\\"0\\\",  \\\"Financial Metrics\\\":\\\"0\\\",  \\\"Earnings Performance\\\":\\\"0\\\",  \\\"Price/Volume Activity\\\":\\\"0\\\",  \\\"Expert Opinions\\\":\\\"0\\\",  \\\"pgrSummaryText\\\":\\\"\\\"}\",\n    \"priorClose\": 123.75,\n    \"nameLower\": \"20+ year treasury bond ishares\",\n    \"underlyingID\": \"0\",\n    \"marketState\": 2,\n    \"minTic\": 0,\n    \"pipMultiplier\": 1,\n    \"rebateSpread\": 0,\n    \"longOnly\": true\n  },\n  {...}\n]\n","name":""}]},"settings":"","auth":"required","params":[{"_id":"56967d7da917c30d0052dc0e","ref":"","in":"path","required":true,"desc":"Trade status:<br /> • `\"-1\"` - All<br /> • `\"0\"` - Inactive<br /> • `\"1\"` - Active (Default)<br /> • `\"2\"` - Close Only","default":"1","type":"string","name":"tradeStatus"}],"url":"/instruments?tradeStatus=:tradeStatus"},"isReference":true,"order":1,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nEvery instrument in the array has a default list of attributes.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`name`\",\n    \"0-1\": \"Official company or etf name.\",\n    \"1-0\": \"`currencyID`\",\n    \"2-0\": \"`exchangeID`\",\n    \"3-0\": \"`instrumentTypeID`\",\n    \"4-0\": \"`isLongOnly`\",\n    \"5-0\": \"`orderSizeMax`\",\n    \"6-0\": \"`orderSizeMin`\",\n    \"7-0\": \"`orderSizeStep`\",\n    \"8-0\": \"`rateAsk`\",\n    \"9-0\": \"`rateBid`\",\n    \"10-0\": \"`ratePrecision`\",\n    \"11-0\": \"`symbol`\",\n    \"12-0\": \"`tags`\",\n    \"13-0\": \"`tradeStatus`\",\n    \"14-0\": \"`tradingHours`\",\n    \"15-0\": \"`longOnly`\",\n    \"1-1\": \"Currency the instrument is traded in.\",\n    \"2-1\": \"Exchange the instrument is traded on.\",\n    \"3-1\": \"Type of instrument, `6` - Equity and `7` - ETF.\",\n    \"4-1\": \"Either `true` (default) if instrument can only long (i.e. prevented from shorting) or `false`.\",\n    \"5-1\": \"Maximum order size in whole numbers.\",\n    \"6-1\": \"Minimum order size in whole numbers.\",\n    \"7-1\": \"Increment size for orders in whole numbers.\",\n    \"8-1\": \"Current ask price at the time of request.\",\n    \"9-1\": \"Current bid price at the time of request.\",\n    \"11-1\": \"Ticker symbol for instrument.\",\n    \"12-1\": \"Array of tags.\",\n    \"13-1\": \"Status of instrument:\\n`0` - Inactive \\n`1` - Active\\n`2` - Close Positions only (no new positions)\",\n    \"14-1\": \"Trading hours of instrument. Always in US Eastern Time.\",\n    \"15-1\": \"Same as `isLongOnly`.\",\n    \"10-1\": \"Current precision rate at the time of request.\"\n  },\n  \"cols\": 2,\n  \"rows\": 16\n}\n[/block]","excerpt":"Provides a complete list of active (or inactive) instruments.","slug":"list-all-instruments","type":"endpoint","title":"List All Instruments"}

getList All Instruments

Provides a complete list of active (or inactive) instruments.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

tradeStatus:
required
string1
Trade status:<br /> • `"-1"` - All<br /> • `"0"` - Inactive<br /> • `"1"` - Active (Default)<br /> • `"2"` - Close Only

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response" } [/block] Every instrument in the array has a default list of attributes. [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`name`", "0-1": "Official company or etf name.", "1-0": "`currencyID`", "2-0": "`exchangeID`", "3-0": "`instrumentTypeID`", "4-0": "`isLongOnly`", "5-0": "`orderSizeMax`", "6-0": "`orderSizeMin`", "7-0": "`orderSizeStep`", "8-0": "`rateAsk`", "9-0": "`rateBid`", "10-0": "`ratePrecision`", "11-0": "`symbol`", "12-0": "`tags`", "13-0": "`tradeStatus`", "14-0": "`tradingHours`", "15-0": "`longOnly`", "1-1": "Currency the instrument is traded in.", "2-1": "Exchange the instrument is traded on.", "3-1": "Type of instrument, `6` - Equity and `7` - ETF.", "4-1": "Either `true` (default) if instrument can only long (i.e. prevented from shorting) or `false`.", "5-1": "Maximum order size in whole numbers.", "6-1": "Minimum order size in whole numbers.", "7-1": "Increment size for orders in whole numbers.", "8-1": "Current ask price at the time of request.", "9-1": "Current bid price at the time of request.", "11-1": "Ticker symbol for instrument.", "12-1": "Array of tags.", "13-1": "Status of instrument:\n`0` - Inactive \n`1` - Active\n`2` - Close Positions only (no new positions)", "14-1": "Trading hours of instrument. Always in US Eastern Time.", "15-1": "Same as `isLongOnly`.", "10-1": "Current precision rate at the time of request." }, "cols": 2, "rows": 16 } [/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 }}