AlphaOverBeta API
One Stop Shop For ALL Financial Services·
AlphaOverBeta API is a cloud service providing financial service APIs.
Our services do all the heavy lifting, while providing an API for apps to access any specific service.
From basic stock watchlist management to a virtual hedge fund and brokerage services, everything is already implemented for financial applications to accessed using our API.
Initial Signup
The first thing to do is to signup for the API service by providing an email
This email may be used to access ALL of our services.
Once you signup, a client id and secret keys are sent to the specific email to be used for further API use.
An app can use the API only when providing the id and secret keys to the API
Please sign in
Or use the api, with this request:
https://api.alphaoverbeta.net//signup?email=[your email]
Watchlist Management
Watchlist is a common way for keeping track of assets that are not ready to be traded just yet,
This API feature enables an app to manage watchlist for users without the development of the logic and the database,
AlphaOverBeta API does all the heavy lifting while providing an easy-to-use API for communicating with the app
Create Watchlist
https://api.alphaoverbeta.net/watchlist?step=create
Description:
First step is to create a watch list, once a watchlist is created , a watchlist id is returned to the app and will be used for further update steps (add, remove,...) by the app.
Parameters:
step=create.
Return Value:
a string representing the newly created watchlist id.
Status Codes: .
Add to watchlist
https://api.alphaoverbeta.net/watchlist?id=[id]&step=add&symbol=[symbol]
Description:
Add a stock the watchlist.
Parameters:
step=add.
id=the watchlist id received by the create watchlist request.
symbol=the requested symbol to add to a watchlist.
Return Value:
NA.
Status Codes: .
Remove from watchlist
https://api.alphaoverbeta.net/watchlist?id=[id]&step=remove&symbol=[symbol]
Description:
remove a stock from the watchlist.
Parameters:
step=remove.
id=the watchlist id received when sending create watchlist request.
symbol=the requested symbol to remove from the watchlist.
Return Value:
NA.
Status Codes: .
Delete entire watchlist
https://api.alphaoverbeta.net/watchlist?id=[id]&step=delete
Description:
Delete the entire watchlist.
Parameters:
step=delete.
id=the watchlist id received by the create watchlist request.
Return Value:
NA.
Status Codes: .
Retrieve current watchlist
https://api.alphaoverbeta.net/watchlist?id=[id]&step=fetch
Description:
Retrieve an entire watchlist with updated prices.
Parameters:
step=fetch.
id=the watchlist id received by the create watchlist request.
Return Value:
The entire watchlist returned with most up-to-date asset prices.
Status Codes: .
Portfolio Management
Portfolios are a collection of investment assets,
This feature enable an application to manage a live portfolio containing traded investment assets,
AlphaOverBeta API does all the heavy lifting while providing an easy-to-use API for communicating with the app
Create Portfolio
https://api.alphaoverbeta.net/portfolio?step=create
Description:
First step is to create a portfolio, once a portfolio is created , a portfolio id is returned to the app and will be used for further update steps (add, remove,...) by the app.
Parameters:
step=create.
Return Value:
a string representing the newly created portfolio id.
Status Codes: .
Add to portfolio
https://api.alphaoverbeta.net/portfolio?id=[id]&step=add&symbol=[symbol]&quantity=[quantity]
Description:
Add a stock the portfolio.
Parameters:
step=add.
id=the portfolio id received by the create portfolio request.
symbol=the requested symbol to add to a portfolio.
quantity=the quantity of the added symbol.
Return Value:
NA.
Status Codes: .
Remove from portfolio
https://api.alphaoverbeta.net/portfolio?id=[id]&step=remove&symbol=[symbol]
Description:
remove a stock from the portfolio.
Parameters:
step=remove.
id=the portfolio id received when sending create portfolio request.
symbol=the requested symbol to remove from the portfolio.
Return Value:
NA.
Status Codes: .
Delete entire portfolio
https://api.alphaoverbeta.net/portfolio?id=[id]&step=delete
Description:
Delete the entire portfolio.
Parameters:
step=delete.
id=the portfolio id received by the create portfolio request.
Return Value:
NA.
Status Codes: .
Retrieve current portfolio
https://api.alphaoverbeta.net/portfolio?id=[id]&step=fetch
Description:
Retrieve an entire portfolio with updated prices.
Parameters:
step=fetch.
id=the portfolio id received by the create portfolio request.
Return Value:
The entire portfolio returned with most up-to-date asset prices.
Status Codes: .
backtest current portfolio
https://api.alphaoverbeta.net/portfolio?id=[id]&step=backtest&period=[period]&interval=[interval]
Description:
Backtest the current portfolio over a specific period, and time interval.
Parameters:
step=backtest.
id=the portfolio id received by the create portfolio request.
period=1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max.
interval=1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mo.
Return Value:
performance table.
Status Codes: .
Virtual Hedge Fund (Under Construction)
Advanced Technical Analysis
Advanced technical analysis involves using sophisticated tools and techniques to analyze and interpret price charts and other market data. While basic technical analysis focuses on common indicators like moving averages, advanced technical analysis delves deeper into the complexities of market behavior.
Support
https://api.alphaoverbeta.net/support
Description:
Support areas are analyzed for the given symbol and return as a list with their support strength.
Parameters:
symbol=the requested symbol to analyze for support areas.
period=1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max.
interval=1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mo.
Return Value:
a list of support areas with their corresponding strength.
Status Codes: .