Acquire

HiddenLevers API

Access and API Keys Public Demo API Key and Demo Accounts HiddenLevers provides a demonstration API key so that developers can test out the API and integrate it into their applications with ease. We have instituted a simple, single public beta key system to let anyone try it out. The API key is required for all endpoints. All API requests also require a corresponding user account to be specified (you can create one below):
  • The public demo beta key is demo_api_key_8675309_hl
Create a demo account here to pass in with your demo API calls: The public API key and demo accounts are subject to rate limit constraints and return static example data for a fixed portfolio. HiddenLevers API: Step to Going to Production If you are interested in receiving a live API key so that you can receive live responses, please contact HiddenLevers sales: 800.277.4830 Additonal HiddenLevers API Usage Notes
  • The user account associated with the API key is used to configure a variety of HiddenLevers model settings which impact API results, including the default scenario set used for stress testing.
  • As per our section 5A of our terms of service, we require all apps that use the HiddenLevers API to conspicuously display "Powered By HiddenLevers" attribution marks where the API is utilized. You may be asked to provide screenshots of your attribution placement.
Sample Stress Test API Call
Sample Request https://www.hiddenlevers.com/l/api/v1/stresstest?apikey=demo_api_key_8675309_hl&apiuser=yourdemologin@example.org&allocationType=pct&input={"portfolio":{"jsonPositions":[{"ticker":"GOOG","quantity":40.0},{"ticker":"NFLX","quantity":40.0},{"ticker":"HD","quantity":20.0}]}}
Sample Return { "status" : "success", "result" : { [ { "positions": [ { "ticker": "GOOG", "quantity": 40, "impactPct": -0.4925382679569934 }, { "ticker": "NFLX", "quantity": 40, "impactPct": -0.5236581647493046 }, { "ticker": "HD", "quantity": 20, "impactPct": -0.48962416318897595 } ], "name": "Boomers Retire: Mass Equity Sales", "description": "What if aging baby boomers start moving savings out of the stock market in order to support their retirement?", "totalImpact": -0.5044034057203144 }, { "positions": [ { "ticker": "GOOG", "quantity": 40, "impactPct": 0.11890299728624254 }, { "ticker": "NFLX", "quantity": 40, "impactPct": 0.13489823193075634 }, { "ticker": "HD", "quantity": 20, "impactPct": 0.14819475373557656 } ], "name": "Baseline: S&P 500 Up 10%", "description": "What if the S&P 500 rises 10%, in line with its long term average since 1950?", "totalImpact": 0.13115944243391486 } ] } }
Sample Risk Profile API Call
Sample Request https://www.hiddenlevers.com/l/api/v1/riskprofile?apikey=demo_api_key_8675309_hl&apiuser=yourdemologin@example.org&allocationType=pct&timeframe=2yr&input={"portfolio":{"jsonPositions":[{"ticker":"GOOG","quantity":40.0},{"ticker":"NFLX","quantity":40.0},{"ticker":"HD","quantity":20.0}]}}
Sample Return { "status" : "success", "result" : { "pvh": [], "ccrScore": 0.5, "expectedReturn": 0.4046872803069004, "expectedReturn5Yr": 2.0398799915954724, "worstScenarioImpact": -50.44034057203144, "excludedSymbols": [], "usePctAllocation": "y", "sp500Beta": 1.0757609437135816, "jsonConfig": {}, "expenseRatio": 0, "yield": 0, "analyzableValue": 100, "jsonPositions": [ { "marketCap": 881070000000, "ticker": "GOOG", "quantity": 40, "pricedate": "2019-04-26 20:07:11.0", "industry": "Tech Giants - Communications", "volatility": 27.12260169018546, "mddstart": "2008-10-01 17:00:00.0", "type": "Stock", "price": 1272.18, "yield": 0, "name": "GOOGLE INC", "pctAllocation": 40, "mddend": "2008-11-24 16:00:00.0" }, { "marketCap": 159570000000, "ticker": "NFLX", "quantity": 40, "pricedate": "2019-04-26 19:54:04.0", "industry": "Streaming Media", "volatility": 53.861261313856176, "mddstart": "2011-07-13 17:00:00.0", "type": "Stock", "price": 374.85, "yield": 0, "name": "NETFLIX INC", "pctAllocation": 40, "mddend": "2012-09-25 17:00:00.0" }, { "marketCap": 223050000000, "ticker": "HD", "quantity": 20, "pricedate": "2019-04-26 20:08:45.0", "industry": "Home Improvement Stores", "volatility": 24.542831239098035, "mddstart": "2008-10-01 17:00:00.0", "type": "Stock", "price": 203.61, "yield": 2.96, "name": "HOME DEPOT INC", "pctAllocation": 20, "mddend": "2009-03-06 16:00:00.0" } ], "value": 100 } }