{"__v":12,"_id":"56fbab9e28bdc52000cff76a","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[]},"settings":"","url":""},"body":"Welcome to qplum developer hub!\n\nThis documentation will help you to get portfolios and their details.\n\nThis API is still under development, but we're working hard to improve it. Please [contact us](mailto:dev@qplum.co) if you run into trouble.","category":"56fbab9d28bdc52000cff768","createdAt":"2016-03-30T10:34:06.003Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"getting-started","sync_unique":"","title":"Getting Started with qplum APIs","type":"basic","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

Getting Started with qplum APIs


Welcome to qplum developer hub! This documentation will help you to get portfolios and their details. This API is still under development, but we're working hard to improve it. Please [contact us](mailto:dev@qplum.co) if you run into trouble.
View all 41 endpoints
Welcome to qplum developer hub! This documentation will help you to get portfolios and their details. This API is still under development, but we're working hard to improve it. Please [contact us](mailto:dev@qplum.co) if you run into trouble.
{"__v":16,"_id":"5704cc0b849f721900f2781c","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5704d03a8c69510e00b1e00e","default":"","desc":"Get a recommended portfolio of a particular type. Supported types are: `beta`, `smartbeta`, or `alpha`.","name":"type","ref":"","required":false,"type":"string","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"id\":3084,\n    \"type\":\"beta\",\n    \"stats\":{\n      \"ann_std\":10.54,\n      \"expected_return\":10.13,\n      \"expected_risk\":10.54,\n      \"max_yearly_loss\":31.6,\n      \"ann_turnover\":35.75\n    },\n    \"product_allocations\":[\n      {\n        \"allocation\":6.72,\n        \"display_name\":\"Total International Bonds\",\n        \"symbol\":\"BNDX\",\n        \"sector\":\"FixedIncome\"\n      },\n      {\n\t\t\t\t\"allocation\": 6.77,\n\t\t\t\t\"display_name\": \"U.S. Corporate Bonds\",\n\t\t\t\t\"symbol\": \"LQD\",\n\t\t\t\t\"sector\": \"FixedIncome\"\n\t\t\t},\n      {\n        \"allocation\":15.05,\n        \"display_name\":\"U.S. Real Estate\",\n        \"symbol\":\"VNQ\",\n        \"sector\":\"RealEstate\"\n      },\n      {\n        \"allocation\":3.09,\n        \"display_name\":\"Small-Mid Cap U.S. Stocks\",\n        \"symbol\":\"VXF\",\n        \"sector\":\"Equity\"\n      }\n    ],\n    \"cashAllocation\":0.0\n  },\n  {\n    \"id\":3110,\n    \"type\":\"smartbeta\",\n    \"stats\":{\n      \"ann_std\":10.59,\n      \"expected_return\":10.55,\n      \"expected_risk\":10.59,\n      \"max_yearly_loss\":27.61,\n      \"ann_turnover\":99.82\n    },\n    \"product_allocations\":[\n      {\n        \"allocation\":2.21,\n        \"display_name\":\"Intermediate Term U.S. Govt. Bonds\",\n        \"symbol\":\"BIV\",\n        \"sector\":\"FixedIncome\"\n      },\n      {\n        \"allocation\":5.93,\n        \"display_name\":\"Long Term U.S. Bonds\",\n        \"symbol\":\"BLV\",\n        \"sector\":\"FixedIncome\"\n      },\n      {\n        \"allocation\":7.75,\n        \"display_name\":\"U.S. Real Estate\",\n        \"symbol\":\"VNQ\",\n        \"sector\":\"RealEstate\"\n      },\n      {\n        \"allocation\":2.29,\n        \"display_name\":\"Small Cap U.S. Stocks\",\n        \"symbol\":\"VB\",\n        \"sector\":\"Equity\"\n      }\n    ],\n    \"cashAllocation\":0.0\n  },\n  {\n    \"id\":3100,\n    \"type\":\"alpha\",\n    \"stats\":{\n      \"ann_std\":13.24,\n      \"expected_return\":11.94,\n      \"expected_risk\":13.24,\n      \"max_yearly_loss\":24.0,\n      \"ann_turnover\":360.75\n    },\n    \"productAllocations\":[\n      {\n        \"allocation\":1.95,\n        \"display_name\":\"Intermediate Term U.S. Govt. Bonds\",\n        \"symbol\":\"BIV\",\n        \"sector\":\"FixedIncome\"\n      },\n      {\n        \"allocation\":1.75,\n        \"display_name\":\"Long Term U.S. Bonds\",\n        \"symbol\":\"BLV\",\n        \"sector\":\"FixedIncome\"\n      },    \n      {\n        \"allocation\":4.07,\n        \"display_name\":\"U.S. Real Estate\",\n        \"symbol\":\"VNQ\",\n        \"sector\":\"RealEstate\"\n      },\n      {\n        \"allocation\":0.63,\n        \"display_name\":\"Global Emerging Markets\",\n        \"symbol\":\"IEMG\",\n        \"sector\":\"Equity\"\n      }\n    ],\n    \"cash_allocation\":0.0\n  }\n]","name":""},{"code":"{\n    \"code\": 400,\n    \"message\": \"Invalid value of field : type \"\n}","language":"json","status":400}]},"settings":"","url":"/v:version/recommendation/portfolios"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of portfolio objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Unique identifier of the portfolio\",\n    \"1-0\": \"`type`\",\n    \"1-1\": \"Represents the complexity of the portfolio. `beta` is simple, `smartbeta` is intermediate, and `alpha` is sophisticated.\",\n    \"2-0\": \"`stats`\",\n    \"2-1\": \"Basic statistical parameters of the portfolio\",\n    \"3-0\": \"–`ann_std`\",\n    \"3-1\": \"Standard deviation of the annual returns of the portfolio, since 1995\",\n    \"4-0\": \"–`expected_return`\",\n    \"5-0\": \"–`expected_risk`\",\n    \"6-0\": \"–`max_yearly_loss`\",\n    \"7-0\": \"–`ann_turnover`\",\n    \"7-1\": \"Annual turnover of the portfolio\",\n    \"8-0\": \"`product_allocations`\",\n    \"8-1\": \"List of product allocations\",\n    \"9-0\": \"–`allocation`\",\n    \"9-1\": \"Percentage allocation of the product\",\n    \"10-0\": \"–`display_name`\",\n    \"10-1\": \"Name of the product, e.g. `Vangaurd Total Stock Market ETF`\",\n    \"11-0\": \"–`symbol`\",\n    \"11-1\": \"Ticker of the product, e.g. `VTI`\",\n    \"12-0\": \"–`sector`\",\n    \"12-1\": \"Product sector, e.g. `Equity`\",\n    \"13-0\": \"`cash_allocation`\",\n    \"13-1\": \"Percentage of capital allocated to cash\",\n    \"4-1\": \"Expected return of the portfolio\",\n    \"5-1\": \"Expected risk of the portfolio\",\n    \"6-1\": \"Maximum loss incurred in a one year period\"\n  },\n  \"cols\": 2,\n  \"rows\": 14\n}\n[/block]","category":"56fcf528caad892200847b06","createdAt":"2016-04-06T08:42:51.888Z","editedParams":true,"editedParams2":true,"excerpt":"Get recommended portfolios","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"recommendation","sync_unique":"","title":"Recommended Portfolios","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getRecommended Portfolios

Get recommended portfolios

Query Params

type:
string
Get a recommended portfolio of a particular type. Supported types are: `beta`, `smartbeta`, or `alpha`.
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of portfolio objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`id`", "0-1": "Unique identifier of the portfolio", "1-0": "`type`", "1-1": "Represents the complexity of the portfolio. `beta` is simple, `smartbeta` is intermediate, and `alpha` is sophisticated.", "2-0": "`stats`", "2-1": "Basic statistical parameters of the portfolio", "3-0": "–`ann_std`", "3-1": "Standard deviation of the annual returns of the portfolio, since 1995", "4-0": "–`expected_return`", "5-0": "–`expected_risk`", "6-0": "–`max_yearly_loss`", "7-0": "–`ann_turnover`", "7-1": "Annual turnover of the portfolio", "8-0": "`product_allocations`", "8-1": "List of product allocations", "9-0": "–`allocation`", "9-1": "Percentage allocation of the product", "10-0": "–`display_name`", "10-1": "Name of the product, e.g. `Vangaurd Total Stock Market ETF`", "11-0": "–`symbol`", "11-1": "Ticker of the product, e.g. `VTI`", "12-0": "–`sector`", "12-1": "Product sector, e.g. `Equity`", "13-0": "`cash_allocation`", "13-1": "Percentage of capital allocated to cash", "4-1": "Expected return of the portfolio", "5-1": "Expected risk of the portfolio", "6-1": "Maximum loss incurred in a one year period" }, "cols": 2, "rows": 14 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of portfolio objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`id`", "0-1": "Unique identifier of the portfolio", "1-0": "`type`", "1-1": "Represents the complexity of the portfolio. `beta` is simple, `smartbeta` is intermediate, and `alpha` is sophisticated.", "2-0": "`stats`", "2-1": "Basic statistical parameters of the portfolio", "3-0": "–`ann_std`", "3-1": "Standard deviation of the annual returns of the portfolio, since 1995", "4-0": "–`expected_return`", "5-0": "–`expected_risk`", "6-0": "–`max_yearly_loss`", "7-0": "–`ann_turnover`", "7-1": "Annual turnover of the portfolio", "8-0": "`product_allocations`", "8-1": "List of product allocations", "9-0": "–`allocation`", "9-1": "Percentage allocation of the product", "10-0": "–`display_name`", "10-1": "Name of the product, e.g. `Vangaurd Total Stock Market ETF`", "11-0": "–`symbol`", "11-1": "Ticker of the product, e.g. `VTI`", "12-0": "–`sector`", "12-1": "Product sector, e.g. `Equity`", "13-0": "`cash_allocation`", "13-1": "Percentage of capital allocated to cash", "4-1": "Expected return of the portfolio", "5-1": "Expected risk of the portfolio", "6-1": "Maximum loss incurred in a one year period" }, "cols": 2, "rows": 14 } [/block]
{"__v":0,"_id":"5704d268211f330e0084a66b","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5704d268211f330e0084a66c","default":"","desc":"Unique identifier of a portfolio","name":"id","ref":"","required":true,"type":"int","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\":3081,\n  \"stats\":{\n    \"annStd\":6.26,\n    \"expectedReturn\":7.15,\n    \"expectedRisk\":6.26,\n    \"maxYearlyLoss\":13.88,\n    \"annTurnover\":78.17\n  },\n  \"productAllocations\":[\n    {\n      \"allocation\":4.49,\n      \"displayName\":\"Total International Bonds\",\n      \"symbol\":\"BNDX\",\n      \"sector\":\"FixedIncome\"\n    },\n    {\n      \"allocation\":4.73,\n      \"displayName\":\"U.S. Corporate Bonds\",\n      \"symbol\":\"LQD\",\n      \"sector\":\"FixedIncome\"\n    }, \n    {\n      \"allocation\":9.03,\n      \"displayName\":\"U.S. Real Estate\",\n      \"symbol\":\"VNQ\",\n      \"sector\":\"RealEstate\"\n    },\n    {\n      \"allocation\":4.74,\n      \"displayName\":\"Total U.S. Material Stocks\",\n      \"symbol\":\"VAW\",\n      \"sector\":\"Equity\"\n    }\n  ],\n  \"cashAllocation\":0.0\n}","name":""},{"status":404,"language":"json","code":"{\n\t\"code\": 404,\n\t\"message\": \"Portfolio with id: 5000 not found\"\n}"},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"message\": \"Invalid value of field : id\"\n}"}]},"settings":"","url":"/v:version/portfolios/:id"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns a portfolio object with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Unique identifier of the portfolio\",\n    \"1-0\": \"`stats`\",\n    \"1-1\": \"Basic statistical parameters of the portfolio\",\n    \"2-0\": \"–`ann_std`\",\n    \"2-1\": \"Standard deviation of the annual returns of the portfolio, since 1995\",\n    \"3-0\": \"–`expected_return`\",\n    \"4-0\": \"–`expected_risk`\",\n    \"5-0\": \"–`max_yearly_loss`\",\n    \"6-0\": \"–`ann_turnover`\",\n    \"6-1\": \"Annual turnover of the portfolio\",\n    \"7-0\": \"`product_allocations`\",\n    \"7-1\": \"List of product allocations\",\n    \"8-0\": \"–`allocation`\",\n    \"8-1\": \"Percentage allocation of the product\",\n    \"9-0\": \"–`display_name`\",\n    \"9-1\": \"Name of the product, e.g. `Vangaurd Total Stock Market ETF`\",\n    \"10-0\": \"–`symbol`\",\n    \"10-1\": \"Ticker of the product, e.g. `VTI`\",\n    \"11-0\": \"–`sector`\",\n    \"11-1\": \"Product sector, e.g. `Equity`\",\n    \"12-0\": \"`cash_allocation`\",\n    \"12-1\": \"Percentage of capital allocated to cash\",\n    \"3-1\": \"Expected return of the portfolio\",\n    \"4-1\": \"Expected risk of the portfolio\",\n    \"5-1\": \"Maximum loss incurred in a one year period\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]","category":"5704d424ecfca80e00999138","createdAt":"2016-04-06T09:10:00.252Z","editedParams":true,"editedParams2":true,"excerpt":"Get details of a particular portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-portfolio","sync_unique":"","title":"Portfolio Details","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getPortfolio Details

Get details of a particular portfolio

Path Params

id:
required
integer
Unique identifier of a portfolio
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns a portfolio object with the following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`id`", "0-1": "Unique identifier of the portfolio", "1-0": "`stats`", "1-1": "Basic statistical parameters of the portfolio", "2-0": "–`ann_std`", "2-1": "Standard deviation of the annual returns of the portfolio, since 1995", "3-0": "–`expected_return`", "4-0": "–`expected_risk`", "5-0": "–`max_yearly_loss`", "6-0": "–`ann_turnover`", "6-1": "Annual turnover of the portfolio", "7-0": "`product_allocations`", "7-1": "List of product allocations", "8-0": "–`allocation`", "8-1": "Percentage allocation of the product", "9-0": "–`display_name`", "9-1": "Name of the product, e.g. `Vangaurd Total Stock Market ETF`", "10-0": "–`symbol`", "10-1": "Ticker of the product, e.g. `VTI`", "11-0": "–`sector`", "11-1": "Product sector, e.g. `Equity`", "12-0": "`cash_allocation`", "12-1": "Percentage of capital allocated to cash", "3-1": "Expected return of the portfolio", "4-1": "Expected risk of the portfolio", "5-1": "Maximum loss incurred in a one year period" }, "cols": 2, "rows": 13 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns a portfolio object with the following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`id`", "0-1": "Unique identifier of the portfolio", "1-0": "`stats`", "1-1": "Basic statistical parameters of the portfolio", "2-0": "–`ann_std`", "2-1": "Standard deviation of the annual returns of the portfolio, since 1995", "3-0": "–`expected_return`", "4-0": "–`expected_risk`", "5-0": "–`max_yearly_loss`", "6-0": "–`ann_turnover`", "6-1": "Annual turnover of the portfolio", "7-0": "`product_allocations`", "7-1": "List of product allocations", "8-0": "–`allocation`", "8-1": "Percentage allocation of the product", "9-0": "–`display_name`", "9-1": "Name of the product, e.g. `Vangaurd Total Stock Market ETF`", "10-0": "–`symbol`", "10-1": "Ticker of the product, e.g. `VTI`", "11-0": "–`sector`", "11-1": "Product sector, e.g. `Equity`", "12-0": "`cash_allocation`", "12-1": "Percentage of capital allocated to cash", "3-1": "Expected return of the portfolio", "4-1": "Expected risk of the portfolio", "5-1": "Maximum loss incurred in a one year period" }, "cols": 2, "rows": 13 } [/block]
{"__v":0,"_id":"5704d480211f330e0084a671","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5704d480211f330e0084a672","default":"","desc":"Unique identifier of a portfolio","name":"id","ref":"","required":true,"type":"int","in":"path"}],"results":{"codes":[{"name":"","code":"{\n  \"id\":3081,\n  \"cumulative_log_ret\":[\n    [\n      \"19950103\",\n      -0.000019\n    ],\n    [\n      \"19950104\",\n      0.000207\n    ],\n    [\n      \"19950105\",\n      -0.00039\n    ], \n    [\n      \"20160330\",\n      1.49327\n    ],\n    [\n      \"20160331\",\n      1.493783\n    ],\n    [\n      \"20160401\",\n      1.495204\n    ],\n    [\n      \"20160404\",\n      1.493046\n    ],\n    [\n      \"20160405\",\n      1.488668\n    ]\n  ]\n}","language":"json","status":200},{"status":404,"language":"json","code":"{\n  \"code\": 404,\n\t\"message\": \"Portfolio with id: 5000 not found\"\n}"},{"code":"{\n\t\"code\": 400,\n\t\"message\": \"Invalid value of field : id\"\n}","language":"json","status":400}]},"settings":"","url":"/v:version/portfolios/:id/performance"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns the backtested performance of a portfolio as an array\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Unique identifier of portfolio\",\n    \"1-0\": \"`cumulative_log_ret`\",\n    \"1-1\": \"Cumulative daily log returns of the portfolio since Jan 3rd, 1995 as an array of arrays.\\n\\nThe individual element in the array is:\\n1. Date - `String` (\\\"YYYYMMDD\\\")\\n2. Cumulative Return - `float`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"5704d424ecfca80e00999138","createdAt":"2016-04-06T09:18:56.105Z","editedParams":true,"editedParams2":true,"excerpt":"Get the historical performance of a portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-performance","sync_unique":"","title":"Portfolio Performance","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getPortfolio Performance

Get the historical performance of a portfolio

Path Params

id:
required
integer
Unique identifier of a portfolio
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns the backtested performance of a portfolio as an array [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`id`", "0-1": "Unique identifier of portfolio", "1-0": "`cumulative_log_ret`", "1-1": "Cumulative daily log returns of the portfolio since Jan 3rd, 1995 as an array of arrays.\n\nThe individual element in the array is:\n1. Date - `String` (\"YYYYMMDD\")\n2. Cumulative Return - `float`" }, "cols": 2, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns the backtested performance of a portfolio as an array [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`id`", "0-1": "Unique identifier of portfolio", "1-0": "`cumulative_log_ret`", "1-1": "Cumulative daily log returns of the portfolio since Jan 3rd, 1995 as an array of arrays.\n\nThe individual element in the array is:\n1. Date - `String` (\"YYYYMMDD\")\n2. Cumulative Return - `float`" }, "cols": 2, "rows": 2 } [/block]
{"__v":2,"_id":"570f6338a38d470e0060cb0c","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"_id":"570f6338a38d470e0060cb0d","default":"joe@mainstreet.com","desc":"Primary email","name":"email_address","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb56","default":"Joe","desc":"First name","name":"first_name","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb55","default":"Williams","desc":"Middle name","name":"middle_name","ref":"","required":false,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb54","default":"Doe","desc":"Last name","name":"last_name","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb53","default":"1991-07-06","desc":"Date of birth","name":"dob","ref":"","required":true,"type":"yyyy-mm-dd","in":"body"},{"_id":"570f707ea38d470e0060cb52","default":"241, Marine Ave","desc":"Address line 1","name":"address_line_1","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb51","default":"Opp. PATH","desc":"Address line 2","name":"address_line_2","ref":"","required":false,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb50","default":"Jersey City","desc":"City","name":"city","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb4f","default":"New Jersey","desc":"State","name":"state","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb4e","default":"USA","desc":"Country","name":"country","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb4d","default":"07302","desc":"Postal code","name":"postal_code","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb4c","default":"SSN","desc":"Identification type","name":"id_type","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb4b","default":"666-12-4567","desc":"Identification number","name":"id_no","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb4a","default":"M","desc":"Gender. <br> Options: `M`, `F`","name":"gender","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb49","default":"Single","desc":"Marital status. <br> Options: `Single`, `Married`, `Divorced`, `Widowed`","name":"marital_status","ref":"","required":false,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb48","default":"USA","desc":"Citizenship country code. Follows the ISO 3166-1 format","name":"citizenship_country","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb46","default":"IND","desc":"Birth country code.  Follows the ISO 3166-1 format","name":"birth_country","ref":"","required":false,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb45","default":"B1","desc":"Visa type. Required if not permanent resident of USA. <br> Options: `B1`, `C1`, `E1`, `E2`, `E3`, `F1`, `H1B`, `H2B`, `H3`, `K1`, `L1`, `OTHER`.","name":"visa_type","ref":"","required":false,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb44","default":"2020-10-10","desc":"Visa expiration date. Required if not permanent resident of USA.","name":"visa_expiration_date","ref":"","required":false,"type":"yyyy-mm-dd","in":"body"},{"_id":"570f707ea38d470e0060cb43","default":"Cash","desc":"Trading type. <br> Options:  `Cash`, or `Margin`","name":"trading_type","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb42","default":"Individual","desc":"Trading account type. <br> Options:  `Individual`, `Joint`.","name":"trading_account_type","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb41","default":"6013012100","desc":"Primary phone number, should have 10 digits.","name":"phone_number_1","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb40","default":"6013012101","desc":"Secondary phone number, should have 10 digits.","name":"phone_number_2","ref":"","required":false,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb3f","default":"Employed","desc":"Employment status. <br> Options: `Employed`, `Unemployed`, `Student`, `Retired`.","name":"employment_status","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb3e","default":"XYZ Inc","desc":"Required if `employment_status` is `Employed`.","name":"employer_name","ref":"","required":false,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb3d","default":"Manager","desc":"Required if `employment_status` is `Employed`.","name":"employment_position","ref":"","required":false,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb35","default":"Medium","desc":"Annual income range. <br> Options: `Low`, `Medium`, `High`.","name":"annual_income_range","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb34","default":"Medium","desc":"Risk tolerance. <br> Options: `Low`, `Medium`, `High`.","name":"risk_tolerance","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb33","default":"Growth","desc":"Investment objective. <br> Options: `Growth Income`, `Growth`, `Income`, `Capital Preservation`, `Speculation`, `Maximum Growth`, `Balanced`, `Other`.","name":"investment_objective","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb32","default":"None","desc":"Prior investment experience. <br> Options: `None`, `Limited`, `Good`, `Extensive`.","name":"investment_experience","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb31","default":"Medium","desc":"Liquid net worth. <br> Options: `Low`, `Medium`, `High`","name":"networth_liquid","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb30","default":"Medium","desc":"Total net worth. <br> Options: `Low`, `Medium`, `High`","name":"networth_total","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb2f","default":"Medium","desc":"Liquidity requirement. <br> Options: `Low`, `Medium`, `High`.","name":"liquidity_needs","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb2e","default":"Middle","desc":"Tax bracket. <br> Options: `Low`, `Middle`, `High`.","name":"tax_bracket","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb2d","default":"true","desc":"Acknowledges broker agreement","name":"ack_signed","ref":"","required":true,"type":"boolean","in":"body"},{"_id":"570fa30b986c040e008f7b74","default":"2015-11-03T18:25:02.622Z","desc":"UTC timestamp","name":"ack_signed_timestamp","ref":"","required":true,"type":"timestamp","in":"body"},{"_id":"570f707ea38d470e0060cb2c","default":"true","desc":"Acknowledges qplum RIA agreement","name":"ack_signed_ria","ref":"","required":true,"type":"boolean","in":"body"},{"_id":"570f707ea38d470e0060cb2b","default":"2015-11-03T18:25:02.622Z","desc":"UTC timestamp","name":"ack_signed_ria_timestamp","ref":"","required":true,"type":"timestamp","in":"body"},{"_id":"570f707ea38d470e0060cb2a","default":"DW","desc":"Broker name","name":"broker_name","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb29","default":"02e57c7d-d071-4c63-b491-1194a9939ea5","desc":"User Id from broker","name":"broker_user_id","ref":"","required":true,"type":"string","in":"body"},{"_id":"570f707ea38d470e0060cb28","default":"02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456","desc":"Account number from broker","name":"broker_account_number","ref":"","required":true,"type":"string","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"qplum_id\": \"96bc08f4-1a8c-406c-81ee-afc37d45abc1\"\n}","name":""},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"message\": \"Invalid value of field : field_name\"\n}","name":""}]},"settings":"","url":"/v:version/users"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nOn successful user creation, it returns a `qplum_id` which will be used in future conversations.","category":"570f5f65b85a841900aa94d4","createdAt":"2016-04-14T09:30:32.594Z","editedParams":true,"editedParams2":true,"excerpt":"Create a user with qplum","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"create-user","sync_unique":"","title":"Create User","type":"post","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

postCreate User

Create a user with qplum

Body Params

email_address:
required
stringjoe@mainstreet.com
Primary email
first_name:
required
stringJoe
First name
middle_name:
stringWilliams
Middle name
last_name:
required
stringDoe
Last name
dob:
required
yyyy-mm-dd1991-07-06
Date of birth
address_line_1:
required
string241, Marine Ave
Address line 1
address_line_2:
stringOpp. PATH
Address line 2
city:
required
stringJersey City
City
state:
required
stringNew Jersey
State
country:
required
stringUSA
Country
postal_code:
required
string07302
Postal code
id_type:
required
stringSSN
Identification type
id_no:
required
string666-12-4567
Identification number
gender:
required
stringM
Gender. <br> Options: `M`, `F`
marital_status:
stringSingle
Marital status. <br> Options: `Single`, `Married`, `Divorced`, `Widowed`
citizenship_country:
required
stringUSA
Citizenship country code. Follows the ISO 3166-1 format
birth_country:
stringIND
Birth country code. Follows the ISO 3166-1 format
visa_type:
stringB1
Visa type. Required if not permanent resident of USA. <br> Options: `B1`, `C1`, `E1`, `E2`, `E3`, `F1`, `H1B`, `H2B`, `H3`, `K1`, `L1`, `OTHER`.
visa_expiration_date:
yyyy-mm-dd2020-10-10
Visa expiration date. Required if not permanent resident of USA.
trading_type:
required
stringCash
Trading type. <br> Options: `Cash`, or `Margin`
trading_account_type:
required
stringIndividual
Trading account type. <br> Options: `Individual`, `Joint`.
phone_number_1:
required
string6013012100
Primary phone number, should have 10 digits.
phone_number_2:
string6013012101
Secondary phone number, should have 10 digits.
employment_status:
required
stringEmployed
Employment status. <br> Options: `Employed`, `Unemployed`, `Student`, `Retired`.
employer_name:
stringXYZ Inc
Required if `employment_status` is `Employed`.
employment_position:
stringManager
Required if `employment_status` is `Employed`.
annual_income_range:
required
stringMedium
Annual income range. <br> Options: `Low`, `Medium`, `High`.
risk_tolerance:
required
stringMedium
Risk tolerance. <br> Options: `Low`, `Medium`, `High`.
investment_objective:
required
stringGrowth
Investment objective. <br> Options: `Growth Income`, `Growth`, `Income`, `Capital Preservation`, `Speculation`, `Maximum Growth`, `Balanced`, `Other`.
investment_experience:
required
stringNone
Prior investment experience. <br> Options: `None`, `Limited`, `Good`, `Extensive`.
networth_liquid:
required
stringMedium
Liquid net worth. <br> Options: `Low`, `Medium`, `High`
networth_total:
required
stringMedium
Total net worth. <br> Options: `Low`, `Medium`, `High`
liquidity_needs:
required
stringMedium
Liquidity requirement. <br> Options: `Low`, `Medium`, `High`.
tax_bracket:
required
stringMiddle
Tax bracket. <br> Options: `Low`, `Middle`, `High`.
ack_signed:
required
booleantrue
Acknowledges broker agreement
ack_signed_timestamp:
required
timestamp2015-11-03T18:25:02.622Z
UTC timestamp
ack_signed_ria:
required
booleantrue
Acknowledges qplum RIA agreement
ack_signed_ria_timestamp:
required
timestamp2015-11-03T18:25:02.622Z
UTC timestamp
broker_name:
required
stringDW
Broker name
broker_user_id:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5
User Id from broker
broker_account_number:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5.1452548617456
Account number from broker
[block:api-header] { "type": "basic", "title": "Response" } [/block] On successful user creation, it returns a `qplum_id` which will be used in future conversations.

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] On successful user creation, it returns a `qplum_id` which will be used in future conversations.
{"__v":1,"_id":"570f70be986c040e008f7b16","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"570f714a620fdd190017f7d0","ref":"","required":true,"desc":"Qplum user id","default":"","type":"string","name":"userid","in":"path"}],"results":{"codes":[{"name":"","code":"{\n  \"qplum_id\": \"96bc08f4-1a8c-406c-81ee-afc37d45abc1\",\n  \"request_history\": [{\n    \"portfolio_id\": 3080,\n    \"status\": \"inactive\",\n    \"created_at\": \"2016-04-13T10:35:06.230Z\"\n\t},{\n    \"portfolio_id\": 3081,\n    \"status\": \"new\",\n    \"created_at\": \"2016-04-14T10:35:06.230Z\"\n\t}]\n}","language":"json","status":200},{"name":"","code":"{\n  \"code\": 404,\n  \"message\": \"User with id: 96bc08f4-1a8c-406c-81ee-afc37d45abc not found\"\n}","language":"json","status":404}]},"settings":"","url":"/v:version/users/:userid"},"body":"","category":"570f5f65b85a841900aa94d4","createdAt":"2016-04-14T10:28:14.965Z","editedParams":true,"editedParams2":true,"excerpt":"Get user's request history","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-user","sync_unique":"","title":"Get User Details","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getGet User Details

Get user's request history

Path Params

userid:
required
string
Qplum user id

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"570f72ac986c040e008f7b1b","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"_id":"570f72ac986c040e008f7b1d","ref":"","required":true,"desc":"Qplum user id","default":"","type":"string","name":"userid","in":"path"},{"_id":"570f72ac986c040e008f7b1c","ref":"","required":true,"desc":"Portfolio to be assigned to user","default":"","type":"string","name":"portfolio_id","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"portfolio_id\": 3081,\n  \"status\": \"new\",\n  \"created_at\": \"2016-04-14T10:35:06.230Z\"\n}","name":""},{"status":400,"language":"json","code":"{\n  \"code\": 400,\n  \"message\": \"User already subscribed\"\n}"},{"status":404,"language":"json","code":"{\n  \"code\": 404,\n  \"message\": \"User with id: 78b723b5-6a0e-48b9-aa46-7dbbea2eb6e9 not found\"\n}"}]},"settings":"","url":"/v:version/users/:userid/portfolio"},"body":"","category":"570f5f65b85a841900aa94d4","createdAt":"2016-04-14T10:36:28.082Z","editedParams":true,"editedParams2":true,"excerpt":"Subscribe to new portfolio.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"create-users-portfolio","sync_unique":"","title":"Create Portfolio","type":"post","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

postCreate Portfolio

Subscribe to new portfolio.

Path Params

userid:
required
string
Qplum user id

Body Params

portfolio_id:
required
string
Portfolio to be assigned to user

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"570f72f4d6c6f00e00b98797","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"570f7346620fdd190017f7d5","ref":"","required":true,"desc":"Qplum user id.","default":"","type":"string","name":"userid","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"portfolio_id\": 30,\n  \"status\": \"new\",\n  \"created_at\": \"2016-04-14T10:35:06.230Z\"\n}","name":""},{"status":404,"language":"json","code":"{\n  \"code\": 404,\n  \"message\": \"User with id: 0eb6ca65-50ea-42b0-bd69-7e288156a7e not found\"\n}"}]},"settings":"","url":"/v:version/users/:userid/portfolio/status"},"body":"","category":"570f5f65b85a841900aa94d4","createdAt":"2016-04-14T10:37:40.127Z","editedParams":true,"editedParams2":true,"excerpt":"Get the status of currently subscribed portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-users-portfolio-status","sync_unique":"","title":"Portfolio Status","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getPortfolio Status

Get the status of currently subscribed portfolio

Path Params

userid:
required
string
Qplum user id.

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"5711dcaa5542ed0e002da6e9","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"_id":"5711dcaa5542ed0e002da6ee","ref":"","required":true,"desc":"User Id","default":"0","type":"int","name":"user_id","in":"body"},{"_id":"5711dcaa5542ed0e002da6f0","ref":"","required":true,"desc":"A unique order id for the given user_id","default":"","type":"int","name":"client_order_id","in":"body"},{"_id":"5711dcaa5542ed0e002da6ed","ref":"","required":true,"desc":"Security Name","default":"","type":"string","name":"secname","in":"body"},{"_id":"5711dcaa5542ed0e002da6ec","ref":"","required":true,"desc":"Buy or Sell","default":"","type":"string","name":"buysell","in":"body"},{"_id":"5711dcaa5542ed0e002da6ef","ref":"","required":true,"desc":"Order size","default":"","type":"int","name":"size","in":"body"},{"_id":"5711dcaa5542ed0e002da6eb","default":"","desc":"(Optional) Maximum loss that can be incurred on an order (in cents)","name":"max_loss","ref":"","required":false,"type":"int","in":"body"},{"_id":"5711dcaa5542ed0e002da6ea","default":"","desc":"(Optional) Maximum time (in secs) within which trade must be executed","name":"exec_window","ref":"","required":false,"type":"int","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"buysell\": \"Buy\",\n  \"client_order_id\": 1415,\n  \"init_size\": 250,\n  \"initiation_time\": 1459420239.611039,\n  \"message\": \"Order placed DUPLICATE\",\n  \"order_id\": 1348,\n  \"secname\": \"AAPL\",\n  \"size\": 250,\n  \"success\": 1,\n  \"user_id\": 11\n}","name":""},{"status":405,"language":"json","code":"{\n  \"buysell\": \"Buy\",\n  \"client_order_id\": 1415,\n  \"init_size\": 25,\n  \"initiation_time\": 1459420292.801749,\n  \"message\": \"Order placed MISMATCH - 250 size and 25 AAPL and AAP do not match\",\n  \"order_id\": -1,\n  \"secname\": \"AAP\",\n  \"size\": 25,\n  \"success\": 0,\n  \"user_id\": 11\n}","name":""},{"status":201,"language":"json","code":"{\n  \"buysell\": \"B\",\n  \"client_order_id\": 1422,\n  “exec_window”: 100,\n  \"init_size\": 25,\n  \"initiation_time\": 1459420346.548025,\n  “max_loss”: 1000,\n  \"message\": \"Order placed NEW\",\n  \"order_id\": 1349,\n  \"secname\": \"AAP\",\n  \"size\": 25,\n  \"success\": 1,\n  \"user_id\": 11\n}"},{"status":400,"language":"json","code":"{\n  'error': 'Required params missing (secname, buysell, client_order_id, user_id, size)'\n}"}]},"settings":"5742b362990c970e00386e5e","url":"/v:version/execution/order"},"body":"## Send the order for execution\nSending an order requires a unique user_id (default - 0) and client_order_id.\n\nTry putting in sample order details to see how it works.\nOnce you're ready to use this in your code, you can use this API endpoint by adding the following request header:\n```\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU\n```\n\nPlease contact us at contact@qleap.co if you have any questions. We would be happy to give you the production access token and user_id.","category":"5711dae73590a50e00bba9d3","createdAt":"2016-04-16T06:33:14.487Z","editedParams":true,"editedParams2":true,"excerpt":"Creates a new execution order (combination of client_order_id and user_id is unique)","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"create-order","sync_unique":"","title":"Send Order","type":"post","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

postSend Order

Creates a new execution order (combination of client_order_id and user_id is unique)

Body Params

user_id:
required
integer0
User Id
client_order_id:
required
integer
A unique order id for the given user_id
secname:
required
string
Security Name
buysell:
required
string
Buy or Sell
size:
required
integer
Order size
max_loss:
integer
(Optional) Maximum loss that can be incurred on an order (in cents)
exec_window:
integer
(Optional) Maximum time (in secs) within which trade must be executed
## Send the order for execution Sending an order requires a unique user_id (default - 0) and client_order_id. Try putting in sample order details to see how it works. Once you're ready to use this in your code, you can use this API endpoint by adding the following request header: ``` Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU ``` Please contact us at contact@qleap.co if you have any questions. We would be happy to give you the production access token and user_id.

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



## Send the order for execution Sending an order requires a unique user_id (default - 0) and client_order_id. Try putting in sample order details to see how it works. Once you're ready to use this in your code, you can use this API endpoint by adding the following request header: ``` Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU ``` Please contact us at contact@qleap.co if you have any questions. We would be happy to give you the production access token and user_id.
{"__v":4,"_id":"5711e2cc9bb1cb17001e1e60","api":{"auth":"required","examples":{"codes":[]},"method":"put","params":[{"_id":"57406976bb1b7f0e00ffe8ed","default":"","desc":"User Id","name":"uid","ref":"","required":true,"type":"int","in":"path"},{"_id":"5711e2cc9bb1cb17001e1e61","ref":"","required":true,"desc":"Order Id","default":"","type":"int","name":"id","in":"path"},{"_id":"5718b968f8f7de1900683ef5","ref":"","required":false,"desc":"Maximum loss that can be incurred on an order (in cents)","default":"","type":"int","name":"max_loss","in":"body"},{"_id":"5718b968f8f7de1900683ef4","ref":"","required":false,"desc":"Maximum time (in secs) within which trade must be executed","default":"","type":"int","name":"exec_window","in":"body"}],"results":{"codes":[{"status":202,"language":"json","code":"{\n  \"message\": \"Order modification in progress\"\n}","name":""},{"status":400,"language":"json","code":"{\n  'error': 'uid is required parameter and at least one of max_loss and exec_window'\n}","name":""},{"status":404,"language":"json","code":"{\n  'error':'Order which could be modified was not found. Cancelled or completed order cannot be modified'\n}"}]},"settings":"5742b362990c970e00386e5e","url":"/v:version/execution/order/:id?uid=:uid"},"body":"## Modify an existing order\nModifying an order requires a unique user_id (default - 0) and client_order_id. At the moment, only the maximum loss and the execution window changes are supported.\n\nTry putting in sample order details to see how it works.\nOnce you're ready to use this in your code, you can use this API endpoint by adding the following request header:\n```\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU\n```\n\nPlease contact us at contact@qleap.co if you have any questions. We would be happy to give you the production access token and user_id.","category":"5711dae73590a50e00bba9d3","createdAt":"2016-04-16T06:59:24.011Z","editedParams":true,"editedParams2":true,"excerpt":"Modify an existing order (Only the maximum loss and the execution window changes are supported in v1 API)","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"modify-order","sync_unique":"","title":"Modify Order","type":"put","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

putModify Order

Modify an existing order (Only the maximum loss and the execution window changes are supported in v1 API)

Path Params

uid:
required
integer
User Id
id:
required
integer
Order Id

Body Params

max_loss:
integer
Maximum loss that can be incurred on an order (in cents)
exec_window:
integer
Maximum time (in secs) within which trade must be executed
## Modify an existing order Modifying an order requires a unique user_id (default - 0) and client_order_id. At the moment, only the maximum loss and the execution window changes are supported. Try putting in sample order details to see how it works. Once you're ready to use this in your code, you can use this API endpoint by adding the following request header: ``` Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU ``` Please contact us at contact@qleap.co if you have any questions. We would be happy to give you the production access token and user_id.

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



## Modify an existing order Modifying an order requires a unique user_id (default - 0) and client_order_id. At the moment, only the maximum loss and the execution window changes are supported. Try putting in sample order details to see how it works. Once you're ready to use this in your code, you can use this API endpoint by adding the following request header: ``` Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU ``` Please contact us at contact@qleap.co if you have any questions. We would be happy to give you the production access token and user_id.
{"__v":1,"_id":"5711dddb65324b0e002ad78d","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5711dddb65324b0e002ad78f","ref":"","required":true,"desc":"User Id","default":"","type":"int","name":"uid","in":"path"},{"_id":"5711dddb65324b0e002ad790","ref":"","required":true,"desc":"Order Id","default":"","type":"int","name":"id","in":"path"},{"_id":"5711dddb65324b0e002ad78e","ref":"","required":true,"desc":"coi (client order id) or order_id","default":"","type":"string","name":"filter","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"order\": {\n        \"avg_price\": \"0E-10\",\n        \"buysell\": \"Sell\",\n        \"client_order_id\": 7507,\n        \"init_size\": 17,\n        \"order_id\": 1,\n        \"size_executed\": 0,\n        \"state\": \"SentToExecution\",\n        \"ticker\": \"BIV\",\n        \"transaction_timestamp\": \"2016-05-21 13:01:55\"\n    }\n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Order was not found\"\n}","name":""},{"status":400,"language":"json","code":"{\n  \"error\": \"Allowed filters are coi and order_id and uid is required\"\n}"}]},"settings":"","url":"/v:version/execution/order/:id?uid=:uid&filter=:filter"},"body":"## Execution Status of an existing order request\nIt requires a unique user_id (default - 0) and client_order_id.\n\nTry putting in sample order details to see how it works.\nOnce you're ready to use this in your code, you can use this API endpoint by adding the following request header:\n```\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU\n```\n\nPlease contact us at contact@qleap.co if you have any questions. We would be happy to give you the production access token and user_id.","category":"5711dae73590a50e00bba9d3","createdAt":"2016-04-16T06:38:19.621Z","editedParams":true,"editedParams2":true,"excerpt":"Get the execution status of an existing order","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-order-info","sync_unique":"","title":"Execution Status","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getExecution Status

Get the execution status of an existing order

Path Params

uid:
required
integer
User Id
id:
required
integer
Order Id
filter:
required
string
coi (client order id) or order_id
## Execution Status of an existing order request It requires a unique user_id (default - 0) and client_order_id. Try putting in sample order details to see how it works. Once you're ready to use this in your code, you can use this API endpoint by adding the following request header: ``` Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU ``` Please contact us at contact@qleap.co if you have any questions. We would be happy to give you the production access token and user_id.

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



## Execution Status of an existing order request It requires a unique user_id (default - 0) and client_order_id. Try putting in sample order details to see how it works. Once you're ready to use this in your code, you can use this API endpoint by adding the following request header: ``` Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU ``` Please contact us at contact@qleap.co if you have any questions. We would be happy to give you the production access token and user_id.
{"__v":2,"_id":"5711e0889bb1cb17001e1e5e","api":{"auth":"required","examples":{"codes":[]},"method":"delete","params":[{"_id":"574064a866b3b90e00e8c4e8","ref":"","required":true,"desc":"User Id","default":"","type":"int","name":"uid","in":"path"},{"_id":"5711e0889bb1cb17001e1e5f","ref":"","required":true,"desc":"Order Id","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":202,"language":"json","code":"{\n  'message': 'Order cancellation is in process'\n}","name":""},{"status":404,"language":"json","code":"{\n  'error': 'Order which could be cancelled was not found. Completed or already cancelled orders cannot be cancelled.'\n}","name":""},{"status":400,"language":"json","code":"{\n  \"error\": \"uid is required parameter\"\n}"}]},"settings":"","url":"/v:version/execution/order/:id?uid=:uid"},"body":"","category":"5711dae73590a50e00bba9d3","createdAt":"2016-04-16T06:49:44.085Z","editedParams":true,"editedParams2":true,"excerpt":"Cancel an existing order","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"delete-order","sync_unique":"","title":"Cancel Order","type":"delete","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

deleteCancel Order

Cancel an existing order

Path Params

uid:
required
integer
User Id
id:
required
integer
Order Id

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"5711df925542ed0e002da6f1","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5711df925542ed0e002da6f6","ref":"","required":true,"desc":"User Id","default":"","type":"int","name":"uid","in":"path"},{"_id":"5711df925542ed0e002da6f4","ref":"","required":true,"desc":"Id of the order (order_id or client_order_id)","default":"","type":"int","name":"id","in":"path"},{"_id":"5711df925542ed0e002da6f5","ref":"","required":true,"desc":"coi or order_id","default":"","type":"string","name":"filter","in":"path"},{"_id":"5711df925542ed0e002da6f3","ref":"","required":false,"desc":"Offset","default":"","type":"int","name":"start_id","in":"path"},{"_id":"5711df925542ed0e002da6f2","ref":"","required":false,"desc":"Number of notifications to return","default":"10","type":"int","name":"limit","in":"path"}],"results":{"codes":[{"name":"","code":"{\n    \"notifications\": [\n        {\n            \"client_order_id\": 7507,\n            \"exec_window\": 3600,\n            \"max_loss\": 100,\n            \"message\": \" Order successfully added \",\n            \"notification_id\": 1,\n            \"notification_time\": \"2016-05-21 13:01:55\",\n            \"order_id\": 1,\n            \"type\": \"Accepted\"\n        },\n        {\n            \"client_order_id\": 7507,\n            \"message\": \"Cancel requested\",\n            \"notification_id\": 2,\n            \"notification_time\": \"2016-05-21 13:41:33\",\n            \"order_id\": 1,\n            \"type\": \"Cancellation\"\n        }\n    ]\n}","language":"json","status":200},{"name":"","code":"{\n  \"notifications\": []\n}","language":"json","status":404},{"code":"{\n  \"error\": \"Allowed filters are coi and order_id and uid is required\"\n}","language":"json","status":400}]},"settings":"","url":"/v:version/execution/order/:id/notifications?uid=:uid&filter=:filter&start_id=:start_id&limit=:limit"},"body":"## Get the list of order events (send/cancel/trade) for an execution request\nThis requires a unique user_id (default - 0).\n\nTry putting in sample order details to see how it works.\nOnce you're ready to use this in your code, you can use this API endpoint by adding the following request header:\n```\nAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU\n```\n\nPlease contact us at contact@qplum.co if you have any questions. We would be happy to get you the production access token and user_id.","category":"5711dae73590a50e00bba9d3","createdAt":"2016-04-16T06:45:38.855Z","editedParams":true,"editedParams2":true,"excerpt":"Get execution notifications for an order","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-order-notifications","sync_unique":"","title":"Get Order Notifications","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getGet Order Notifications

Get execution notifications for an order

Path Params

uid:
required
integer
User Id
id:
required
integer
Id of the order (order_id or client_order_id)
filter:
required
string
coi or order_id
start_id:
integer
Offset
limit:
integer10
Number of notifications to return
## Get the list of order events (send/cancel/trade) for an execution request This requires a unique user_id (default - 0). Try putting in sample order details to see how it works. Once you're ready to use this in your code, you can use this API endpoint by adding the following request header: ``` Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU ``` Please contact us at contact@qplum.co if you have any questions. We would be happy to get you the production access token and user_id.

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



## Get the list of order events (send/cancel/trade) for an execution request This requires a unique user_id (default - 0). Try putting in sample order details to see how it works. Once you're ready to use this in your code, you can use this API endpoint by adding the following request header: ``` Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnQiOiJRUExVTV9VQVQifQ.FxTIh8qvZsazACJAvIuKmBFJdD-dhHCPWQsAZL91eTU ``` Please contact us at contact@qplum.co if you have any questions. We would be happy to get you the production access token and user_id.
{"__v":0,"_id":"5711de57a42baf1700154e6d","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5711de57a42baf1700154e6e","default":"","desc":"User Id","name":"uid","ref":"","required":true,"type":"int","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"orders\": [\n        {\n            \"avg_price\": \"0E-10\",\n            \"buysell\": \"Sell\",\n            \"client_order_id\": 7507,\n            \"init_size\": 17,\n            \"order_id\": 1,\n            \"size_executed\": 0,\n            \"state\": \"SentToExecution\",\n            \"ticker\": \"BIV\",\n            \"transaction_timestamp\": \"2016-05-21 13:01:55\"\n        }\n    ]\n}","name":""}]},"settings":"","url":"/v:version/execution/orders/user/:uid"},"body":"","category":"5711dae73590a50e00bba9d3","createdAt":"2016-04-16T06:40:23.365Z","editedParams":true,"editedParams2":true,"excerpt":"Get the list of orders requested by the specific user","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-user-orders","sync_unique":"","title":"Get Orders for Trading User","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getGet Orders for Trading User

Get the list of orders requested by the specific user

Path Params

uid:
required
integer
User Id

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"5720391fdb52d01700f5d0b0","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"572039b3db52d01700f5d0b7","ref":"","required":true,"desc":"User Id","default":"","type":"int","name":"uid","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"notifications\": [\n        {\n            \"client_order_id\": 7507,\n            \"exec_window\": 3600,\n            \"max_loss\": 100,\n            \"message\": \" Order successfully added \",\n            \"notification_id\": 1,\n            \"notification_time\": \"2016-05-21 13:01:55\",\n            \"order_id\": 1,\n            \"type\": \"Accepted\"\n        },\n        {\n            \"buysell\": \"Buy\", \n            \"client_order_id\": 7507, \n            \"created_at\": \"2016-05-21 13:01:55\", \n            \"exec_id\": \"052110162481770\", \n            \"notification_id\": 2, \n            \"notification_time\": \"2016-05-21 14:01:55\", \n            \"order_id\": 121, \n            \"price\": 85.54, \n            \"secname\": \"BIV\", \n            \"size_executed\": 9, \n            \"type\": \"Executed\"\n        }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{\n  \"error\": \"uid is required parameter\"\n}"},{"status":404,"language":"json","code":"{\n  \"error\": \"Resource not found\"\n}"}]},"settings":"","url":"/v:version/execution/notification/list?uid=:uid"},"body":"","category":"5711dae73590a50e00bba9d3","createdAt":"2016-04-27T03:59:27.084Z","editedParams":true,"editedParams2":true,"excerpt":"Get notifications (for different orders) for a specific user","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-user-execution-notification","sync_unique":"","title":"Get Notifications for Trading User","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getGet Notifications for Trading User

Get notifications (for different orders) for a specific user

Path Params

uid:
required
integer
User Id

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"57407414566c450e006cd7b5","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"_id":"5711dcaa5542ed0e002da6ee","ref":"","required":true,"desc":"User Id","default":"","type":"int","name":"user_id","in":"body"},{"_id":"5711dcaa5542ed0e002da6f0","ref":"","required":true,"desc":"Client Order Id","default":"","type":"int","name":"client_order_id","in":"body"},{"_id":"5711dcaa5542ed0e002da6ed","ref":"","required":true,"desc":"Security Name","default":"","type":"string","name":"secname","in":"body"},{"_id":"5711dcaa5542ed0e002da6ec","ref":"","required":true,"desc":"Buy or Sell","default":"","type":"string","name":"buysell","in":"body"},{"_id":"5711dcaa5542ed0e002da6ef","ref":"","required":true,"desc":"Order size","default":"","type":"int","name":"size","in":"body"},{"_id":"5711dcaa5542ed0e002da6eb","default":"","desc":"(Optional) Maximum loss that can be incurred on an order (in cents)","name":"max_loss","ref":"","required":false,"type":"int","in":"body"},{"_id":"5711dcaa5542ed0e002da6ea","default":"","desc":"(Optional) Maximum time (in secs) within which trade must be executed","name":"exec_window","ref":"","required":false,"type":"int","in":"body"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"buysell\": \"B\",\n  \"client_order_id\": 1422,\n  “exec_window”: 100,\n  \"init_size\": 25,\n  \"initiation_time\": 1459420346.548025,\n  “max_loss”: 1000,\n  \"message\": \"Order placed NEW\",\n  \"order_id\": 1349,\n  \"secname\": \"AAP\",\n  \"size\": 25,\n  \"success\": 1,\n  \"user_id\": 11\n}"},{"status":400,"language":"json","code":"{\n  'error': 'Required params missing (secname, buysell, client_order_id, user_id, size)'\n}"},{"status":500,"language":"text","code":"{\n  \"message\": \"Order could not be placed\"\n}"}]},"settings":"5742b362990c970e00386e5e","url":"/v:version/execution/backtest"},"body":"","category":"5711dae73590a50e00bba9d3","createdAt":"2016-05-21T14:43:32.462Z","editedParams":true,"editedParams2":true,"excerpt":"Creates a new execution order simulation","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"create-order-simulation","sync_unique":"","title":"Create Order Simulation","type":"post","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

postCreate Order Simulation

Creates a new execution order simulation

Body Params

user_id:
required
integer
User Id
client_order_id:
required
integer
Client Order Id
secname:
required
string
Security Name
buysell:
required
string
Buy or Sell
size:
required
integer
Order size
max_loss:
integer
(Optional) Maximum loss that can be incurred on an order (in cents)
exec_window:
integer
(Optional) Maximum time (in secs) within which trade must be executed

User Information

Try It Out

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5740731486adcd0e00bcedf5","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"574071ad86adcd0e00bcedf3","ref":"","required":true,"desc":"Order Id","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"saving\": \"0.76\"\n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Order not found or no data available\"\n}","name":""}]},"settings":"","url":"/v1/execution/backtest/:id/saving"},"body":"","category":"5711dae73590a50e00bba9d3","createdAt":"2016-05-21T14:39:16.702Z","editedParams":true,"editedParams2":true,"excerpt":"Get the saving on simulation due to Execution Algorithm  - NOT AVAILABLE IN API EXPLORER","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-saving-on-a-simulation","sync_unique":"","title":"Get Saving on a Simulation","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getGet Saving on a Simulation

Get the saving on simulation due to Execution Algorithm - NOT AVAILABLE IN API EXPLORER

Path Params

id:
required
integer
Order Id

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":3,"_id":"574071ad86adcd0e00bcedf1","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5757bfb76ce4951700e74659","ref":"","required":true,"desc":"User Id","default":"","type":"int","name":"uid","in":"path"},{"_id":"574071ad86adcd0e00bcedf3","ref":"","required":true,"desc":"Client Order Id","default":"","type":"int","name":"id","in":"path"},{"_id":"574071ad86adcd0e00bcedf2","ref":"","required":false,"desc":"client_order_id","default":"client_order_id","type":"string","name":"filter","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"saving\": \"0.76\"\n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Order not found or no data available\"\n}","name":""}]},"settings":"","url":"/v1/execution/order/:id/saving?filter=:filter&uid=:uid"},"body":"","category":"5770cc8d27a5c20e00030aa6","createdAt":"2016-05-21T14:33:17.713Z","editedParams":true,"editedParams2":true,"excerpt":"Get the saving on an order due to Execution Algorithm (eg. id = 10475, uid = 1)","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-saving-on-an-order","sync_unique":"","title":"Get Saving on an Order","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getGet Saving on an Order

Get the saving on an order due to Execution Algorithm (eg. id = 10475, uid = 1)

Path Params

uid:
required
integer
User Id
id:
required
integer
Client Order Id
filter:
stringclient_order_id
client_order_id

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":3,"_id":"57407a8abb1b7f0e00ffe908","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5757c06cc60a290e0098a715","ref":"","required":true,"desc":"User Id","default":"","type":"int","name":"uid","in":"path"},{"_id":"574071ad86adcd0e00bcedf3","ref":"","required":true,"desc":"Client Order Id","default":"","type":"int","name":"id","in":"path"},{"_id":"574071ad86adcd0e00bcedf2","ref":"","required":false,"desc":"client_order_id","default":"client_order_id","type":"string","name":"filter","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"executions\": {\n    \"order\": {\n      \"client_order_id\": 7229, \n      \"ticker\": \"VGT\", \n      \"total_size\": 1\n    }, \n    \"trades\": {\n      \"executions\": [\n        {\n          \"exec_id\": \"051610172317347\", \n          \"exec_timestamp\": \"2016-05-16 18:19:06\", \n          \"initial_price\": \"105.29\", \n          \"price_executed\": \"105.85\", \n          \"saving\": \"-0.56\", \n          \"size_executed\": 1\n        }\n      ], \n      \"total_saving\": \"-0.56\"\n    }\n  }\n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Order not found or no data available\"\n}","name":""}]},"settings":"","url":"/v1/execution/order/:id/executions?filter=:filter&uid=:uid"},"body":"","category":"5770cc8d27a5c20e00030aa6","createdAt":"2016-05-21T15:11:06.954Z","editedParams":true,"editedParams2":true,"excerpt":"Get per-execution savings on an Order (eg. id = 10475, uid = 1)","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"order-demystification","sync_unique":"","title":"Order Demystification","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getOrder Demystification

Get per-execution savings on an Order (eg. id = 10475, uid = 1)

Path Params

uid:
required
integer
User Id
id:
required
integer
Client Order Id
filter:
stringclient_order_id
client_order_id

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":4,"_id":"57203b2e9eaf522b007455db","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"algorithms\": [\n    {\n      \"name\": \"saturn1\",\n      \"short_desc\": \"Saturn1 algorithm uses mean reversion to index strategy to decide a good trade time. On top of that, it is using market microstructure knowledge to efficiently utilize limit orders.\"\n    }\n  ]\n}","name":""}]},"settings":"","url":"/v:version/execution/algorithm/all"},"body":"","category":"5770ccf37209040e005c087d","createdAt":"2016-04-27T04:08:14.913Z","excerpt":"Get list of all execution algorithms which can be used in trading.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-trading-algorithms","sync_unique":"","title":"Get Trading Algorithms","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getGet Trading Algorithms

Get list of all execution algorithms which can be used in trading.


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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"57203baedb52d01700f5d0ba","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"57203baedb52d01700f5d0bb","ref":"","required":true,"desc":"Algorithm Name","default":"","type":"string","name":"algoname","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{   \n  \"algorithm\": {   \n    \"name\": \"saturn1\",     \n    \"short_desc\": \"Saturn1 algorithm uses mean reversion to index strategy to decide a good trade time. On top of that, it is using market microstructure knowledge to efficiently utilize limit orders.\"  \n  } \n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Resource not available\"\n}","name":""}]},"settings":"","url":"/v:version/execution/algorithm/:algoname"},"body":"","category":"5770ccf37209040e005c087d","createdAt":"2016-04-27T04:10:22.495Z","editedParams":true,"editedParams2":true,"excerpt":"Get details for a specific execution algorithm","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-trading-algorithm-details","sync_unique":"","title":"Get Trading Algorithm Details","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getGet Trading Algorithm Details

Get details for a specific execution algorithm

Path Params

algoname:
required
string
Algorithm Name

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"57203c1fa0acd42000af9690","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"57203c1fa0acd42000af9691","ref":"","required":true,"desc":"Algorithm Name","default":"","type":"string","name":"algoname","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"securities\": [\n        {\n            \"adr\": 0,\n            \"contract_name\": \"VANGUARD FTSE\",\n            \"end_date\": \"2030-12-31\",\n            \"etf\": 1,\n            \"exchange\": \"PACF\",\n            \"mds_flag\": 1,\n            \"name\": \"VANGUARD FTSE\",\n            \"secname\": \"VEU\",\n            \"sector\": \"\",\n            \"security_type\": \"stock\",\n            \"sid\": 87,\n            \"start_date\": \"2014-11-03\",\n            \"ticker\": \"VEU\"\n        },\n        {\n            \"adr\": 0,\n            \"contract_name\": \"VANGUARD MF\",\n            \"end_date\": \"2030-12-31\",\n            \"etf\": 1,\n            \"exchange\": \"PACF\",\n            \"mds_flag\": 1,\n            \"name\": \"VANGUARD MF\",\n            \"secname\": \"VCR\",\n            \"sector\": \"\",\n            \"security_type\": \"stock\",\n            \"sid\": 113,\n            \"start_date\": \"2014-11-03\",\n            \"ticker\": \"VCR\"\n        }\n    ]\n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Resource not available\"\n}","name":""}]},"settings":"","url":"/v:version/execution/algorithm/:algoname/supported_securities"},"body":"","category":"5770ccf37209040e005c087d","createdAt":"2016-04-27T04:12:15.424Z","editedParams":true,"editedParams2":true,"excerpt":"Get list of securities which can be traded using the specific  execution algorithm","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-securities-for-algorithm","sync_unique":"","title":"Securities for an Algorithm","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getSecurities for an Algorithm

Get list of securities which can be traded using the specific execution algorithm

Path Params

algoname:
required
string
Algorithm Name

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"572334f47b36300e00926c6f","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"57203ca99eaf522b007455de","ref":"","required":true,"desc":"qplum Security Id","default":"","type":"int","name":"secid","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"algorithms\": [\n    {\n      \"algo_name\": \"saturn1\",\n      \"short_desc\": \"Saturn1 algorithm uses mean reversion to index strategy to decide a good trade time. On top of that, it is using market microstructure knowledge to efficiently utilize limit orders.\"\n    }\n  ]\n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Resource not found\"\n}","name":""}]},"settings":"","url":"/v:version/execution/security/:secid/algorithms"},"body":"","category":"5770ccf37209040e005c087d","createdAt":"2016-04-29T10:18:28.776Z","editedParams":true,"editedParams2":true,"excerpt":"Returns list of execution algorithms which can be used  for trading the security","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-supported-trading-algorithms-for-a-security","sync_unique":"","title":"Algorithms for a Security","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getAlgorithms for a Security

Returns list of execution algorithms which can be used for trading the security

Path Params

secid:
required
integer
qplum Security Id

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"57203ca99eaf522b007455dd","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"57203ca99eaf522b007455de","default":"","desc":"Security ticker","name":"ticker","ref":"","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"algorithms\": [\n    {\n      \"algo_name\": \"saturn1\",\n      \"short_desc\": \"Saturn1 algorithm uses mean reversion to index strategy to decide a good trade time. On top of that, it is using market microstructure knowledge to efficiently utilize limit orders.\"\n    }\n  ]\n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Resource not found\"\n}","name":""}]},"settings":"","url":"/v:version/execution/security/:ticker/algorithms"},"body":"","category":"5770ccf37209040e005c087d","createdAt":"2016-04-27T04:14:33.071Z","editedParams":true,"editedParams2":true,"excerpt":"Returns list of execution algorithms which can be used  for trading the security","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-supported-trading-algorithms","sync_unique":"","title":"Algorithms for a Ticker","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getAlgorithms for a Ticker

Returns list of execution algorithms which can be used for trading the security

Path Params

ticker:
required
string
Security ticker

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":7,"_id":"57203daadb52d01700f5d0bc","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"securities\": [\n        {\n            \"adr\": \"0\",\n            \"end_date\": \"2030-12-31\",\n            \"etf\": \"1\",\n            \"exchange\": \"PACF\",\n            \"mds_flag\": \"1\",\n            \"name\": \"VANGUARD S&P SMALL-CAP\",\n            \"sector\": \"\",\n            \"security_type\": \"stock\",\n            \"sid\": \"69\",\n            \"start_date\": \"2014-11-03\",\n            \"ticker\": \"VIOG\"\n        },\n        {\n            \"adr\": \"0\",\n            \"end_date\": \"2030-12-31\",\n            \"etf\": \"1\",\n            \"exchange\": \"PACF\",\n            \"mds_flag\": \"1\",\n            \"name\": \"VANGUARD FTSE ALL-WORLD\",\n            \"sector\": \"\",\n            \"security_type\": \"stock\",\n            \"sid\": \"87\",\n            \"start_date\": \"2014-11-03\",\n            \"ticker\": \"VEU\"\n        },\n        {\n            \"adr\": \"0\",\n            \"end_date\": \"2030-12-31\",\n            \"etf\": \"1\",\n            \"exchange\": \"PACF\",\n            \"mds_flag\": \"1\",\n            \"name\": \"VANGUARD CONSUMER FUND\",\n            \"sector\": \"\",\n            \"security_type\": \"stock\",\n            \"sid\": \"113\",\n            \"start_date\": \"2014-11-03\",\n            \"ticker\": \"VCR\"\n        }\n    ]\n}","name":""}]},"settings":"","url":"/v:version/execution/security/supported"},"body":"","category":"5770cd56e5a0000e0023c5a4","createdAt":"2016-04-27T04:18:50.883Z","excerpt":"Get list of securities supported by the application","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-security-list-1","sync_unique":"","title":"Securities List","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getSecurities List

Get list of securities supported by the application


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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"57203d669eaf522b007455e0","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"57203d669eaf522b007455e1","ref":"","required":true,"desc":"qplum Security Id","default":"","type":"int","name":"secid","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"security\": [\n    {\n      \"adr\": 0,\n      \"contract_name\": \"VANGUARD FTSE\",\n      \"end_date\": \"2030-12-31\",\n      \"etf\": 1,\n      \"exchange\": \"PACF\",\n      \"mds_flag\": 1,\n      \"name\": \"VANGUARD FTSE\",\n      \"secname\": \"VEU\",\n      \"sector\": \"\",\n      \"security_type\": \"stock\",\n      \"sid\": 87,\n      \"start_date\": \"2014-11-03\",\n      \"ticker\": \"VEU\"\n    }\n  ]\n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Resource not found\"\n}","name":""}]},"settings":"","url":"/v:version/execution/security/:secid"},"body":"","category":"5770cd56e5a0000e0023c5a4","createdAt":"2016-04-27T04:17:42.570Z","editedParams":true,"editedParams2":true,"excerpt":"Get details for a security","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-security-details-1","sync_unique":"","title":"Security Info by SecurityID","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getSecurity Info by SecurityID

Get details for a security

Path Params

secid:
required
integer
qplum Security Id

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"572336ae1f41110e003080d0","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"57203d669eaf522b007455e1","default":"","desc":"Ticker","name":"ticker","ref":"","required":true,"type":"string","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"security\": [\n    {\n      \"adr\": 0,\n      \"contract_name\": \"VANGUARD FTSE\",\n      \"end_date\": \"2030-12-31\",\n      \"etf\": 1,\n      \"exchange\": \"PACF\",\n      \"mds_flag\": 1,\n      \"name\": \"VANGUARD FTSE\",\n      \"secname\": \"VEU\",\n      \"sector\": \"\",\n      \"security_type\": \"stock\",\n      \"sid\": 87,\n      \"start_date\": \"2014-11-03\",\n      \"ticker\": \"VEU\"\n    }\n  ]\n}","name":""},{"status":404,"language":"json","code":"{\n  \"error\": \"Resource not found\"\n}","name":""}]},"settings":"","url":"/v:version/execution/security/:ticker"},"body":"","category":"5770cd56e5a0000e0023c5a4","createdAt":"2016-04-29T10:25:50.570Z","editedParams":true,"editedParams2":true,"excerpt":"Get details for a security","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"get-security-info-by-qplum-security-id","sync_unique":"","title":"Security Info by Ticker","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getSecurity Info by Ticker

Get details for a security

Path Params

ticker:
required
string
Ticker

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

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"5723c8c20426380e00a1a86e","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f1c4110e570e00486c6a","ref":"","required":true,"desc":"Account Number of the brokerage account","default":"","type":"string","name":"userid","in":"query"},{"_id":"5723f1c4110e570e00486c69","default":"","desc":"Start date of the duration over which the information is requested","name":"start_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"},{"_id":"5723f1c4110e570e00486c68","default":"","desc":"End date of the duration over which the information is requested","name":"end_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"date\": \"2016-04-01\",\n        \"log_return\": 0.003429,\n        \"pnl\": 282.09\n    }\n]","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}"},{"status":500,"language":"json","code":"{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/performance/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"The date corresponding to the object\",\n    \"1-0\": \"`log_return`\",\n    \"1-1\": \"The log-return of the portfolio on a given date.\",\n    \"2-0\": \"`pnl`\",\n    \"2-1\": \"The dollar pnl of the portfolio on a given date, e.g. `10.81` for the gain of $10.81\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","category":"5770cdda27a5c20e00030aaf","createdAt":"2016-04-29T20:49:06.984Z","editedParams":true,"editedParams2":true,"excerpt":"Get the daily realised performance of your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-performance-1","sync_unique":"","title":"Daily Performance","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getDaily Performance

Get the daily realised performance of your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`log_return`", "1-1": "The log-return of the portfolio on a given date.", "2-0": "`pnl`", "2-1": "The dollar pnl of the portfolio on a given date, e.g. `10.81` for the gain of $10.81" }, "cols": 2, "rows": 3 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`log_return`", "1-1": "The log-return of the portfolio on a given date.", "2-0": "`pnl`", "2-1": "The dollar pnl of the portfolio on a given date, e.g. `10.81` for the gain of $10.81" }, "cols": 2, "rows": 3 } [/block]
{"__v":2,"_id":"5723cb5f33652f0e000e235d","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f21bfda3c70e005b8904","ref":"","required":true,"desc":"Account Number of the brokerage account","default":"","type":"string","name":"userid","in":"query"},{"_id":"5723f21bfda3c70e005b8903","ref":"","required":true,"desc":"Start date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"start_date","in":"query"},{"_id":"5723f21bfda3c70e005b8902","ref":"","required":true,"desc":"End date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"end_date","in":"query"},{"_id":"5723f21bfda3c70e005b8901","ref":"","required":true,"desc":"List of strategy tickers, uids and/or benchmark tickers","default":"","type":"array_string","name":"compare","in":"query"}],"results":{"codes":[{"name":"","code":"[\n    {\n        \"date\": \"2016-04-01\",\n        \"performance\": [\n            {\n                \"identifier\": \"8BQ05006\",\n                \"log_return\": 0.003429\n            },\n            {\n                \"identifier\": \"BND\",\n                \"log_return\": 0.001122\n            },\n            {\n                \"identifier\": \"SPX\",\n                \"log_return\": 0.006311\n            }\n        ]\n    }\n]","language":"json","status":200},{"name":"","code":"{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}","language":"json","status":400},{"code":"{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}","language":"json","status":404},{"status":500,"language":"json","code":"{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/compare_performance/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"The date corresponding to the object\",\n    \"1-0\": \"`performance`\",\n    \"1-1\": \"Array of **Performance** objects\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**Performance**\nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`identifier`\",\n    \"0-1\": \"Strategy ticker, uid or benchmark ticker\",\n    \"1-1\": \"The associated log-return for that date.\",\n    \"1-0\": \"`log_return `\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"5770cdda27a5c20e00030aaf","createdAt":"2016-04-29T21:00:15.107Z","editedParams":true,"editedParams2":true,"excerpt":"Compare your portfolio's performance to common benchmarks/investments","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-performance-comparison","sync_unique":"","title":"Performance Comparison","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getPerformance Comparison

Compare your portfolio's performance to common benchmarks/investments

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
compare:
required
array of strings
List of strategy tickers, uids and/or benchmark tickers
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`performance`", "1-1": "Array of **Performance** objects" }, "cols": 2, "rows": 2 } [/block] **Performance** Object with the following attributes: [block:parameters] { "data": { "0-0": "`identifier`", "0-1": "Strategy ticker, uid or benchmark ticker", "1-1": "The associated log-return for that date.", "1-0": "`log_return `", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`performance`", "1-1": "Array of **Performance** objects" }, "cols": 2, "rows": 2 } [/block] **Performance** Object with the following attributes: [block:parameters] { "data": { "0-0": "`identifier`", "0-1": "Strategy ticker, uid or benchmark ticker", "1-1": "The associated log-return for that date.", "1-0": "`log_return `", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 2 } [/block]
{"__v":2,"_id":"5723cb8f06c5160e00b77445","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f2c44255580e005937fe","ref":"","required":true,"desc":"Account Number of the brokerage account","default":"","type":"string","name":"userid","in":"query"},{"_id":"5723f2c44255580e005937fd","ref":"","required":true,"desc":"Start date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"start_date","in":"query"},{"_id":"5723f2c44255580e005937fc","ref":"","required":true,"desc":"End date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"end_date","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"ann_std\": 0,\n    \"sharpe\": 88888888,\n    \"max_yearly_loss\": 0,\n    \"ann_ret\": 137.2827174406694,\n    \"max_drawdown\": 0\n}\n","name":""},{"status":400,"language":"json","code":"\n{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n"},{"status":500,"language":"json","code":"{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/performance/summary_stats/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an object with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`ann_ret`\",\n    \"0-1\": \"Annualised returns of the portfolio over the given duration\",\n    \"1-0\": \"`ann_std`\",\n    \"1-1\": \"Annualised standard deviation of returns of the portfolio over the given duration\",\n    \"2-0\": \"`max_yearly_loss `\",\n    \"2-1\": \"Maximum loss incurred in a one year period over the given duration\",\n    \"4-0\": \"`sharpe`\",\n    \"4-1\": \"The realised sharpe ratio of the portfolio over the given duration\",\n    \"3-0\": \"`max_drawdown`\",\n    \"3-1\": \"Maximum drawdown of the portfolio over the given duration\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","category":"5770cdda27a5c20e00030aaf","createdAt":"2016-04-29T21:01:03.457Z","editedParams":true,"editedParams2":true,"excerpt":"Get the realised summary stats of your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"summary-stats","sync_unique":"","title":"Summary Stats","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getSummary Stats

Get the realised summary stats of your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with the following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`ann_ret`", "0-1": "Annualised returns of the portfolio over the given duration", "1-0": "`ann_std`", "1-1": "Annualised standard deviation of returns of the portfolio over the given duration", "2-0": "`max_yearly_loss `", "2-1": "Maximum loss incurred in a one year period over the given duration", "4-0": "`sharpe`", "4-1": "The realised sharpe ratio of the portfolio over the given duration", "3-0": "`max_drawdown`", "3-1": "Maximum drawdown of the portfolio over the given duration" }, "cols": 2, "rows": 5 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with the following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`ann_ret`", "0-1": "Annualised returns of the portfolio over the given duration", "1-0": "`ann_std`", "1-1": "Annualised standard deviation of returns of the portfolio over the given duration", "2-0": "`max_yearly_loss `", "2-1": "Maximum loss incurred in a one year period over the given duration", "4-0": "`sharpe`", "4-1": "The realised sharpe ratio of the portfolio over the given duration", "3-0": "`max_drawdown`", "3-1": "Maximum drawdown of the portfolio over the given duration" }, "cols": 2, "rows": 5 } [/block]
{"__v":4,"_id":"5723c8960426380e00a1a86b","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f176110e570e00486c67","default":"","desc":"Account Number of the brokerage account","name":"userid","ref":"","required":true,"type":"string","in":"query"},{"_id":"5723f176110e570e00486c66","default":"","desc":"Start date of the duration over which the information is requested.","name":"start_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"},{"_id":"5723f176110e570e00486c65","default":"","desc":"End date of the duration over which the information is requested","name":"end_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"date\": \"2016-03-01\",\n        \"holdings\": [\n            {\n                \"position\": 6.90175,\n                \"secname\": \"BIV\"\n            },\n            {\n                \"position\": 6270.39,\n                \"secname\": \"CASH\"\n            },\n            ...\n            {\n                \"position\": 35.29264,\n                \"secname\": \"VGT\"\n            },\n            \n            {\n                \"position\": 39.75568,\n                \"secname\": \"VNQ\"\n            }\n        ]\n    }\n]\n\n","name":""},{"status":400,"language":"json","code":"\n{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n\n"},{"status":500,"language":"json","code":"\n{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/holdings/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"The date corresponding to the object\",\n    \"1-0\": \"`holdings`\",\n    \"1-1\": \"The array of **Holding** objects.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**Holding** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`secname`\",\n    \"1-0\": \"`position`\",\n    \"1-1\": \"The number of shares held in ticker. In case of `CASH` number of dollars.\",\n    \"0-1\": \"Ticker of the product, e.g. `VTI`. Note that `CASH` is also a holding\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"5723c5a10426380e00a1a860","createdAt":"2016-04-29T20:48:22.108Z","editedParams":true,"editedParams2":true,"excerpt":"Get the daily holdings of your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-holdings","sync_unique":"","title":"Portfolio Holdings","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getPortfolio Holdings

Get the daily holdings of your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested.
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`holdings`", "1-1": "The array of **Holding** objects." }, "cols": 2, "rows": 2 } [/block] **Holding** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secname`", "1-0": "`position`", "1-1": "The number of shares held in ticker. In case of `CASH` number of dollars.", "0-1": "Ticker of the product, e.g. `VTI`. Note that `CASH` is also a holding", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`holdings`", "1-1": "The array of **Holding** objects." }, "cols": 2, "rows": 2 } [/block] **Holding** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secname`", "1-0": "`position`", "1-1": "The number of shares held in ticker. In case of `CASH` number of dollars.", "0-1": "Ticker of the product, e.g. `VTI`. Note that `CASH` is also a holding", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 2 } [/block]
{"__v":2,"_id":"5723cb770426380e00a1a879","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f28bfda3c70e005b890a","default":"","desc":"Account Number of the brokerage account","name":"userid","ref":"","required":true,"type":"string","in":"query"},{"_id":"5723f28bfda3c70e005b8909","default":"","desc":"Start date of the duration over which the information is requested","name":"start_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"},{"_id":"5723f28bfda3c70e005b8908","default":"","desc":"End date of the duration over which the information is requested","name":"end_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"date\": \"2016-04-01\",\n        \"risk_level\": 1,\n        \"config\": \"{\\\"capital_allocation_levels\\\":[80,60,40,20,0],\\\"drawdown_levels\\\":[5,10,15,20,25],\\\"name\\\":\\\"SimpleRiskManager\\\",\\\"reallocation_hysteresis_days\\\":21}\",\n        \"num_days_since_last_risk_level_change\": 42,\n        \"drawdown\": 0\n    }\n]\n","name":""},{"status":400,"language":"json","code":"\n{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n"},{"status":500,"language":"json","code":"\n{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/risk_management/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"The date corresponding to the object\",\n    \"1-0\": \"`risk_level`\",\n    \"1-1\": \"The current risk level of the portfolio. A value from 0 to 1, e.g. `0.8`.\",\n    \"2-0\": \"`drawdown`\",\n    \"2-1\": \"The last one year drawdown as of the date associated, e.g. `8` for 8% drawdown\",\n    \"3-0\": \"`config`\",\n    \"3-1\": \"The **RiskManagementSetting** object\",\n    \"4-0\": \"`num_days_since_last_risk_level_change`\",\n    \"4-1\": \"The number of days passed since the last risk level change\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n**RiskManagementSetting** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`reallocation_hysteresis_days`\",\n    \"1-0\": \"`drawdown_levels`\",\n    \"1-1\": \"The drawdown levels of the portfolio as which the risk manager acts ( allocates or deallocates )\",\n    \"0-1\": \"The number of days the risk manager waits for before increasing the risk level by one step\",\n    \"2-0\": \"`capital_allocation_levels`\",\n    \"3-0\": \"`name`\",\n    \"3-1\": \"The internal name of the risk manager\",\n    \"2-1\": \"The capital allocation levels associated with the drawdown levels\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"5723c5a10426380e00a1a860","createdAt":"2016-04-29T21:00:39.652Z","editedParams":true,"editedParams2":true,"excerpt":"Get the daily risk management related information associated with your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"risk-management","sync_unique":"","title":"Risk management","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getRisk management

Get the daily risk management related information associated with your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`risk_level`", "1-1": "The current risk level of the portfolio. A value from 0 to 1, e.g. `0.8`.", "2-0": "`drawdown`", "2-1": "The last one year drawdown as of the date associated, e.g. `8` for 8% drawdown", "3-0": "`config`", "3-1": "The **RiskManagementSetting** object", "4-0": "`num_days_since_last_risk_level_change`", "4-1": "The number of days passed since the last risk level change" }, "cols": 2, "rows": 5 } [/block] **RiskManagementSetting** Object with the following attributes: [block:parameters] { "data": { "0-0": "`reallocation_hysteresis_days`", "1-0": "`drawdown_levels`", "1-1": "The drawdown levels of the portfolio as which the risk manager acts ( allocates or deallocates )", "0-1": "The number of days the risk manager waits for before increasing the risk level by one step", "2-0": "`capital_allocation_levels`", "3-0": "`name`", "3-1": "The internal name of the risk manager", "2-1": "The capital allocation levels associated with the drawdown levels", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 4 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`risk_level`", "1-1": "The current risk level of the portfolio. A value from 0 to 1, e.g. `0.8`.", "2-0": "`drawdown`", "2-1": "The last one year drawdown as of the date associated, e.g. `8` for 8% drawdown", "3-0": "`config`", "3-1": "The **RiskManagementSetting** object", "4-0": "`num_days_since_last_risk_level_change`", "4-1": "The number of days passed since the last risk level change" }, "cols": 2, "rows": 5 } [/block] **RiskManagementSetting** Object with the following attributes: [block:parameters] { "data": { "0-0": "`reallocation_hysteresis_days`", "1-0": "`drawdown_levels`", "1-1": "The drawdown levels of the portfolio as which the risk manager acts ( allocates or deallocates )", "0-1": "The number of days the risk manager waits for before increasing the risk level by one step", "2-0": "`capital_allocation_levels`", "3-0": "`name`", "3-1": "The internal name of the risk manager", "2-1": "The capital allocation levels associated with the drawdown levels", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 4 } [/block]
{"__v":2,"_id":"5723cba52ea9480e00b3c760","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f31ad872170e004c1a6c","ref":"","required":true,"desc":"Account Number of the brokerage account","default":"","type":"string","name":"userid","in":"query"},{"_id":"5723f31ad872170e004c1a6b","default":"","desc":"Start date of the duration over which the information is requested","name":"start_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"},{"_id":"5723f31ad872170e004c1a6a","default":"","desc":"End date of the duration over which the information is requested","name":"end_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"date\": \"2016-04-01\",\n        \"product_allocation\": [\n            {\n                \"allocation\": 0.72,\n                \"secname\": \"BIV\"\n            },\n            {\n                \"allocation\": 0.72,\n                \"secname\": \"BLV\"\n            },\n            ...\n            {\n                \"allocation\": 7.61,\n                \"secname\": \"CASH\"\n            },\n            {\n                \"allocation\": 4.04,\n                \"secname\": \"VNQ\"\n            }\n        ]\n    }\n]\n","name":""},{"status":400,"language":"json","code":"\n{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n"},{"status":500,"language":"json","code":"{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/allocation/products/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"The date corresponding to the object\",\n    \"1-0\": \"`product_allocation`\",\n    \"1-1\": \"The array of **ProductAllocation** objects.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**ProductAllocation** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`secame`\",\n    \"1-0\": \"`allocation`\",\n    \"1-1\": \"The percentage allocation to the product, e.g. `10` if the allocation is 10%\",\n    \"0-1\": \"Ticker of the product, e.g. `VTI`\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"5723c5a10426380e00a1a860","createdAt":"2016-04-29T21:01:25.248Z","editedParams":true,"editedParams2":true,"excerpt":"Get the daily product allocation of your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-product-allocation","sync_unique":"","title":"Product Allocation","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getProduct Allocation

Get the daily product allocation of your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`product_allocation`", "1-1": "The array of **ProductAllocation** objects." }, "cols": 2, "rows": 2 } [/block] **ProductAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secame`", "1-0": "`allocation`", "1-1": "The percentage allocation to the product, e.g. `10` if the allocation is 10%", "0-1": "Ticker of the product, e.g. `VTI`", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`product_allocation`", "1-1": "The array of **ProductAllocation** objects." }, "cols": 2, "rows": 2 } [/block] **ProductAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secame`", "1-0": "`allocation`", "1-1": "The percentage allocation to the product, e.g. `10` if the allocation is 10%", "0-1": "Ticker of the product, e.g. `VTI`", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 2 } [/block]
{"__v":2,"_id":"5723cbca7d2fbc0e00c47919","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f3dfeae5090e00ee6210","default":"","desc":"Account Number of the brokerage account","name":"userid","ref":"","required":true,"type":"string","in":"query"},{"_id":"5723f3dfeae5090e00ee620f","default":"","desc":"Start date of the duration over which the information is requested","name":"start_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"},{"_id":"5723f3dfeae5090e00ee620e","default":"","desc":"End date of the duration over which the information is requested","name":"end_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"date\": \"2016-04-01\",\n        \"sector_allocation\": [\n            {\n                \"sector\": \"CASH\",\n                \"allocation\": 7.61\n            },\n            {\n                \"sector\": \"Equity\",\n                \"allocation\": 59.75\n            },\n            {\n                \"sector\": \"FixedIncome\",\n                \"allocation\": 28.6\n            },\n            {\n                \"sector\": \"RealEstate\",\n                \"allocation\": 4.04\n            }\n        ]\n    }\n]","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n"},{"status":500,"language":"json","code":"\n{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/allocation/sectors/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"The date corresponding to the object\",\n    \"1-0\": \"`sector_allocation`\",\n    \"1-1\": \"The array of **SectorAllocation** objects.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**SectorAllocation** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`sector`\",\n    \"1-0\": \"`allocation`\",\n    \"1-1\": \"The percentage allocation to the sector, e.g. `10` if the allocation is 10%\",\n    \"0-1\": \"Name of the sector, e.g. `Equity`\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"5723c5a10426380e00a1a860","createdAt":"2016-04-29T21:02:02.015Z","editedParams":true,"editedParams2":true,"excerpt":"Get the daily sector allocation of your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-sector-allocation","sync_unique":"","title":"Sector Allocation","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getSector Allocation

Get the daily sector allocation of your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`sector_allocation`", "1-1": "The array of **SectorAllocation** objects." }, "cols": 2, "rows": 2 } [/block] **SectorAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`sector`", "1-0": "`allocation`", "1-1": "The percentage allocation to the sector, e.g. `10` if the allocation is 10%", "0-1": "Name of the sector, e.g. `Equity`", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`sector_allocation`", "1-1": "The array of **SectorAllocation** objects." }, "cols": 2, "rows": 2 } [/block] **SectorAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`sector`", "1-0": "`allocation`", "1-1": "The percentage allocation to the sector, e.g. `10` if the allocation is 10%", "0-1": "Name of the sector, e.g. `Equity`", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 2 } [/block]
{"__v":3,"_id":"5723cc7a2ea9480e00b3c763","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f5474255580e00593806","ref":"","required":true,"desc":"Account Number of the brokerage account","default":"","type":"string","name":"userid","in":"query"},{"_id":"5723f5474255580e00593805","ref":"","required":true,"desc":"Date as of which which the information is requested","default":"","type":"yyyy-mm-dd","name":"date","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    'sector_allocation': [{\n        'sector': 'FixedIncome',\n        'allocation': 16.66\n    }, {\n        'sector': 'CASH',\n        'allocation': 1.06\n    }, {\n        'sector': 'Equity',\n        'allocation': 76.01\n    }, {\n        'sector': 'RealEstate',\n        'allocation': 6.27\n    }],\n    'risk_level': 1.0,\n    'strategy_return_breakdown': [{\n        'nominal_return': -0.001064,\n        'strategy': 'BOLT-RXKAIP'\n    }, {\n        'nominal_return': 0.0,\n        'strategy': 'LIQUID'\n    }],\n    'strategy_pnl_breakdown': [{\n        'pnl': -248.4,\n        'strategy': 'BOLT-RXKAIP'\n    }, {\n        'pnl': 0.0,\n        'strategy': 'LIQUID'\n    }],\n    'num_days_since_last_risk_level_change': 51.0,\n    'holdings': [{\n        'position': 64.00559,\n        'secname': 'VOO'\n    }, \n    ...\n    {\n        'position': 135.82796,\n        'secname': 'VYM'\n    }],\n    'portfolio_value': 233101.687308,\n    'product_return_breakdown': [{\n        'secname': 'VMBS',\n        'nominal_return': -3e-06\n    }, {\n        'secname': 'VNQ',\n        'nominal_return': -0.000158\n    }, {\n        'secname': 'VNQI',\n        'nominal_return': -5.8e-05\n    }, \n    ...\n    {\n        'secname': 'VYM',\n        'nominal_return': 3e-06\n    }],\n    'log_return': -0.001065,\n    'strategy_allocation': {\n        'BOLT-RXKAIP': 99,\n        'LIQUID': 1\n    },\n    'sector_return_breakdown': [{\n        'sector': 'Equity',\n        'nominal_return': -0.000631\n    }, {\n        'sector': 'FixedIncome',\n        'nominal_return': -0.000217\n    }, {\n        'sector': 'RealEstate',\n        'nominal_return': -0.000216\n    }],\n    'product_allocation': [{\n        'allocation': 5.24,\n        'secname': 'VOO'\n    }, {\n        'allocation': 2.06,\n        'secname': 'VOE'\n    },\n    ...\n    {\n        'allocation': 0.82,\n        'secname': 'VHT'\n    }, {\n        'allocation': 4.06,\n        'secname': 'VYM'\n    }],\n    'product_pnl_breakdown': [{\n        'secname': 'VMBS',\n        'pnl': -0.74\n    }, {\n        'secname': 'VNQ',\n        'pnl': -36.9\n    },\n    ...\n    {\n        'secname': 'TLT',\n        'pnl': -59.85\n    }, {\n        'secname': 'VYM',\n        'pnl': 0.79\n    }],\n    'pnl': -248.395127,\n    'drawdown': 0.11,\n    'date': '2016-04-14',\n    'config': '{\"capital_allocation_levels\":[80,60,40,20,0],\"drawdown_levels\":[5,10,15,20,25],\"name\":\"SimpleRiskManager\",\"reallocation_hysteresis_days\":21}',\n    'sector_pnl_breakdown': [{\n        'sector': 'Equity',\n        'pnl': -147.35\n    }, {\n        'sector': 'FixedIncome',\n        'pnl': -50.63\n    }, {\n        'sector': 'RealEstate',\n        'pnl': -50.41\n    }]\n}","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}"},{"status":500,"language":"json","code":"{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/portfolio_snapshot/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an object with following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"Date as of which the information is requested\",\n    \"1-0\": \"`product_allocation`\",\n    \"1-1\": \"The array of **ProductAllocation** objects\",\n    \"2-0\": \"`sector_allocation`\",\n    \"2-1\": \"The array of **SectorAllocation** objects\",\n    \"4-0\": \"`holdings`\",\n    \"4-1\": \"The array of **Holding** objects\",\n    \"5-0\": \"`product_performance_breakdown`\",\n    \"6-0\": \"`sector_performance_breakdown`\",\n    \"7-0\": \"`strategy_performance_breakdown`\",\n    \"8-0\": \"`pnl`\",\n    \"9-0\": \"`log_return`\",\n    \"12-0\": \"`config`\",\n    \"12-1\": \"Risk Manager Config of the portfolio\",\n    \"13-0\": \"`drawdown`\",\n    \"13-1\": \"Percentage drawdown of the portfolio as of a given date\",\n    \"10-0\": \"`portfolio_value`\",\n    \"10-1\": \"The net value of the portfolio in dollars as of the given date\",\n    \"9-1\": \"The log return of the portfolio on the given date\",\n    \"8-1\": \"The pnl of the portfolio on the given date\",\n    \"3-0\": \"`strategy_allocation`\",\n    \"3-1\": \"The array of **StrategyAllocation** objects\",\n    \"11-0\": \"`risk_level`\",\n    \"11-1\": \"The current risk level\",\n    \"5-1\": \"The array of **ProductPerformanceBreakdown** objects\",\n    \"6-1\": \"The array of **SectorPerformanceBreakdown** objects\",\n    \"7-1\": \"The array of **StrategyPerformanceBreakdown** objects\"\n  },\n  \"cols\": 2,\n  \"rows\": 14\n}\n[/block]\n**ProductAllocation** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`secame`\",\n    \"0-1\": \"Ticker of the product, e.g. `VTI`\",\n    \"1-0\": \"`allocation`\",\n    \"1-1\": \"The percentage allocation to the product, e.g. `10` if the allocation is 10%\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**SectorAllocation** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`sector`\",\n    \"0-1\": \"Name of the sector, e.g. `Equity`\",\n    \"1-0\": \"`allocation`\",\n    \"1-1\": \"The percentage allocation to the sector, e.g. `10` if the allocation is 10%\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**StrategyAllocation** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`ticker_name`\",\n    \"0-1\": \"Ticker of the strategy, e.g. `BOLT-RXKAIP`\",\n    \"1-0\": \"`allocation`\",\n    \"1-1\": \"The percentage allocation to the sector, e.g. `10` if the allocation is 10%\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**Holding** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`secname`\",\n    \"0-1\": \"Ticker of the product, e.g. `VTI`. Note that `CASH` is also a holding\",\n    \"1-0\": \"`position`\",\n    \"1-1\": \"The number of shares held in ticker. In case of `CASH` number of dollars.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**ProductPerformanceBreakdown** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`secame`\",\n    \"0-1\": \"Ticker of the product, e.g. `VTI`\",\n    \"1-0\": \"`nominal_return`\",\n    \"1-1\": \"The contribution to the net nominal return by a given product, e.g. `0.01` if the portfolio went up by `1%` due to this product on a given date\",\n    \"2-0\": \"`pnl`\",\n    \"2-1\": \"The contribution to pnl by a given secname, e.g. `10.23`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n**SectorPerformanceBreakdown** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`sector`\",\n    \"0-1\": \"Name of the sector, e.g. `Equity`\",\n    \"1-0\": \"`nominal_return`\",\n    \"1-1\": \"The contribution to the net nominal return by a given sector, e.g. `0.01` if the portfolio went up by `1%` due to this sector on a given date\",\n    \"2-0\": \"`pnl`\",\n    \"2-1\": \"The contribution to pnl by a given sector, e.g. `10.23`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n**StrategyPerformanceBreakdown** \nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`ticker_name`\",\n    \"0-1\": \"Ticker of the strategy, e.g. `BOLT-RXKAIP`\",\n    \"1-0\": \"`nominal_return`\",\n    \"1-1\": \"The contribution to the net nominal return by a given strategy, e.g. `0.01` if the portfolio went up by `1%` due to this strategy on a given date\",\n    \"2-0\": \"`pnl`\",\n    \"2-1\": \"The contribution to pnl by a given strategy, e.g. `10.23`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","category":"5723c5a10426380e00a1a860","createdAt":"2016-04-29T21:04:58.799Z","editedParams":true,"editedParams2":true,"excerpt":"All important information about the portfolio as of a given date","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-snapshot","sync_unique":"","title":"Portfolio Snapshot","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getPortfolio Snapshot

All important information about the portfolio as of a given date

Query Params

userid:
required
string
Account Number of the brokerage account
date:
required
yyyy-mm-dd
Date as of which which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "Date as of which the information is requested", "1-0": "`product_allocation`", "1-1": "The array of **ProductAllocation** objects", "2-0": "`sector_allocation`", "2-1": "The array of **SectorAllocation** objects", "4-0": "`holdings`", "4-1": "The array of **Holding** objects", "5-0": "`product_performance_breakdown`", "6-0": "`sector_performance_breakdown`", "7-0": "`strategy_performance_breakdown`", "8-0": "`pnl`", "9-0": "`log_return`", "12-0": "`config`", "12-1": "Risk Manager Config of the portfolio", "13-0": "`drawdown`", "13-1": "Percentage drawdown of the portfolio as of a given date", "10-0": "`portfolio_value`", "10-1": "The net value of the portfolio in dollars as of the given date", "9-1": "The log return of the portfolio on the given date", "8-1": "The pnl of the portfolio on the given date", "3-0": "`strategy_allocation`", "3-1": "The array of **StrategyAllocation** objects", "11-0": "`risk_level`", "11-1": "The current risk level", "5-1": "The array of **ProductPerformanceBreakdown** objects", "6-1": "The array of **SectorPerformanceBreakdown** objects", "7-1": "The array of **StrategyPerformanceBreakdown** objects" }, "cols": 2, "rows": 14 } [/block] **ProductAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secame`", "0-1": "Ticker of the product, e.g. `VTI`", "1-0": "`allocation`", "1-1": "The percentage allocation to the product, e.g. `10` if the allocation is 10%" }, "cols": 2, "rows": 2 } [/block] **SectorAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`sector`", "0-1": "Name of the sector, e.g. `Equity`", "1-0": "`allocation`", "1-1": "The percentage allocation to the sector, e.g. `10` if the allocation is 10%" }, "cols": 2, "rows": 2 } [/block] **StrategyAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`ticker_name`", "0-1": "Ticker of the strategy, e.g. `BOLT-RXKAIP`", "1-0": "`allocation`", "1-1": "The percentage allocation to the sector, e.g. `10` if the allocation is 10%" }, "cols": 2, "rows": 2 } [/block] **Holding** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secname`", "0-1": "Ticker of the product, e.g. `VTI`. Note that `CASH` is also a holding", "1-0": "`position`", "1-1": "The number of shares held in ticker. In case of `CASH` number of dollars." }, "cols": 2, "rows": 2 } [/block] **ProductPerformanceBreakdown** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secame`", "0-1": "Ticker of the product, e.g. `VTI`", "1-0": "`nominal_return`", "1-1": "The contribution to the net nominal return by a given product, e.g. `0.01` if the portfolio went up by `1%` due to this product on a given date", "2-0": "`pnl`", "2-1": "The contribution to pnl by a given secname, e.g. `10.23`" }, "cols": 2, "rows": 3 } [/block] **SectorPerformanceBreakdown** Object with the following attributes: [block:parameters] { "data": { "0-0": "`sector`", "0-1": "Name of the sector, e.g. `Equity`", "1-0": "`nominal_return`", "1-1": "The contribution to the net nominal return by a given sector, e.g. `0.01` if the portfolio went up by `1%` due to this sector on a given date", "2-0": "`pnl`", "2-1": "The contribution to pnl by a given sector, e.g. `10.23`" }, "cols": 2, "rows": 3 } [/block] **StrategyPerformanceBreakdown** Object with the following attributes: [block:parameters] { "data": { "0-0": "`ticker_name`", "0-1": "Ticker of the strategy, e.g. `BOLT-RXKAIP`", "1-0": "`nominal_return`", "1-1": "The contribution to the net nominal return by a given strategy, e.g. `0.01` if the portfolio went up by `1%` due to this strategy on a given date", "2-0": "`pnl`", "2-1": "The contribution to pnl by a given strategy, e.g. `10.23`" }, "cols": 2, "rows": 3 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "Date as of which the information is requested", "1-0": "`product_allocation`", "1-1": "The array of **ProductAllocation** objects", "2-0": "`sector_allocation`", "2-1": "The array of **SectorAllocation** objects", "4-0": "`holdings`", "4-1": "The array of **Holding** objects", "5-0": "`product_performance_breakdown`", "6-0": "`sector_performance_breakdown`", "7-0": "`strategy_performance_breakdown`", "8-0": "`pnl`", "9-0": "`log_return`", "12-0": "`config`", "12-1": "Risk Manager Config of the portfolio", "13-0": "`drawdown`", "13-1": "Percentage drawdown of the portfolio as of a given date", "10-0": "`portfolio_value`", "10-1": "The net value of the portfolio in dollars as of the given date", "9-1": "The log return of the portfolio on the given date", "8-1": "The pnl of the portfolio on the given date", "3-0": "`strategy_allocation`", "3-1": "The array of **StrategyAllocation** objects", "11-0": "`risk_level`", "11-1": "The current risk level", "5-1": "The array of **ProductPerformanceBreakdown** objects", "6-1": "The array of **SectorPerformanceBreakdown** objects", "7-1": "The array of **StrategyPerformanceBreakdown** objects" }, "cols": 2, "rows": 14 } [/block] **ProductAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secame`", "0-1": "Ticker of the product, e.g. `VTI`", "1-0": "`allocation`", "1-1": "The percentage allocation to the product, e.g. `10` if the allocation is 10%" }, "cols": 2, "rows": 2 } [/block] **SectorAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`sector`", "0-1": "Name of the sector, e.g. `Equity`", "1-0": "`allocation`", "1-1": "The percentage allocation to the sector, e.g. `10` if the allocation is 10%" }, "cols": 2, "rows": 2 } [/block] **StrategyAllocation** Object with the following attributes: [block:parameters] { "data": { "0-0": "`ticker_name`", "0-1": "Ticker of the strategy, e.g. `BOLT-RXKAIP`", "1-0": "`allocation`", "1-1": "The percentage allocation to the sector, e.g. `10` if the allocation is 10%" }, "cols": 2, "rows": 2 } [/block] **Holding** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secname`", "0-1": "Ticker of the product, e.g. `VTI`. Note that `CASH` is also a holding", "1-0": "`position`", "1-1": "The number of shares held in ticker. In case of `CASH` number of dollars." }, "cols": 2, "rows": 2 } [/block] **ProductPerformanceBreakdown** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secame`", "0-1": "Ticker of the product, e.g. `VTI`", "1-0": "`nominal_return`", "1-1": "The contribution to the net nominal return by a given product, e.g. `0.01` if the portfolio went up by `1%` due to this product on a given date", "2-0": "`pnl`", "2-1": "The contribution to pnl by a given secname, e.g. `10.23`" }, "cols": 2, "rows": 3 } [/block] **SectorPerformanceBreakdown** Object with the following attributes: [block:parameters] { "data": { "0-0": "`sector`", "0-1": "Name of the sector, e.g. `Equity`", "1-0": "`nominal_return`", "1-1": "The contribution to the net nominal return by a given sector, e.g. `0.01` if the portfolio went up by `1%` due to this sector on a given date", "2-0": "`pnl`", "2-1": "The contribution to pnl by a given sector, e.g. `10.23`" }, "cols": 2, "rows": 3 } [/block] **StrategyPerformanceBreakdown** Object with the following attributes: [block:parameters] { "data": { "0-0": "`ticker_name`", "0-1": "Ticker of the strategy, e.g. `BOLT-RXKAIP`", "1-0": "`nominal_return`", "1-1": "The contribution to the net nominal return by a given strategy, e.g. `0.01` if the portfolio went up by `1%` due to this strategy on a given date", "2-0": "`pnl`", "2-1": "The contribution to pnl by a given strategy, e.g. `10.23`" }, "cols": 2, "rows": 3 } [/block]
{"__v":2,"_id":"5723cc9c2887bb0e00bb9d11","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f574fda3c70e005b8910","default":"","desc":"Account Number of the brokerage account","name":"userid","ref":"","required":true,"type":"string","in":"query"},{"_id":"5723f574fda3c70e005b890f","default":"","desc":"Start date of the duration over which the information is requested","name":"start_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"},{"_id":"5723f574fda3c70e005b890e","default":"","desc":"End date of the duration over which the information is requested","name":"end_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\"date\": \"2016-02-18\",\n    \"amount\": 25000.0}, \n  {\"date\": \"2016-03-16\",\n   \"amount\": 45000.0}, \n  {\"date\": \"2016-04-04\",\n   \"amount\": 50000.0}, \n  {\"date\": \"2016-04-06\", \n   \"amount\": 50000.0}\n]\n","name":""},{"status":400,"language":"json","code":"\n{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n"},{"status":500,"language":"json","code":"\n{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/allocation/funds/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an object with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"Date on which fund was added\",\n    \"1-0\": \"`amount`\",\n    \"1-1\": \"Amount of funds in dollars added or withdrawn on a given date\",\n    \"2-0\": \"`max_yearly_loss `\",\n    \"2-1\": \"Maximum loss incurred in a one year period over the given duration\",\n    \"4-0\": \"`sharpe`\",\n    \"4-1\": \"The realised sharpe ratio of the portfolio over the given duration\",\n    \"3-0\": \"`max_drawdown`\",\n    \"3-1\": \"Maximum drawdown of the portfolio over the given duration\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"5723c5a10426380e00a1a860","createdAt":"2016-04-29T21:05:32.563Z","editedParams":true,"editedParams2":true,"excerpt":"Get fund transfers and withdrawl details of your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"fund-transfers","sync_unique":"","title":"Fund transfers","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getFund transfers

Get fund transfers and withdrawl details of your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with the following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "Date on which fund was added", "1-0": "`amount`", "1-1": "Amount of funds in dollars added or withdrawn on a given date", "2-0": "`max_yearly_loss `", "2-1": "Maximum loss incurred in a one year period over the given duration", "4-0": "`sharpe`", "4-1": "The realised sharpe ratio of the portfolio over the given duration", "3-0": "`max_drawdown`", "3-1": "Maximum drawdown of the portfolio over the given duration" }, "cols": 2, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with the following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "Date on which fund was added", "1-0": "`amount`", "1-1": "Amount of funds in dollars added or withdrawn on a given date", "2-0": "`max_yearly_loss `", "2-1": "Maximum loss incurred in a one year period over the given duration", "4-0": "`sharpe`", "4-1": "The realised sharpe ratio of the portfolio over the given duration", "3-0": "`max_drawdown`", "3-1": "Maximum drawdown of the portfolio over the given duration" }, "cols": 2, "rows": 2 } [/block]
{"__v":2,"_id":"5723cbdc0426380e00a1a87e","api":{"auth":"required","examples":{"codes":[{"language":"http","code":"http://api.strategies.qplum.co/qfolio/v1.0/performance_breakdown/products/?userid=8BQ05006&start_date=2016-03-01&end_date=2016-03-15&validation_key=YOURKEY"}]},"method":"get","params":[{"_id":"5723f4202887bb0e00bb9d68","ref":"","required":true,"desc":"Account Number of the brokerage account","default":"","type":"string","name":"userid","in":"query"},{"_id":"5723f4202887bb0e00bb9d67","ref":"","required":true,"desc":"Start date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"start_date","in":"query"},{"_id":"5723f4202887bb0e00bb9d66","ref":"","required":true,"desc":"End date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"end_date","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"date\": \"2016-04-01\",\n        \"product_performance_breakdown\": [\n            {\n                \"nominal_return\": -0.000028,\n                \"secname\": \"BIV\",\n                \"pnl\": -2.33\n            },\n            {\n                \"nominal_return\": 0.000356,\n                \"secname\": \"VGT\",\n                \"pnl\": 29.21\n            },\n            ...\n            {\n                \"nominal_return\": 0.000374,\n                \"secname\": \"VPU\",\n                \"pnl\": 30.71\n            },\n            {\n                \"nominal_return\": 0.000179,\n                \"secname\": \"VTI\",\n                \"pnl\": 14.67\n            },\n            {\n                \"nominal_return\": -0.000164,\n                \"secname\": \"VWOB\",\n                \"pnl\": -13.46\n            },\n            {\n                \"nominal_return\": 0.000102,\n                \"secname\": \"VXF\",\n                \"pnl\": 8.41\n            }\n        ]\n    }\n]","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}","name":""},{"status":404,"language":"text","code":"{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}"},{"status":500,"language":"text","code":"{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/performance_breakdown/products/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"The date corresponding to the object\",\n    \"1-0\": \"`product_performance_breakdown`\",\n    \"1-1\": \"Array of **ProductPerformance** objects\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**ProductPerformance**\nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`secname`\",\n    \"0-1\": \"Ticker of the product, e.g. `VTI`\",\n    \"1-0\": \"`pnl`\",\n    \"1-1\": \"The contribution of pnl by a given product, e.g. `10.23`\",\n    \"2-0\": \"`nominal_return`\",\n    \"2-1\": \"The contribution to the net nominal return by a given product, e.g. `0.01` if the portfolio went up by `1%` due to this product on a given date\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","category":"5770ce6227a5c20e00030ab2","createdAt":"2016-04-29T21:02:20.571Z","editedParams":true,"editedParams2":true,"excerpt":"Get daily contribution of each product to the net performance of your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-performance-breakdown-into-products","sync_unique":"","title":"Daily contribution by products","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getDaily contribution by products

Get daily contribution of each product to the net performance of your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`product_performance_breakdown`", "1-1": "Array of **ProductPerformance** objects" }, "cols": 2, "rows": 2 } [/block] **ProductPerformance** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secname`", "0-1": "Ticker of the product, e.g. `VTI`", "1-0": "`pnl`", "1-1": "The contribution of pnl by a given product, e.g. `10.23`", "2-0": "`nominal_return`", "2-1": "The contribution to the net nominal return by a given product, e.g. `0.01` if the portfolio went up by `1%` due to this product on a given date", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 3 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`product_performance_breakdown`", "1-1": "Array of **ProductPerformance** objects" }, "cols": 2, "rows": 2 } [/block] **ProductPerformance** Object with the following attributes: [block:parameters] { "data": { "0-0": "`secname`", "0-1": "Ticker of the product, e.g. `VTI`", "1-0": "`pnl`", "1-1": "The contribution of pnl by a given product, e.g. `10.23`", "2-0": "`nominal_return`", "2-1": "The contribution to the net nominal return by a given product, e.g. `0.01` if the portfolio went up by `1%` due to this product on a given date", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 3 } [/block]
{"__v":2,"_id":"5723cbf20426380e00a1a880","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f4564255580e00593801","default":"","desc":"Account Number of the brokerage account","name":"userid","ref":"","required":true,"type":"string","in":"query"},{"_id":"5723f4564255580e00593800","default":"","desc":"Start date of the duration over which the information is requested","name":"start_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"},{"_id":"5723f4564255580e005937ff","default":"","desc":"End date of the duration over which the information is requested","name":"end_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"date\": \"2016-04-01\",\n        \"sector_performance_breakdown\": [\n            {\n                \"sector\": \"Equity\",\n                \"pnl\": 309.14,\n                \"nominal_return\": 0.003764\n            },\n            {\n                \"sector\": \"FixedIncome\",\n                \"pnl\": -22.81,\n                \"nominal_return\": -0.000278\n            },\n            {\n                \"sector\": \"RealEstate\",\n                \"pnl\": -4.25,\n                \"nominal_return\": -0.000052\n            }\n        ]\n    }\n]","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n"},{"status":500,"language":"json","code":"{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/performance_breakdown/sectors/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"The date corresponding to the object\",\n    \"1-0\": \"`sector_performance_breakdown`\",\n    \"1-1\": \"Array of **SectorPerformance** objects\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**SectorPerformance**\nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`sector`\",\n    \"0-1\": \"Name of the sector, e.g. `Equity`\",\n    \"1-0\": \"`pnl`\",\n    \"1-1\": \"The contribution of pnl by a given sector, e.g. `10.23`\",\n    \"2-0\": \"`nominal_return`\",\n    \"2-1\": \"The contribution to the net nominal return by a given sector, e.g. `0.01` if the portfolio went up by `1%` due to this sector on a given date\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","category":"5770ce6227a5c20e00030ab2","createdAt":"2016-04-29T21:02:42.998Z","editedParams":true,"editedParams2":true,"excerpt":"Get daily contribution of each sector to the net performance of your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-performance-breakdown-into-sectors","sync_unique":"","title":"Daily contribution by sectors","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getDaily contribution by sectors

Get daily contribution of each sector to the net performance of your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`sector_performance_breakdown`", "1-1": "Array of **SectorPerformance** objects" }, "cols": 2, "rows": 2 } [/block] **SectorPerformance** Object with the following attributes: [block:parameters] { "data": { "0-0": "`sector`", "0-1": "Name of the sector, e.g. `Equity`", "1-0": "`pnl`", "1-1": "The contribution of pnl by a given sector, e.g. `10.23`", "2-0": "`nominal_return`", "2-1": "The contribution to the net nominal return by a given sector, e.g. `0.01` if the portfolio went up by `1%` due to this sector on a given date", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 3 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`sector_performance_breakdown`", "1-1": "Array of **SectorPerformance** objects" }, "cols": 2, "rows": 2 } [/block] **SectorPerformance** Object with the following attributes: [block:parameters] { "data": { "0-0": "`sector`", "0-1": "Name of the sector, e.g. `Equity`", "1-0": "`pnl`", "1-1": "The contribution of pnl by a given sector, e.g. `10.23`", "2-0": "`nominal_return`", "2-1": "The contribution to the net nominal return by a given sector, e.g. `0.01` if the portfolio went up by `1%` due to this sector on a given date", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 3 } [/block]
{"__v":2,"_id":"5723cc05c729ad0e00c395e6","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f492eae5090e00ee6214","default":"","desc":"Account Number of the brokerage account","name":"userid","ref":"","required":true,"type":"string","in":"query"},{"_id":"5723f492eae5090e00ee6213","default":"","desc":"Start date of the duration over which the information is requested","name":"start_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"},{"_id":"5723f492eae5090e00ee6212","default":"","desc":"End date of the duration over which the information is requested","name":"end_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"date\": \"2016-04-01\",\n        \"strategy_performance_breakdown\": [\n            {\n                \"nominal_return\": 0.001736,\n                \"pnl\": 142.59,\n                \"strategy\": \"BOLT-MV89DI\"\n            },\n            {\n                \"nominal_return\": 0.000834,\n                \"pnl\": 68.47,\n                \"strategy\": \"FIX-URL3Z6\"\n            },\n            {\n                \"nominal_return\": 0,\n                \"pnl\": 0,\n                \"strategy\": \"LIQUID\"\n            },\n            {\n                \"nominal_return\": 0.000865,\n                \"pnl\": 71.03,\n                \"strategy\": \"PAR-URIG7A\"\n            }\n        ]\n    }\n]","name":""},{"status":400,"language":"json","code":"{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}"},{"status":500,"language":"json","code":"{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/performance_breakdown/strategies/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an array of objects. Each object has following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`date`\",\n    \"0-1\": \"The date corresponding to the object\",\n    \"1-0\": \"`strategy_performance_breakdown`\",\n    \"1-1\": \"Array of **StrategyPerformance** objects\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**StrategyPerformance**\nObject with the following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`strategy`\",\n    \"1-0\": \"`pnl`\",\n    \"2-0\": \"`nominal_return`\",\n    \"1-1\": \"The contribution of pnl by a given product, e.g. `10.23`\",\n    \"0-1\": \"Ticker of the strategy, e.g. `BLEND-RSFEU4`\",\n    \"2-1\": \"The contribution to the net nominal return by a given strategy, e.g. `0.01` if the portfolio went up by `1%` due to this strategy on a given date\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","category":"5770ce6227a5c20e00030ab2","createdAt":"2016-04-29T21:03:01.479Z","editedParams":true,"editedParams2":true,"excerpt":"Get daily contribution of each strategy to the net performance of your portfolio","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-performance-breakdown-into-strategies","sync_unique":"","title":"Daily contribution by Strategies","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getDaily contribution by Strategies

Get daily contribution of each strategy to the net performance of your portfolio

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`strategy_performance_breakdown`", "1-1": "Array of **StrategyPerformance** objects" }, "cols": 2, "rows": 2 } [/block] **StrategyPerformance** Object with the following attributes: [block:parameters] { "data": { "0-0": "`strategy`", "1-0": "`pnl`", "2-0": "`nominal_return`", "1-1": "The contribution of pnl by a given product, e.g. `10.23`", "0-1": "Ticker of the strategy, e.g. `BLEND-RSFEU4`", "2-1": "The contribution to the net nominal return by a given strategy, e.g. `0.01` if the portfolio went up by `1%` due to this strategy on a given date", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 3 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an array of objects. Each object has following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`date`", "0-1": "The date corresponding to the object", "1-0": "`strategy_performance_breakdown`", "1-1": "Array of **StrategyPerformance** objects" }, "cols": 2, "rows": 2 } [/block] **StrategyPerformance** Object with the following attributes: [block:parameters] { "data": { "0-0": "`strategy`", "1-0": "`pnl`", "2-0": "`nominal_return`", "1-1": "The contribution of pnl by a given product, e.g. `10.23`", "0-1": "Ticker of the strategy, e.g. `BLEND-RSFEU4`", "2-1": "The contribution to the net nominal return by a given strategy, e.g. `0.01` if the portfolio went up by `1%` due to this strategy on a given date", "h-0": "Attribute", "h-1": "Description" }, "cols": 2, "rows": 3 } [/block]
{"__v":0,"_id":"5723fb8beae5090e00ee6224","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723fb8beae5090e00ee6227","ref":"","required":true,"desc":"Account Number of the brokerage account","default":"","type":"string","name":"userid","in":"query"},{"_id":"5723fb8beae5090e00ee6226","ref":"","required":true,"desc":"Start date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"start_date","in":"query"},{"_id":"5723fb8beae5090e00ee6225","ref":"","required":true,"desc":"End date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"end_date","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n   \"PAR-URIG7A\": -0.001316,\n   \"FIX-URL3Z6\": -0.002032,\n   \"BOLT-MV89DI\": -0.00275,\n   \"LIQUID\": 0.0\n}\n","name":""},{"status":400,"language":"json","code":"\n{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n"},{"status":500,"language":"json","code":"\n{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/performance_breakdown/strategies_summary/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an object with following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`ticker_name`\",\n    \"0-1\": \"Name of the strategy in portfolio\",\n    \"1-0\": \"`return`\",\n    \"1-1\": \"Return of the strategy in percentage over the given period\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"5770ce6227a5c20e00030ab2","createdAt":"2016-04-30T00:25:47.537Z","editedParams":true,"editedParams2":true,"excerpt":"Get return contribution of each strategy to the net performance of your portfolio over a given period","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-return-breakdown-into-strategies","sync_unique":"","title":"Cumulative Return by Strategies","type":"get","updates":[],"user":"56fa9871fe8f8f0e00f06a5c","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getCumulative Return by Strategies

Get return contribution of each strategy to the net performance of your portfolio over a given period

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`ticker_name`", "0-1": "Name of the strategy in portfolio", "1-0": "`return`", "1-1": "Return of the strategy in percentage over the given period" }, "cols": 2, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`ticker_name`", "0-1": "Name of the strategy in portfolio", "1-0": "`return`", "1-1": "Return of the strategy in percentage over the given period" }, "cols": 2, "rows": 2 } [/block]
{"__v":2,"_id":"5723cc577d2fbc0e00c4791b","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f4d8d872170e004c1a74","ref":"","required":true,"desc":"Account Number of the brokerage account","default":"","type":"string","name":"userid","in":"query"},{"_id":"5723f4d8d872170e004c1a73","ref":"","required":true,"desc":"Start date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"start_date","in":"query"},{"_id":"5723f4d8d872170e004c1a72","ref":"","required":true,"desc":"End date of the duration over which the information is requested","default":"","type":"yyyy-mm-dd","name":"end_date","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n   \"TLT\": 0.004869,\n   \"VEA\": -0.000946,\n   \"LQD\": -0.000155,\n   ...\n   \"VTV\": -0.000376,\n}\n","name":""},{"status":400,"language":"json","code":"\n{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n"},{"status":500,"language":"json","code":"\n{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/performance_breakdown/products_summary/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an object with following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`secname`\",\n    \"0-1\": \"Name of the product in portfolio\",\n    \"1-0\": \"`return`\",\n    \"1-1\": \"Return of the product in percentage over the given period\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"5770ce6227a5c20e00030ab2","createdAt":"2016-04-29T21:04:23.312Z","editedParams":true,"editedParams2":true,"excerpt":"Get return contribution of each product to the net performance of your portfolio over a given period","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-return-breakdown-into-products","sync_unique":"","title":"Cumulative Return by Products","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getCumulative Return by Products

Get return contribution of each product to the net performance of your portfolio over a given period

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`secname`", "0-1": "Name of the product in portfolio", "1-0": "`return`", "1-1": "Return of the product in percentage over the given period" }, "cols": 2, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`secname`", "0-1": "Name of the product in portfolio", "1-0": "`return`", "1-1": "Return of the product in percentage over the given period" }, "cols": 2, "rows": 2 } [/block]
{"__v":2,"_id":"5723cc64c729ad0e00c395e8","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"5723f5172887bb0e00bb9d6d","default":"","desc":"Account Number of the brokerage account","name":"userid","ref":"","required":true,"type":"string","in":"query"},{"_id":"5723f5172887bb0e00bb9d6c","default":"","desc":"Start date of the duration over which the information is requested","name":"start_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"},{"_id":"5723f5172887bb0e00bb9d6b","default":"","desc":"End date of the duration over which the information is requested","name":"end_date","ref":"","required":true,"type":"yyyy-mm-dd","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n   \"FixedIncome\": 0.000451,\n   \"RealEstate\": -0.005387,\n   \"Equity\": -0.000946\n}\n","name":""},{"status":400,"language":"json","code":"\n{\n    \"message\": \"Invalid start date format. Expected YYYY-MM-DD\",\n    \"error\": \"Invalid request\"\n}\n","name":""},{"status":404,"language":"json","code":"\n{\n    \"message\": \"User id not found\",\n    \"error\": \"Invalid request\"\n}\n"},{"status":500,"language":"json","code":"\n{\n    \"message\": \"Interval server error\",\n    \"error\": \"Unexpected error occured\"\n}\n"}]},"settings":"5726ddf555e8ec0e00402704","url":"/v:version/qfolio/performance_breakdown/sectors_summary/"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns an object with following attributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`sector`\",\n    \"0-1\": \"Name of the sector in portfolio\",\n    \"1-0\": \"`return`\",\n    \"1-1\": \"Return of the sector in percentage over the given period\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","category":"5770ce6227a5c20e00030ab2","createdAt":"2016-04-29T21:04:36.777Z","editedParams":true,"editedParams2":true,"excerpt":"Get return contribution of each sector to the net performance of your portfolio over a given period","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"56fbab9d28bdc52000cff764","slug":"portfolio-return-breakdown-into-sectors","sync_unique":"","title":"Cumulative Return by Sectors","type":"get","updates":[],"user":"56fbab2a587e43170081ea57","version":"56fbab9d28bdc52000cff767","childrenPages":[]}

getCumulative Return by Sectors

Get return contribution of each sector to the net performance of your portfolio over a given period

Query Params

userid:
required
string
Account Number of the brokerage account
start_date:
required
yyyy-mm-dd
Start date of the duration over which the information is requested
end_date:
required
yyyy-mm-dd
End date of the duration over which the information is requested
[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`sector`", "0-1": "Name of the sector in portfolio", "1-0": "`return`", "1-1": "Return of the sector in percentage over the given period" }, "cols": 2, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns an object with following attributes: [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`sector`", "0-1": "Name of the sector in portfolio", "1-0": "`return`", "1-1": "Return of the sector in percentage over the given period" }, "cols": 2, "rows": 2 } [/block]