API docs by Redocly

Correlating Alerts API (1.0.0)

Download OpenAPI specification: [Correlating_Alerts_API.yaml]

This API retrieves technical indicators that correlate in their direction. For example, when a technical chart pattern and horizontal key level point in the same direction.

API Request Authentication

Our APIs require the following url parameters on every call:

brokerid – your customer ID on our systems (provided to you)
user – a unique ID of the end-user consuming the information. For server-2-Server integrations this would typically be your company name
accounttype – 0 = LIVE, 1 = DEMO
expiry – Unix timestamp of when this token will expire________token – a token generated by MD5(user|[accounttype]|[expiry][secretkey])

in which secretkey is the secret key provided to you, not to be shared with the end-user

Note the ‘|’ (Pipe) character before and after the AccountType parameter

$expiryDate = time() + (3 * 24 * 60 * 60);
$userid = “myuserid”;
$accountType = “0”;
$secretKey = “secretkey”;
$token = md5(“${userid}|${accountType}|${expiryDate}${secretKey }”);
echo $token;
?>

import hashlib
import time
expiry_date = int(time.time()) + (3 * 24 * 60 * 60)
userid = "myuserid"
account_type = "0"
secret_key = "secretkey"
token = hashlib.md5(f"{userid}|{account_type}|{expiry_date}{secret_key}".encode("utf-8")).hexdigest()
print(token)

Correlating Alerts

Correlating Alerts

Retrieve Correlating Alerts

This endpoint retrieves correlating alerts using filtering parameters specific in the URL

Request Body

  • broker_id (string): (Required) enter broker id for authenticationEndFragment

  • user (string): (Required) User identifier

  • token (string): (Required) Authentication token

  • expire (string): (Required) Expiry timestamp

  • account_type (string): (Required) Type of account "LIVE" or "DEMO"

  • start_time (int): Time (in days) to go back for data retrieval

  • base_group_name (string): filter by group name. See endpoint "Base Group Names". For example "Forex" or "Stocks"

  • symbol (string): (optional) search by ticker code eg EURUSD

  • direction (int): (optional) 1 = bullish only, -1 = bearish only

  • locale (string): Locale setting

  • online_translate (string): (optional) true = dynamic translation, false = template language (default)

Response Body

The response will contain an array of objects with the following fields:

  • id (number): Identifier

  • gmt_time_found (string): GMT time found

  • broker_id (number): ID of the broker

  • base_group_name (string): Base group name

  • broker_symbol_group_id (number): Broker symbol group ID

  • symbol (string): Symbol

  • symbol_id (string): Symbol ID

  • direction (number): Direction

  • breakout_price (string): Breakout price

  • forecast_price (string): Forecast price

  • forecast_pips (number): Forecast pips

  • percent_probability (string): Percent probability

  • nlg_text (object): Natural language generation text

    • TITLE (string): Title

    • FULL (string): Full text

    • TEASER (string): Teaser

    • CTA (string): Call to action

  • patterns (array): Array of patterns

    • type (string): Type of pattern

    • name (string): Name of the pattern

    • result_uid (string): Result UID

    • time_granularity (number): Time granularity

    • chart_url (string): URL for the chart

  • online_translate (boolean): Online translation status

query Parameters
broker_id
string
Example: broker_id={{broker_id}}

(Required) enter broker id for authentication

user
string
Example: user={{user}}

(Required) for authentication

token
string
Example: token={{token}}

(Required) for authentication

expire
string
Example: expire={{expire}}

(Required) for authentication

account_type
string
Example: account_type={{account_type}}

(Required) for authentication. set to LIVE

start_time
string
Example: start_time={{start_time}}

Time (in days) to go back for data retrieval

base_group_name
string
Example: base_group_name={{base_group_name}}

filter by group name. See endpoint "Base Group Names". For example "Forex" or "Stocks"

symbol
string
Example: symbol={{symbol}}

(optional) search by ticker code eg EURUSD

direction
string
Example: direction={{direction}}

(optional) 1 = bullish, -1 = bearish

locale
string
Example: locale={{locale}}

language of respose, eg 'en'

online_translate
string
Example: online_translate={{online_translate}}

(optional) true = dynamic translation, false = template language (default)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[]

Base Group Names

This endpoint provides a list of base group names available for the specified brokerid. These values can then be used in the /correlating_alerts/ endpoint to filter results based on this group.

Requires authentication

A valid request with an authorized MD5 token will be accepted

Return format

  • Status 200 - application/json - list of base group names

  • The JSON object includes the following keys:

    • broker_id - the brokerid for which this request was made.

    • broker_name - the name of the broker

    • base_group_name - list of base group names

query Parameters
broker_id
string
Example: broker_id={{broker_id}}

(Required) enter broker id for authentication

user
string
Example: user={{user}}

(Required) for authentication

token
string
Example: token={{token}}

(Required) for authentication

expire
string
Example: expire={{expire}}

(Required) for authentication

account_type
string
Example: account_type={{account_type}}

(Required) for authentication. set to LIVE

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "broker_id": "859",
  • "broker_name": "Autochartist50Demo",
  • "default": "False",
  • "base_group_name": [
    ]
}