{"__v":2,"_id":"569523592e5eb41700901a7c","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:29.807Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"GET /v1/instruments?symbol=AAPL 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":"http"},{"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?symbol=AAPL'","language":"curl"}]},"results":{"codes":[{"name":"","code":"[\n    {\n        \"instrumentID\": \"a67422af-8504-43df-9e63-7361eb0bd99e\",\n        \"name\": \"Apple, Inc.\",\n        \"category\": \"Stock\",\n        \"currencyID\": \"USD\",\n        \"exchangeID\": \"XNAS\",\n        \"limitStatus\": 0,\n        \"instrumentTypeID\": 6,\n        \"isLongOnly\": true,\n        \"marginCurrencyID\": \"USD\",\n        \"orderSizeMax\": 10000,\n        \"orderSizeMin\": 0.0001,\n        \"orderSizeStep\": 0.0001,\n        \"rateAsk\": 99.08,\n        \"rateBid\": 99.06,\n        \"ratePrecision\": 2,\n        \"symbol\": \"AAPL\",\n        \"tags\": [\n            \"aapl\",\n            \"sp500\",\n            \"usa\"\n        ],\n        \"tradeStatus\": 1,\n        \"tradingHours\": \"Mon-Fri: 9:30am - 4:00pm ET\",\n        \"uom\": \"shares\",\n        \"urlImage\": \"http://syscdn.drivewealth.net/images/symbols/aapl.png\",\n        \"urlInvestor\": \"http://investor.apple.com/\",\n        \"chaikinPgr\": \"3\",\n        \"sector\": \"Technology\",\n        \"priorClose\": 99.98,\n        \"nameLower\": \"apple, inc.\",\n        \"underlyingID\": \"0\",\n        \"marketState\": 2,\n        \"minTic\": 0,\n        \"pipMultiplier\": 1,\n        \"tickerSymbol\": \"AAPL\",\n        \"rebateSpread\": 0,\n        \"longOnly\": true\n    }\n]","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"569698b2a857080d0082e8c1","ref":"","in":"path","required":false,"desc":"Ticker symbol.","default":"AAPL","type":"string","name":"symbol"},{"_id":"569698b2a857080d0082e8c0","ref":"","in":"query","required":false,"desc":"Comma separated ticker symbols.","default":"AAPL,GOOG,MSFT,TSLA","type":"string","name":"symbols"},{"_id":"569698b2a857080d0082e8bf","ref":"","in":"path","required":false,"desc":"Company name.<br />**Note:** Partial or exact text searches are allowed.","default":"Apple","type":"string","name":"name"},{"_id":"569698b2a857080d0082e8be","ref":"","in":"path","required":false,"desc":"Tag.","default":"china","type":"string","name":"tag"}],"url":"/instruments?symbol=:symbol&name=:name&tag=:tag"},"isReference":true,"order":2,"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    \"1-0\": \"`category`\",\n    \"2-0\": \"`currencyID`\",\n    \"3-0\": \"`exchangeID`\",\n    \"4-0\": \"`instrumentTypeID`\",\n    \"5-0\": \"`isLongOnly`\",\n    \"6-0\": \"`orderSizeMax`\",\n    \"7-0\": \"`orderSizeMin`\",\n    \"8-0\": \"`orderSizeStep`\",\n    \"9-0\": \"`rateAsk`\",\n    \"10-0\": \"`rateBid`\",\n    \"11-0\": \"`symbol`\",\n    \"12-0\": \"`tags`\",\n    \"13-0\": \"`tradeStatus`\",\n    \"14-0\": \"`tradingHours`\",\n    \"15-0\": \"`urlImage`\",\n    \"16-0\": \"`urlInvestor`\",\n    \"17-0\": \"`sector`\",\n    \"18-0\": \"`longOnly`\",\n    \"0-1\": \"Official company or etf name.\",\n    \"1-1\": \"Either `Stock` or `ETF`.\",\n    \"2-1\": \"Currency the instrument is traded in.\",\n    \"3-1\": \"Exchange the instrument is traded on.\",\n    \"4-1\": \"Type of instrument, `6` - Equity and `7` - ETF.\",\n    \"5-1\": \"Either `true` (default) if instrument can only long (i.e. prevented from shorting) or `false`.\",\n    \"6-1\": \"Maximum order size in whole numbers.\",\n    \"7-1\": \"Minimum order size in whole numbers.\",\n    \"8-1\": \"Increment size for orders in whole numbers.\",\n    \"9-1\": \"Current ask price at the time of request.\",\n    \"10-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\": \"URL of company or etf logo. Default size is 125x125.\",\n    \"16-1\": \"URL of investor relations for stocks or performance data for etfs. **Required when displaying instrument data**.\",\n    \"17-1\": \"Instrument assigned to a sector category.\",\n    \"18-1\": \"Same as `isLongOnly`.\"\n  },\n  \"cols\": 2,\n  \"rows\": 19\n}\n[/block]","excerpt":"Search active instruments by symbol, company name and/or tag.","slug":"search-instruments","type":"get","title":"Search Instruments"}

getSearch Instruments

Search active instruments by symbol, company name and/or tag.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

symbol:
stringAAPL
Ticker symbol.
name:
stringApple
Company name.<br />**Note:** Partial or exact text searches are allowed.
tag:
stringchina
Tag.

Query Params

symbols:
stringAAPL,GOOG,MSFT,TSLA
Comma separated ticker symbols.

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`", "1-0": "`category`", "2-0": "`currencyID`", "3-0": "`exchangeID`", "4-0": "`instrumentTypeID`", "5-0": "`isLongOnly`", "6-0": "`orderSizeMax`", "7-0": "`orderSizeMin`", "8-0": "`orderSizeStep`", "9-0": "`rateAsk`", "10-0": "`rateBid`", "11-0": "`symbol`", "12-0": "`tags`", "13-0": "`tradeStatus`", "14-0": "`tradingHours`", "15-0": "`urlImage`", "16-0": "`urlInvestor`", "17-0": "`sector`", "18-0": "`longOnly`", "0-1": "Official company or etf name.", "1-1": "Either `Stock` or `ETF`.", "2-1": "Currency the instrument is traded in.", "3-1": "Exchange the instrument is traded on.", "4-1": "Type of instrument, `6` - Equity and `7` - ETF.", "5-1": "Either `true` (default) if instrument can only long (i.e. prevented from shorting) or `false`.", "6-1": "Maximum order size in whole numbers.", "7-1": "Minimum order size in whole numbers.", "8-1": "Increment size for orders in whole numbers.", "9-1": "Current ask price at the time of request.", "10-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": "URL of company or etf logo. Default size is 125x125.", "16-1": "URL of investor relations for stocks or performance data for etfs. **Required when displaying instrument data**.", "17-1": "Instrument assigned to a sector category.", "18-1": "Same as `isLongOnly`." }, "cols": 2, "rows": 19 } [/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 }}