Performance Stats API (1.0.0)

Download OpenAPI specification: [Performance_Stats_API.yaml]

This document describes Autochartist's Performance Statistics

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)

Performance Stats

Performance Stats

Returns Autochartist performance stats for all the instruments defined for the specified broker_id.

Return format

  • Status 200 - application/json - latest pattern results.

  • The JSON object includes the following keys:

    • group - the asset class / grouping, along with a breakdown for either "brekout" or "emerging" patterns.

      • Each of these grouping is broken down further by quality indicator.

Fields

Each of the "nodes" of the stats comprises of the following fields:

  • value - the value of the quality indicator

  • total - the quantity of results identified

  • correct - the quantity of results that hit the specified target

  • percentage - correct/total * 100

  • from - the start of the period analyzed

  • to - the end of the period analyzed

Requires authentication

A valid request with an authorized MD5 token will be accepted

query Parameters
broker_id
string
Example: broker_id={{broker_id}}
token
string
Example: token={{token}}
user
string
Example: user={{user}}
expire
string
Example: expire={{expire}}
account_type
string
Example: account_type={{account_type}}

Responses

Response samples

Content type
application/json
{
  • "brokerId": 859,
  • "from": "2023-08-31 06:06:46.514000+02:00",
  • "to": "2024-08-31 06:08:48.617000+02:00",
  • "group": [
    ]
}