Spectre.AI Hyper-API v1.1 beta

Disclaimer: Spectre.ai's application programming interfaces (the “APIs”) allow developers to connect to the Spectre.ai trading platform in order to create, read and use content available inside the platform from within the developer's application or website. The beta version is still undergoing final testing before its official release. Spectre.ai does not give any warranties, whether express or implied, as to the suitability or usability of the API. Spectre.ai will not be liable for any loss, whether such loss is direct, indirect or consequential suffered by any party as a result of their use of the API. Any use of the API is done at the user's own risk and the user will be solely responsible for any issue that may arise. Should you encounter any bugs, glitches, lack of functionality or other problems, please let us know immediately at [email protected] so we can rectify these accordingly.

Compensation: Developers Earn 0.5% of all volumes and up to 30% of the payout of winning trades. This is to incentivise the creation of high quality capital growth products for end-users. All earnings can be tracked in the Developer Portal.

Authentication

Welcome to Spectre.ai API, which is now officially live! We are delighted to welcome all bot builders, auto-traders and developers. Here you will find all the information you need to get started immediately. The process is straightforward, and you should be able to extract all relevant data from the platform, including assets, users and trading history, while also being able to open trades on both demo and live accounts. If you have any questions, please email us at [email protected]

Web Application Flow

Partners looking to integrate with our API must create an account and register an application. To get the access token of the user, use the Web Flow below.
The oAuth token is served as a parameter while the Security Token is the public key of the Application.

Step 1 - Authorization

The authenticating web application should redirect users to the following URL: https://wss.hyper-api.com/authorize.php?

Parameters

app_id	string	Your Application ID
grant	string	Value is always "oauth"
response_type	string	Value is always "code"
client_id	string	You Application ID
state	string	An unguessable, cryptographically secure random string used to protect against cross-site request forgery attacks.

Returns

code

Examples

Input

Click here to authorize me 
< a href='https://wss.hyper-api.com/authorize.php?app_id=x&grant=oauth&response_type=code&client_id=x&state=xyz'> Click < /a>

Output

Redirect to your app with GET header containg authorization code: myapp.com?code=6fc993f4f6f7068ac5e1d11f35eb55af8002e9b2&state=xyz

STEP 2 - Requesting a token

If the user accepts your request, Spectre will redirect the user back to your site with a temporary code and the previously provided state, as is.

This temporary code is valid for a duration of 5 minutes and can only be used once.
Your application is responsible for ensuring that the state matches the value previously provided, thus preventing a malicious third-party from forging this request.

You may then exchange this code for an access token using the following endpoint:
POST https://wss.hyper-api.com/token.php

Parameters

code	string	Code received from previous request
grant_type	string	Value should be "authorization_code"

Basic access authentication

When requesting a token, you must use HTTP Authentication in the request body.

user	string	Your Application ID
password	string	Your Application key

Returns

token

Examples

Input

$code = $_GET['code'];
$header_values = array("Accept: application/json", "Content-Type: application/x-www-form-urlencoded");
$url = 'https://wss.hyper-api.com/token.php';
$post_arr = array("code" => $code, "grant_type" => "authorization_code");
$process = curl_init($url);
curl_setopt($process, CURLOPT_HTTPHEADER, $header_values);
curl_setopt($process, CURLOPT_USERPWD, "xXxXx:yYyY");
curl_setopt($process, CURLOPT_POST, 1);
curl_setopt($process, CURLOPT_POSTFIELDS, http_build_query($post_arr));
curl_setopt($process, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($process);
$json_object = json_decode($result, true); 

$access_token = $json_object['access_token'];

Output

Access Token: d329e677d697bea2754c22f29358feb348af0f05

STEP 3 - Using the Access Token

Once you have obtained an access token you may call any protected API method on behalf of the user using the token parameter of the request.

Parameters

action	string	Request method, available methods are listed below
data	string	Request payload
token	string	Access token of the user/developer

Application authentication

When creating a request to the server, you must use include your public application ID in the Sec-WebSocket-Protocol.

Sec-WebSocket-Protocol

string

Your Application ID

Returns

Server Response

Examples

Input

// Connect to server
let socket = null;
                                        let serverUrl = 'wss://wss.hyper-api.com:4443/spectreai/';
if (window.MozWebSocket) {
socket = new MozWebSocket(serverUrl, "XXXXX_Application_ID");
} else if (window.WebSocket) {
socket = new WebSocket(serverUrl, "1");
}
socket.binaryType = 'blob';

Output

Server Response

Methods

AppData()

Summary of app usage

Retrieve data regarding the total users and total traded volume.

Parameters

account_type	string,int	The user's Account Type from which the data is requested. Available account types are 1 = demo; 4 = Regular
token	string	Access Token of the developer

Returns

array

Assets()

List of available Assets

Retrieve list of all available assets.

Parameters

token

string

Access Token of the developer/user

Returns

multiarray

Examples

Input

{"action":"assets","data":{},"token":"ACCESS_TOKEN"}

Output

[ { "id": "1", "asset": "EUR/USD", "isMarketOpen": "1",  "availableexpires": [ "10s", "30s", "60s", "5m", "10m", "15m", "20m", "25m", "30m", "35m", "40m", "45m", "50m", "55m", "60m", "1d", "C", "120m", "180m", "240m" ] }, {}, {} ]

UserData()

Get user data

Retreives user data and risk management settings.

Parameters

account_type	string,int	The user's Account Type from which the data is requested. Available account types are 1 = demo; 4 = Regular; 6 = DeFi
subaccount_type	string	DeFi token name (optional, required on `account_type`=6)
token	string	Access Token of the user

Returns

array

UserHistory()

Get user trading history

Retreives user's history of trades, up to 100 per request.

Parameters

account_type	string,int	The user's Account Type from which the data is requested. Available account types are 1 = demo; 4 = Regular; 6 = DeFi
start_position	string,int
end_position	string,int
token	string	Access Token of the user

Returns

multiarray

Examples

Input

{"action":"userhistory","data":{"account_type":1,"start_position":0,"end_position":4},"token":"USER_TOKEN"}

Output

[ { "transaction_id": "13", "asset_id":"38", "asset": "ETH/USD", "direction":"PUT", "expiration_text": "5m", "entry_time":"2018-03-30 05:51:54", "entry_price": "388.38500","expiry_time": "2018-03-30 05:56:55", "exit_price":"397.55000", "investment": "3.89", "profit":"-3.89", "cap_protection": "0.00","is_early_closed": "0" }, {}, {} ]

LiveTrades()

Get user's live trades

Retreives user's live trades, up to 100 per request.

Parameters

account_type	string,int	The user's Account Type from which the data is requested. Available account types are 1 = demo; 4 = Regular; 6 = DeFi
start_position	string,int
end_position	string,int
asset_id	string,int	(Optional) get live trades for only a specific Asset ID
token	string	Access Token of the user

Returns

multiarray

Examples

Input

{"action":"livetrades","data":{"account_type":1, "start_position":0,"end_position":4},"token":"USER_TOKEN"}

Output

[ { "transaction_id": "4236", "asset_id":"8", "asset": "USD/CAD", "direction": "CALL", "expiration_text": "30m", "entry_time":"2019-11-12 15:34:07", "entry_price": "1.32291","expiry_time": "0000-00-00 00:00:00", "exit_price":"0.00000", "investment": "10", "profit": null,"cap_protection": "0.10", "is_early_closed": "0"}, {}, {} ]

TradeDetails()

Get trade details

Retreives data of a Closed trade

Parameters

transaction_id	string,int	The transaction ID to be queried
token	string	Access Token of the user

Returns

array

Examples

Input

{"action":"TradeDetails","data":{"transaction_id":4223},"token":"USER_TOKEN"}

Output

{ "transaction_id": "4223", "asset_id":"2", "asset": "USD/JPY", "direction":"CALL", "expiration_text": "C", "entry_time":"2019-10-21 19:41:07", "entry_price": "108.67800", "expiry_time": "2019-10-22 22:00:000", "exit_price": "108.63900", "investment": "1", "profit": 1,"cap_protection": "0.10", "is_early_closed": "0"}

OpenTrade()

Get trade details

Retreives data of a Open trade

Parameters

transaction_id	string,int	The transaction ID to be queried
token	string	Access Token of the user

Returns

array

Examples

Input

{"action":"OpenTrade","data":{"transaction_id":4223},"token":"USER_TOKEN"}

Output

{ "transaction_id": "4223", "asset_id":"2", "asset": "USD/JPY", "direction":"CALL", "expiration_text": "C", "entry_time":"2019-10-21 19:41:07", "entry_price": "108.63900", "expiry_time": "2019-10-25 19:46:00", "exit_price":"0.00000", "investment": "1", "profit": null,"cap_protection": "0.10", "is_early_closed":"0" }

ChartSubscribe()

Subscribe to tick data

Request tick data subscription to an asset_id or all available assets

Parameters

subscribe	string,int	1/0. Use 1 to subscribe and 0 to unsubscribe
asset_id	string,int	(Optional) an existing asset_id in the request will subscribe only to specific asset pair, otherwise all tick data will be pushed
token	string	Access Token of the user/developer

Returns

multiarray

Examples

Input

{"action":"ChartSubscribe","data":{"subscribe":1},"token":"USER_TOKEN"}

Output

{ "1": { "tick_price": 1.10112, "candle_ts":1573582010 }, "2": { "tick_price": 109.082, "candle_ts":1573582010 }, "3": { "tick_price": 1.28592, "candle_ts":1573582010 }, "4": { "tick_price": 0.85628, "candle_ts":1573582010 }, "5": { "tick_price": 0.99286, "candle_ts":1573582010 }, "6": { "tick_price": 120.108, "candle_ts":1573582010 }, {}, {} }

NewTrade()

Place new trade

Parameters

account_type	string,int	User's account type for which the trade to be placed. 1 = Demo; 4 = Regular; 6 = DeFi
subaccount_type	string	DeFi token name (optional, required on `account_type`=6)
direction	string	Call / SELL
asset_id	string,int
expiration	string	See the API call below on how to pull the available expiration for given asset_id \| or use "C" for custom expirations
custom_expiration	string	Custom expirations can only be used if 'expiration' has been set to "C". a custom expiration must be given as `xh xm xs`. h,m,s meaning hour, minute, seconds. Each parameter can be given individually.
investment	string,int	Investment in current trade
refid	string	A reference ID for copy trading
token	string	Access Token of the user/developer

Returns

array

Examples

Input

{"action":"newtrade","data":{"account_type":1,"direction":"Call" ,"asset_id":7,"expiration":"30m","investment":10},"token":"USER_TOKEN"}

Output

{ "payout_percentage": 75, "cap_protection": 0.1, "entry_price": "1.32288", "expiration_value": "30m", "status": "success", "account_type": 1, "current_account_balance": 13673, "track_data": { "currency_id": 8, "currency": "USD/CAD", "price": "1.32288", "created_on": "2019-11-12 18:29:58", "trade_created_on": "2019-11-12 18:29:58", "expired_on": "2019-11-12 18:59:58", "direction": "CALL", "expiration": "30" } }

AvailableExpires()

List of available expiries

Request the available expiries of a given asset_id, those may differ from asset pair to another.

Parameters

asset_id	string,int
token	string	Access Token of the user/developer

Returns

array

Examples

Input

{"action":"AvailableExpires","data":{"asset_id":1},"token":"USER_TOKEN"}

Output

[ "10s", "30s", "60s", "5m", "10m", "15m", "20m", "25m", "30m", "35m", "40m", "45m", "50m", "55m", "60m", "1d", "C", "120m", "180m", "240m" ]

MaxInvestment()

Get max investment

Request the max investment for a asset_id/expiration combination. The output value represents the maximum investment in USD.

Parameters

asset_id	string,int
expiration	string
token	string	Access Token of the user/developer

Returns

string

GetPayout()

Get payout

Request the payout for a asset_id/expiration/investment combination. The output may differ based on asset pairs, expirations and investment values.

Parameters

asset_id	string,int
expiration	string
investment	string,int
custom_expiry	string	(Optional) will be ignored if `expiration` is not set to 'C'
token	string	Access Token of the user/developer

Returns

string

ChartHistory()

Get chart historic candles

Request the historic candles for a given asset_id, output may differ based on the set period.

Parameters

asset_id	string,int
period	string,int	May only be set to 0 (EPIC seconds periodicity), 1 (ALL, 1 min chart candles), 5 (ALL, 5 min chart candles), 15 (ALL, 15 min chart candles), 30 (ALL, 30 min chart candles), 60 (ALL, hourly chart candles), 24 (ALL, daily chart candles)
start	string,int	The timestamp of the start position, if EPIC (asset_ids 100,101,102) the timestamp is to be given in miliseconds
end	string,int	The timestamp of the end position, if EPIC (asset_ids 100,101,102) the timestamp is to be given in miliseconds
token	string	Access Token of the user/developer

Returns

multiarray

Examples

Input

{"action":"ChartHistory","data":{"asset_id":"10", "start": "1573481442", "period":"1", "end": "1573477842"},"token":"USER_TOKEN"}

Output

[ { "Close": 139.771, "Open": 139.773, "High": 139.774, "Low": 139.771, "Volume": "51", "DT": "2019-11-10 23:50:00", "GMT": "2019-11-10 23:50:00" }, { "Close": 139.76, "Open": 139.771, "High": 139.773, "Low": 139.76, "Volume": "52", "DT": "2019-11-10 23:51:00", "GMT": "2019-11-10 23:51:00" }, { "Close": 139.755, "Open": 139.76, "High": 139.76, "Low": 139.751, "Volume": "79", "DT": "2019-11-10 23:52:00", "GMT": "2019-11-10 23:52:00" }, {}, {} ]

ApplicationReport()

Get report per Application ID, of the application the method is called from

Request the trades placed by an Application between two given dates, if no date given, return today's trades.

Parameters

start	string	Start Date Year-Month-Day
end	string	End Date Year-Month-Day
token	string	Access Token of the user/developer

Returns

multiarray

Examples

Input

{"action":"ApplicationReport","data":{"start":"2019-12-15","end":"2019-12-07"},"token":"USER_TOKEN"}

Output

{ "report": [ { "client_id": "1025404", "transaction_id": "1505165", "asset_id": "7", "asset": "EUR/CHF", "direction": "CALL", "expiration_text": "30m", "entry_time": "2019-12-16 08:37:30", "entry_price": "1.09520", "expiry_time": "0000-00-00 00:00:00", "exit_price": "0.00000", "investment": "10.000", "profit": null, "cap_protection": "0.10", "is_early_closed": "0", "app_id": "dd19bfb8da5fe2f82cc0a0ec02bec429", "RefId": null }, ... {}, {} }

DisableRiskmanagement()

Set signal to disable the risk management of the user who belongs to the USER_TOKEN

Parameters

disable	int	Set Disable to 1 to disable, set Disable to 2 to enable.
token	string	Access Token of the user/developer

Returns

array

Examples

Input		{"action":"DisableRiskmanagement","data":{"disable":1},"token":"USER_TOKEN"}
Output		{"action":"disableriskmanagement","data":{"status":"success","message":"Risk Management has been disabled."}}

TradeSetup()

Will return the latest trade signals, for best performace, call this function every 5minutes

Parameters

token

string

Access Token of the user/developer

Returns

multiarray

Examples

Input

{"action":"TradeSetup","data":{},"token":"USER_TOKEN"}

Output

{ "signals": [ { "create_on": "2019-12-16 11:20:47", "expire_on": "2019-12-16 11:25:47", "asset_id": "27", "signalType": "Micro Channel Surfer", "direction": "CALL", "duration": "5m" },{},{} ] }

PrepareTrade()

Create a trade template valid for 30minutes

Parameters

account_type	string,int	User's account type for which the trade to be placed. 1 = Demo; 4 = Regular ;6 = DeFi
subaccount_type	string,int	DeFi token name (optional, required on `account_type`=6)
direction	string	Call / SELL
asset_id	string,int
expiration	string	See the API call below on how to pull the available expiration for given asset_id
refid	string	Custom reference ID
token	string	Access Token of the user/developer

Returns

array

Examples

Input

{"action" : "preparetrade",  "data" : {  "account_type" : 1,   "asset_id":100,"direction" : "Call","expiration" : "10s"    },"token": "DEVELOPER/USER_TOKEN"            }

Output

{ "status": "success", "id": "oacQFKkXPp", "validity": "30m" }

PurchaseTrade()

Use trade template to place trades for multiple users simultaneously

Parameters

id	string	id given by PrepareTrade
investment	int	Investment in current trade, applies for all trades
percentage	string,int	(optional) set to 1 for the investment parameter to be treated as a percentage
max_investment	int	(optional) ignored if percentage = 0; Trade will be rejected if the percentage value of the user's balance is lower than specified in the min_investment parameter.
min_investment	int	(optional) ignored if percentage = 0; Trade will be rejected if the percentage value of the user's balance is lower than specified in the min_investment parameter.
token(s)	string	Access Token of the user(s), comma separated values

Returns

multiarray

Examples

Input

  {"action" : "purchasetrade",  "data" : {"id": "BePeNjCiLl" ,"investment":1    },"token": "USER_TOKEN_1,USER_TOKEN_2,.."            }

Output

{ "user_id": { "transaction_id": "6386007", "payout_percentage": "90", "cap_protection": 0.1, "entry_price": "64.60445", "expiration_value": "1000", "status": "success", "account_type": null, "current_account_balance": "212,657.109", "track_data": { "currency_id": 100, "currency": "EPIC5000", "price": "64.60445", "created_on": "2020-08-24 14:33:15", "trade_created_on": "2020-08-24 14:33:15", "expired_on": "2020-08-24 14:33:25", "direction": "CALL", "expiration": "1000" }, "RefId": null }, "user_id2":{} }

TradeSubscribe()

Receive transaction payload upon expiry

Parameters

subscribe	string,int	1 to enable, 2 to disable
token	string	Access Token of the developer/user

Returns

confirmation messsage

Input		{"action":"userdata","data":{"account_type":1},"token":"USER_TOKEN"}
Output		{ "account_balance": "13683", "risk_enabled":"1", ... }

Input		{"action":"MaxInvestment","data":{"asset_id":10,"expiration":"10s"},"token":"USER_TOKEN"}
Output		"100"

Input		{"action":"getpayout","data":{"asset_id":100,"expiration":"1d", "investment":10},"token":"USER_TOKEN"}
Output		"90"

Input		{"action":"tradesubscribe","data":{"subscribe":1},"token":"USER_TOKEN"}
Output		"Subscribed/(Unsubscribed) to Trade Outcome."