{"__v":1,"_id":"56944a695f1c951900644d2e","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-12T00:35:53.026Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"GET /v1/instruments/a67422af-8504-43df-9e63-7361eb0bd99e HTTP/1.1\nHost: api.drivewealth.io\nx-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z\nAccept: application/json\nContent-Type: application/json","language":"http"},{"code":"curl -X GET -H \"x-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z\" -H \"Accept: application/json\" -H \"Content-Type: application/json\" 'http://api.drivewealth.io/v1/instruments/a67422af-8504-43df-9e63-7361eb0bd99e'","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"instrumentID\": \"a67422af-8504-43df-9e63-7361eb0bd99e\",\n    \"name\": \"Apple, Inc.\",\n    \"currencyID\": \"USD\",\n    \"description\": \"Apple Inc. designs, manufactures, and markets mobile communication and media devices, personal computers, and portable digital music players worldwide.\",\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\": 98.5,\n    \"rateBid\": 98.5,\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    \"sector\": \"Technology\",\n    \"priorClose\": 98.54,\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}","language":"json","status":200},{"name":"With Fundamental Data","code":"{\n    \"instrumentID\": \"a67422af-8504-43df-9e63-7361eb0bd99e\",\n    \"name\": \"Apple, Inc.\",\n    \"currencyID\": \"USD\",\n    \"description\": \"Apple Inc. designs, manufactures, and markets mobile communication and media devices, personal computers, and portable digital music players worldwide.\",\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\": 98.5,\n    \"rateBid\": 98.5,\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    \"fundamentalDataModel\": {\n        \"instrumentID\": \"a67422af-8504-43df-9e63-7361eb0bd99e\",\n        \"symbol\": \"AAPL\",\n        \"companyName\": \"APPLE Inc\",\n        \"yesterdayClose\": 96.98,\n        \"openPrice\": 99.06,\n        \"bidPrice\": 98.51,\n        \"askPrice\": 98.56,\n        \"lowPrice\": 97.34,\n        \"highPrice\": 99.06,\n        \"fiftyTwoWeekLowPrice\": 92,\n        \"fiftyTwoWeekHighPrice\": 134.54,\n        \"cumulativeVolume\": 3971304,\n        \"thirtyDayAvgVolume\": 49163683.23809524,\n        \"marketCap\": 540584093760,\n        \"peRatio\": 10.515247,\n        \"dividendYield\": 2.09,\n        \"earningsPerShare\": 9.216876,\n        \"dividend\": 2.03\n    },\n    \"sector\": \"Technology\",\n    \"priorClose\": 98.54,\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}","language":"json","status":200},{"code":"{\n    \"code\": 404,\n    \"message\": \"Instrument not found [instrumentID=a67422af-8504-43df-9e63-7361eb0bd299e]\"\n}","language":"json","status":404}]},"settings":"","auth":"required","params":[{"_id":"56944a695f1c951900644d30","ref":"","in":"path","required":true,"desc":"Instrument ID.","default":"a67422af-8504-43df-9e63-7361eb0bd99e","type":"string","name":"instrumentID"},{"_id":"56944a695f1c951900644d2f","ref":"","in":"query","required":false,"desc":"Use this to show the fundamental data object.","default":"F","type":"string","name":"options"}],"url":"/instruments/:instrumentID"},"isReference":true,"order":0,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Instrument ID Difference in UAT and Production\",\n  \"body\": \"The `instrumentID` values are different between UAT and Production environments. Best practice is not to cache the `instrumentID` in your application.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns a single instrument object. Every instrument has a default list of attributes.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`name`\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"1-0\": \"`currencyID`\",\n    \"2-0\": \"`description`\",\n    \"3-0\": \"`exchangeID`\",\n    \"4-0\": \"`orderSizeMax`\",\n    \"5-0\": \"`orderSizeMin`\",\n    \"6-0\": \"`orderSizeStep`\",\n    \"7-0\": \"`rateAsk`\",\n    \"8-0\": \"`rateBid`\",\n    \"9-0\": \"`symbol`\",\n    \"10-0\": \"`tags`\",\n    \"11-0\": \"`tradeStatus`\",\n    \"12-0\": \"`tradingHours`\",\n    \"13-0\": \"`urlImage`\",\n    \"14-0\": \"`urlInvestor`\",\n    \"0-1\": \"Official company or etf name.\",\n    \"1-1\": \"Currency the instrument is traded in.\",\n    \"2-1\": \"Description of company or etf.\",\n    \"3-1\": \"Exchange the instrument is traded on.\",\n    \"4-1\": \"Maximum order size in whole numbers.\",\n    \"5-1\": \"Minimum order size in whole numbers.\",\n    \"6-1\": \"Increment size for orders in whole numbers.\",\n    \"7-1\": \"Current ask price at the time of request.\",\n    \"8-1\": \"Current bid price at the time of request.\",\n    \"9-1\": \"Ticker symbol for instrument.\",\n    \"10-1\": \"Array of tags.\",\n    \"11-1\": \"Status of instrument: \\n`0` - Inactive \\n`1` - Active\\n`2` - Close Positions only (no new positions)\",\n    \"12-1\": \"Trading hours of instrument. Always in US Eastern Time.\",\n    \"13-1\": \"URL of company or etf logo. Default size is 125x125.\",\n    \"14-1\": \"URL of investor relations for stocks or performance data for etfs. **Required when displaying instrument data**.\",\n    \"15-0\": \"`fundamentalDataModel []`\",\n    \"15-1\": \"Array of fundamental data.\",\n    \"16-0\": \"`fundamentalDataModel.yesterdayClose`\",\n    \"17-0\": \"`fundamentalDataModel.openPrice`\",\n    \"18-0\": \"`fundamentalDataModel.lowPrice`\",\n    \"19-0\": \"`fundamentalDataModel.highPrice`\",\n    \"20-0\": \"`fundamentalDataModel.fiftyTwoWeekLowPrice`\",\n    \"21-0\": \"`fundamentalDataModel.fiftyTwoWeekHighPrice`\",\n    \"22-0\": \"`fundamentalDataModel.cumulativeVolume`\",\n    \"24-0\": \"`fundamentalDataModel.marketCap`\",\n    \"23-0\": \"`fundamentalDataModel.thirtyDayAvgVolume`\",\n    \"26-0\": \"`fundamentalDataModel.dividendYield`\",\n    \"28-0\": \"`fundamentalDataModel.dividend`\",\n    \"27-0\": \"`fundamentalDataModel.earningsPerShare`\",\n    \"25-0\": \"`fundamentalDataModel.peRatio`\",\n    \"29-0\": \"`sector`\",\n    \"30-0\": \"`longOnly`\",\n    \"16-1\": \"Prior closing price until next market open.\",\n    \"17-1\": \"Price at open of market.\",\n    \"18-1\": \"Lowest price for the day.\",\n    \"19-1\": \"Highest price for the day.\",\n    \"20-1\": \"Lowest price for a 52 week time period.\",\n    \"21-1\": \"Highest price for a 52 week time period.\",\n    \"22-1\": \"Cumulative volume for the day.\",\n    \"23-1\": \"30 day average volume.\",\n    \"24-1\": \"Market capitalization.\",\n    \"25-1\": \"Price-earnings ratio (aka \\\"P/E Ratio\\\").\",\n    \"26-1\": \"Dividend yield.\",\n    \"27-1\": \"Earnings per share.\",\n    \"28-1\": \"Dividend.\",\n    \"29-1\": \"Instrument assigned to a sector category.\",\n    \"30-1\": \"Either `true` (default) if instrument can only long (i.e. prevented from shorting) or `false`.\"\n  },\n  \"cols\": 2,\n  \"rows\": 31\n}\n[/block]","excerpt":"Provides details on a specific instrument.","slug":"get_instrument","type":"endpoint","title":"Get Instrument"}

getGet Instrument

Provides details on a specific instrument.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instrumentID:
required
stringa67422af-8504-43df-9e63-7361eb0bd99e
Instrument ID.

Query Params

options:
stringF
Use this to show the fundamental data object.

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "Instrument ID Difference in UAT and Production", "body": "The `instrumentID` values are different between UAT and Production environments. Best practice is not to cache the `instrumentID` in your application." } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] Returns a single instrument object. Every instrument has a default list of attributes. [block:parameters] { "data": { "0-0": "`name`", "h-0": "Attribute", "h-1": "Description", "1-0": "`currencyID`", "2-0": "`description`", "3-0": "`exchangeID`", "4-0": "`orderSizeMax`", "5-0": "`orderSizeMin`", "6-0": "`orderSizeStep`", "7-0": "`rateAsk`", "8-0": "`rateBid`", "9-0": "`symbol`", "10-0": "`tags`", "11-0": "`tradeStatus`", "12-0": "`tradingHours`", "13-0": "`urlImage`", "14-0": "`urlInvestor`", "0-1": "Official company or etf name.", "1-1": "Currency the instrument is traded in.", "2-1": "Description of company or etf.", "3-1": "Exchange the instrument is traded on.", "4-1": "Maximum order size in whole numbers.", "5-1": "Minimum order size in whole numbers.", "6-1": "Increment size for orders in whole numbers.", "7-1": "Current ask price at the time of request.", "8-1": "Current bid price at the time of request.", "9-1": "Ticker symbol for instrument.", "10-1": "Array of tags.", "11-1": "Status of instrument: \n`0` - Inactive \n`1` - Active\n`2` - Close Positions only (no new positions)", "12-1": "Trading hours of instrument. Always in US Eastern Time.", "13-1": "URL of company or etf logo. Default size is 125x125.", "14-1": "URL of investor relations for stocks or performance data for etfs. **Required when displaying instrument data**.", "15-0": "`fundamentalDataModel []`", "15-1": "Array of fundamental data.", "16-0": "`fundamentalDataModel.yesterdayClose`", "17-0": "`fundamentalDataModel.openPrice`", "18-0": "`fundamentalDataModel.lowPrice`", "19-0": "`fundamentalDataModel.highPrice`", "20-0": "`fundamentalDataModel.fiftyTwoWeekLowPrice`", "21-0": "`fundamentalDataModel.fiftyTwoWeekHighPrice`", "22-0": "`fundamentalDataModel.cumulativeVolume`", "24-0": "`fundamentalDataModel.marketCap`", "23-0": "`fundamentalDataModel.thirtyDayAvgVolume`", "26-0": "`fundamentalDataModel.dividendYield`", "28-0": "`fundamentalDataModel.dividend`", "27-0": "`fundamentalDataModel.earningsPerShare`", "25-0": "`fundamentalDataModel.peRatio`", "29-0": "`sector`", "30-0": "`longOnly`", "16-1": "Prior closing price until next market open.", "17-1": "Price at open of market.", "18-1": "Lowest price for the day.", "19-1": "Highest price for the day.", "20-1": "Lowest price for a 52 week time period.", "21-1": "Highest price for a 52 week time period.", "22-1": "Cumulative volume for the day.", "23-1": "30 day average volume.", "24-1": "Market capitalization.", "25-1": "Price-earnings ratio (aka \"P/E Ratio\").", "26-1": "Dividend yield.", "27-1": "Earnings per share.", "28-1": "Dividend.", "29-1": "Instrument assigned to a sector category.", "30-1": "Either `true` (default) if instrument can only long (i.e. prevented from shorting) or `false`." }, "cols": 2, "rows": 31 } [/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 }}