Nobosso REST API Documentation

AccountController

checkAccountData

Get trading account


/api/v1/account/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/account/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.checkAccountData(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#checkAccountData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.checkAccountData(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#checkAccountData");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Account ID

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Get trading account
[apiInstance checkAccountDataWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
              completionHandler: ^(TradingAccountDataResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Account ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkAccountData(xClientId, xClientApiKey, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkAccountDataExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Account ID

            try
            {
                // Get trading account
                TradingAccountDataResource result = apiInstance.checkAccountData(xClientId, xClientApiKey, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.checkAccountData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID

try {
    $result = $api_instance->checkAccountData($xClientId, $xClientApiKey, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->checkAccountData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Account ID

eval { 
    my $result = $api_instance->checkAccountData(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->checkAccountData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Account ID

try: 
    # Get trading account
    api_response = api_instance.check_account_data(xClientId, xClientApiKey, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->checkAccountData: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Account ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required

Responses

Status: 200 - OK


createAccount

Create new trading account

Using this API the client creates a new trading account, with a given initial balance, challenge and platform.


/api/v1/account

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"http://localhost:8085/api/v1/api/v1/account"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        CreateAccountResource body = ; // CreateAccountResource | 
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        try {
            TradingAccountDataResource result = apiInstance.createAccount(body, xClientId, xClientApiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#createAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        CreateAccountResource body = ; // CreateAccountResource | 
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        try {
            TradingAccountDataResource result = apiInstance.createAccount(body, xClientId, xClientApiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#createAccount");
            e.printStackTrace();
        }
    }
}
CreateAccountResource *body = ; // 
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Create new trading account
[apiInstance createAccountWith:body
    xClientId:xClientId
    xClientApiKey:xClientApiKey
              completionHandler: ^(TradingAccountDataResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var body = ; // {{CreateAccountResource}} 
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAccount(bodyxClientIdxClientApiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAccountExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var body = new CreateAccountResource(); // CreateAccountResource | 
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 

            try
            {
                // Create new trading account
                TradingAccountDataResource result = apiInstance.createAccount(body, xClientId, xClientApiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.createAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$body = ; // CreateAccountResource | 
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 

try {
    $result = $api_instance->createAccount($body, $xClientId, $xClientApiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->createAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $body = WWW::SwaggerClient::Object::CreateAccountResource->new(); # CreateAccountResource | 
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 

eval { 
    my $result = $api_instance->createAccount(body => $body, xClientId => $xClientId, xClientApiKey => $xClientApiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->createAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
body =  # CreateAccountResource | 
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 

try: 
    # Create new trading account
    api_response = api_instance.create_account(body, xClientId, xClientApiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->createAccount: %s\n" % e)

Parameters

Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


disableAccount

Disable trading account.


/api/v1/account/{id}/disable

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/account/{id}/disable"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.disableAccount(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#disableAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.disableAccount(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#disableAccount");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Account ID

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Disable trading account.
[apiInstance disableAccountWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
              completionHandler: ^(TradingAccountDataResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Account ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disableAccount(xClientId, xClientApiKey, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disableAccountExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Account ID

            try
            {
                // Disable trading account.
                TradingAccountDataResource result = apiInstance.disableAccount(xClientId, xClientApiKey, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.disableAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID

try {
    $result = $api_instance->disableAccount($xClientId, $xClientApiKey, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->disableAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Account ID

eval { 
    my $result = $api_instance->disableAccount(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->disableAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Account ID

try: 
    # Disable trading account.
    api_response = api_instance.disable_account(xClientId, xClientApiKey, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->disableAccount: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Account ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required

Responses

Status: 200 - OK


enableAccount

Enable trading account.


/api/v1/account/{id}/enable

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/account/{id}/enable"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.enableAccount(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#enableAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.enableAccount(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#enableAccount");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Account ID

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Enable trading account.
[apiInstance enableAccountWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
              completionHandler: ^(TradingAccountDataResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Account ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.enableAccount(xClientId, xClientApiKey, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class enableAccountExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Account ID

            try
            {
                // Enable trading account.
                TradingAccountDataResource result = apiInstance.enableAccount(xClientId, xClientApiKey, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.enableAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID

try {
    $result = $api_instance->enableAccount($xClientId, $xClientApiKey, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->enableAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Account ID

eval { 
    my $result = $api_instance->enableAccount(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->enableAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Account ID

try: 
    # Enable trading account.
    api_response = api_instance.enable_account(xClientId, xClientApiKey, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->enableAccount: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Account ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required

Responses

Status: 200 - OK


fundAccount

Fund trading account. Moves the account to the funded stage of this challenge.


/api/v1/account/{id}/fund

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/account/{id}/fund"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.fundAccount(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#fundAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.fundAccount(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#fundAccount");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Account ID

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Fund trading account. Moves the account to the funded stage of this challenge.
[apiInstance fundAccountWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
              completionHandler: ^(TradingAccountDataResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Account ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fundAccount(xClientId, xClientApiKey, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class fundAccountExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Account ID

            try
            {
                // Fund trading account. Moves the account to the funded stage of this challenge.
                TradingAccountDataResource result = apiInstance.fundAccount(xClientId, xClientApiKey, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.fundAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID

try {
    $result = $api_instance->fundAccount($xClientId, $xClientApiKey, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->fundAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Account ID

eval { 
    my $result = $api_instance->fundAccount(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->fundAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Account ID

try: 
    # Fund trading account. Moves the account to the funded stage of this challenge.
    api_response = api_instance.fund_account(xClientId, xClientApiKey, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->fundAccount: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Account ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required

Responses

Status: 200 - OK


getAccountActivity

Get account activity - Daily/Overall drawdowns, Limits, Target and details


/api/v1/account/{id}/activity

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/account/{id}/activity?globalSearch=&from=&to=&skip=&take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        String globalSearch = globalSearch_example; // String | 
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            PageableResourceTradingAccountStageResource result = apiInstance.getAccountActivity(xClientId, xClientApiKey, id, globalSearch, from, to, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#getAccountActivity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        String globalSearch = globalSearch_example; // String | 
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            PageableResourceTradingAccountStageResource result = apiInstance.getAccountActivity(xClientId, xClientApiKey, id, globalSearch, from, to, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#getAccountActivity");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Account ID
String *globalSearch = globalSearch_example; //  (optional)
Date *from = 2013-10-20T19:20:30+01:00; //  (optional)
Date *to = 2013-10-20T19:20:30+01:00; //  (optional)
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Get account activity - Daily/Overall drawdowns, Limits, Target and details
[apiInstance getAccountActivityWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
    globalSearch:globalSearch
    from:from
    to:to
    skip:skip
    take:take
              completionHandler: ^(PageableResourceTradingAccountStageResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Account ID
var opts = { 
  'globalSearch': globalSearch_example, // {{String}} 
  'from': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'to': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'skip': 56, // {{Integer}} 
  'take': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountActivity(xClientId, xClientApiKey, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountActivityExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Account ID
            var globalSearch = globalSearch_example;  // String |  (optional) 
            var from = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var to = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 

            try
            {
                // Get account activity - Daily/Overall drawdowns, Limits, Target and details
                PageableResourceTradingAccountStageResource result = apiInstance.getAccountActivity(xClientId, xClientApiKey, id, globalSearch, from, to, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.getAccountActivity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
$globalSearch = globalSearch_example; // String | 
$from = 2013-10-20T19:20:30+01:00; // Date | 
$to = 2013-10-20T19:20:30+01:00; // Date | 
$skip = 56; // Integer | 
$take = 56; // Integer | 

try {
    $result = $api_instance->getAccountActivity($xClientId, $xClientApiKey, $id, $globalSearch, $from, $to, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->getAccountActivity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Account ID
my $globalSearch = globalSearch_example; # String | 
my $from = 2013-10-20T19:20:30+01:00; # Date | 
my $to = 2013-10-20T19:20:30+01:00; # Date | 
my $skip = 56; # Integer | 
my $take = 56; # Integer | 

eval { 
    my $result = $api_instance->getAccountActivity(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id, globalSearch => $globalSearch, from => $from, to => $to, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->getAccountActivity: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Account ID
globalSearch = globalSearch_example # String |  (optional)
from = 2013-10-20T19:20:30+01:00 # Date |  (optional)
to = 2013-10-20T19:20:30+01:00 # Date |  (optional)
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)

try: 
    # Get account activity - Daily/Overall drawdowns, Limits, Target and details
    api_response = api_instance.get_account_activity(xClientId, xClientApiKey, id, globalSearch=globalSearch, from=from, to=to, skip=skip, take=take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->getAccountActivity: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Account ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Query parameters
Name Description
globalSearch
String
from
Date (date-time)
to
Date (date-time)
skip
Integer (int32)
take
Integer (int32)

Responses

Status: 200 - OK


getAllTrades

Get trading account trades


/api/v1/account/{id}/trade

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/account/{id}/trade?filter=&sort=&skip=&take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        String filter = filter_example; // String | 
        array[String] sort = ; // array[String] | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            PageableResourceTradeResource result = apiInstance.getAllTrades(xClientId, xClientApiKey, id, filter, sort, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#getAllTrades");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        String filter = filter_example; // String | 
        array[String] sort = ; // array[String] | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            PageableResourceTradeResource result = apiInstance.getAllTrades(xClientId, xClientApiKey, id, filter, sort, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#getAllTrades");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Account ID
String *filter = filter_example; //  (optional)
array[String] *sort = ; //  (optional)
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Get trading account trades
[apiInstance getAllTradesWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
    filter:filter
    sort:sort
    skip:skip
    take:take
              completionHandler: ^(PageableResourceTradeResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Account ID
var opts = { 
  'filter': filter_example, // {{String}} 
  'sort': , // {{array[String]}} 
  'skip': 56, // {{Integer}} 
  'take': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllTrades(xClientId, xClientApiKey, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllTradesExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Account ID
            var filter = filter_example;  // String |  (optional) 
            var sort = new array[String](); // array[String] |  (optional) 
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 

            try
            {
                // Get trading account trades
                PageableResourceTradeResource result = apiInstance.getAllTrades(xClientId, xClientApiKey, id, filter, sort, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.getAllTrades: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
$filter = filter_example; // String | 
$sort = ; // array[String] | 
$skip = 56; // Integer | 
$take = 56; // Integer | 

try {
    $result = $api_instance->getAllTrades($xClientId, $xClientApiKey, $id, $filter, $sort, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->getAllTrades: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Account ID
my $filter = filter_example; # String | 
my $sort = []; # array[String] | 
my $skip = 56; # Integer | 
my $take = 56; # Integer | 

eval { 
    my $result = $api_instance->getAllTrades(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id, filter => $filter, sort => $sort, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->getAllTrades: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Account ID
filter = filter_example # String |  (optional)
sort =  # array[String] |  (optional)
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)

try: 
    # Get trading account trades
    api_response = api_instance.get_all_trades(xClientId, xClientApiKey, id, filter=filter, sort=sort, skip=skip, take=take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->getAllTrades: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Account ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Query parameters
Name Description
filter
String
sort
array[String]
skip
Integer (int32)
take
Integer (int32)

Responses

Status: 200 - OK


getEquityGrowth

Get trading account equity and balance history


/api/v1/account/{id}/equity-growth

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/account/{id}/equity-growth?from=&to=&skip=&take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            PageableResourceBalanceAndEquityGrowth result = apiInstance.getEquityGrowth(xClientId, xClientApiKey, id, from, to, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#getEquityGrowth");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            PageableResourceBalanceAndEquityGrowth result = apiInstance.getEquityGrowth(xClientId, xClientApiKey, id, from, to, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#getEquityGrowth");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Account ID
Date *from = 2013-10-20T19:20:30+01:00; //  (optional)
Date *to = 2013-10-20T19:20:30+01:00; //  (optional)
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Get trading account equity and balance history
[apiInstance getEquityGrowthWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
    from:from
    to:to
    skip:skip
    take:take
              completionHandler: ^(PageableResourceBalanceAndEquityGrowth output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Account ID
var opts = { 
  'from': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'to': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'skip': 56, // {{Integer}} 
  'take': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEquityGrowth(xClientId, xClientApiKey, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEquityGrowthExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Account ID
            var from = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var to = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 

            try
            {
                // Get trading account equity and balance history
                PageableResourceBalanceAndEquityGrowth result = apiInstance.getEquityGrowth(xClientId, xClientApiKey, id, from, to, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.getEquityGrowth: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
$from = 2013-10-20T19:20:30+01:00; // Date | 
$to = 2013-10-20T19:20:30+01:00; // Date | 
$skip = 56; // Integer | 
$take = 56; // Integer | 

try {
    $result = $api_instance->getEquityGrowth($xClientId, $xClientApiKey, $id, $from, $to, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->getEquityGrowth: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Account ID
my $from = 2013-10-20T19:20:30+01:00; # Date | 
my $to = 2013-10-20T19:20:30+01:00; # Date | 
my $skip = 56; # Integer | 
my $take = 56; # Integer | 

eval { 
    my $result = $api_instance->getEquityGrowth(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id, from => $from, to => $to, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->getEquityGrowth: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Account ID
from = 2013-10-20T19:20:30+01:00 # Date |  (optional)
to = 2013-10-20T19:20:30+01:00 # Date |  (optional)
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)

try: 
    # Get trading account equity and balance history
    api_response = api_instance.get_equity_growth(xClientId, xClientApiKey, id, from=from, to=to, skip=skip, take=take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->getEquityGrowth: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Account ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Query parameters
Name Description
from
Date (date-time)
to
Date (date-time)
skip
Integer (int32)
take
Integer (int32)

Responses

Status: 200 - OK


getTradesOverview

Get trading account statistics


/api/v1/account/{id}/statistics

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/account/{id}/statistics"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TraderStatistics result = apiInstance.getTradesOverview(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#getTradesOverview");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TraderStatistics result = apiInstance.getTradesOverview(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#getTradesOverview");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Account ID

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Get trading account statistics
[apiInstance getTradesOverviewWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
              completionHandler: ^(TraderStatistics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Account ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTradesOverview(xClientId, xClientApiKey, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTradesOverviewExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Account ID

            try
            {
                // Get trading account statistics
                TraderStatistics result = apiInstance.getTradesOverview(xClientId, xClientApiKey, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.getTradesOverview: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID

try {
    $result = $api_instance->getTradesOverview($xClientId, $xClientApiKey, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->getTradesOverview: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Account ID

eval { 
    my $result = $api_instance->getTradesOverview(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->getTradesOverview: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Account ID

try: 
    # Get trading account statistics
    api_response = api_instance.get_trades_overview(xClientId, xClientApiKey, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->getTradesOverview: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Account ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required

Responses

Status: 200 - OK


resetAccount

Reset trading account.


/api/v1/account/{id}/reset

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/account/{id}/reset"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountControllerApi;

import java.io.File;
import java.util.*;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.resetAccount(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#resetAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountControllerApi;

public class AccountControllerApiExample {

    public static void main(String[] args) {
        AccountControllerApi apiInstance = new AccountControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID
        try {
            TradingAccountDataResource result = apiInstance.resetAccount(xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountControllerApi#resetAccount");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Account ID

AccountControllerApi *apiInstance = [[AccountControllerApi alloc] init];

// Reset trading account.
[apiInstance resetAccountWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
              completionHandler: ^(TradingAccountDataResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.AccountControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Account ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resetAccount(xClientId, xClientApiKey, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetAccountExample
    {
        public void main()
        {

            var apiInstance = new AccountControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Account ID

            try
            {
                // Reset trading account.
                TradingAccountDataResource result = apiInstance.resetAccount(xClientId, xClientApiKey, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountControllerApi.resetAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAccountControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Account ID

try {
    $result = $api_instance->resetAccount($xClientId, $xClientApiKey, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountControllerApi->resetAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountControllerApi;

my $api_instance = WWW::SwaggerClient::AccountControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Account ID

eval { 
    my $result = $api_instance->resetAccount(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountControllerApi->resetAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AccountControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Account ID

try: 
    # Reset trading account.
    api_response = api_instance.reset_account(xClientId, xClientApiKey, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountControllerApi->resetAccount: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Account ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required

Responses

Status: 200 - OK


ChallengeController

createChallenge

Create new challenge with all stages


/api/v1/challenge

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"http://localhost:8085/api/v1/api/v1/challenge"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChallengeControllerApi;

import java.io.File;
import java.util.*;

public class ChallengeControllerApiExample {

    public static void main(String[] args) {
        
        ChallengeControllerApi apiInstance = new ChallengeControllerApi();
        ChallengeResource body = ; // ChallengeResource | 
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        try {
            ChallengeResource result = apiInstance.createChallenge(body, xClientId, xClientApiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChallengeControllerApi#createChallenge");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChallengeControllerApi;

public class ChallengeControllerApiExample {

    public static void main(String[] args) {
        ChallengeControllerApi apiInstance = new ChallengeControllerApi();
        ChallengeResource body = ; // ChallengeResource | 
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        try {
            ChallengeResource result = apiInstance.createChallenge(body, xClientId, xClientApiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChallengeControllerApi#createChallenge");
            e.printStackTrace();
        }
    }
}
ChallengeResource *body = ; // 
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 

ChallengeControllerApi *apiInstance = [[ChallengeControllerApi alloc] init];

// Create new challenge with all stages
[apiInstance createChallengeWith:body
    xClientId:xClientId
    xClientApiKey:xClientApiKey
              completionHandler: ^(ChallengeResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.ChallengeControllerApi()
var body = ; // {{ChallengeResource}} 
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createChallenge(bodyxClientIdxClientApiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createChallengeExample
    {
        public void main()
        {

            var apiInstance = new ChallengeControllerApi();
            var body = new ChallengeResource(); // ChallengeResource | 
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 

            try
            {
                // Create new challenge with all stages
                ChallengeResource result = apiInstance.createChallenge(body, xClientId, xClientApiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChallengeControllerApi.createChallenge: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChallengeControllerApi();
$body = ; // ChallengeResource | 
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 

try {
    $result = $api_instance->createChallenge($body, $xClientId, $xClientApiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChallengeControllerApi->createChallenge: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChallengeControllerApi;

my $api_instance = WWW::SwaggerClient::ChallengeControllerApi->new();
my $body = WWW::SwaggerClient::Object::ChallengeResource->new(); # ChallengeResource | 
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 

eval { 
    my $result = $api_instance->createChallenge(body => $body, xClientId => $xClientId, xClientApiKey => $xClientApiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChallengeControllerApi->createChallenge: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChallengeControllerApi()
body =  # ChallengeResource | 
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 

try: 
    # Create new challenge with all stages
    api_response = api_instance.create_challenge(body, xClientId, xClientApiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChallengeControllerApi->createChallenge: %s\n" % e)

Parameters

Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


getAllChallenges

Get all challenges


/api/v1/challenge

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/challenge?id=&globalSearch=&from=&to=&skip=&take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChallengeControllerApi;

import java.io.File;
import java.util.*;

public class ChallengeControllerApiExample {

    public static void main(String[] args) {
        
        ChallengeControllerApi apiInstance = new ChallengeControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String globalSearch = globalSearch_example; // String | 
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            PageableResourceChallengeResource result = apiInstance.getAllChallenges(xClientId, xClientApiKey, id, globalSearch, from, to, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChallengeControllerApi#getAllChallenges");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChallengeControllerApi;

public class ChallengeControllerApiExample {

    public static void main(String[] args) {
        ChallengeControllerApi apiInstance = new ChallengeControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String globalSearch = globalSearch_example; // String | 
        Date from = 2013-10-20T19:20:30+01:00; // Date | 
        Date to = 2013-10-20T19:20:30+01:00; // Date | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            PageableResourceChallengeResource result = apiInstance.getAllChallenges(xClientId, xClientApiKey, id, globalSearch, from, to, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChallengeControllerApi#getAllChallenges");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
String *globalSearch = globalSearch_example; //  (optional)
Date *from = 2013-10-20T19:20:30+01:00; //  (optional)
Date *to = 2013-10-20T19:20:30+01:00; //  (optional)
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)

ChallengeControllerApi *apiInstance = [[ChallengeControllerApi alloc] init];

// Get all challenges
[apiInstance getAllChallengesWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
    globalSearch:globalSearch
    from:from
    to:to
    skip:skip
    take:take
              completionHandler: ^(PageableResourceChallengeResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.ChallengeControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'globalSearch': globalSearch_example, // {{String}} 
  'from': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'to': 2013-10-20T19:20:30+01:00, // {{Date}} 
  'skip': 56, // {{Integer}} 
  'take': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllChallenges(xClientId, xClientApiKey, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllChallengesExample
    {
        public void main()
        {

            var apiInstance = new ChallengeControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | 
            var globalSearch = globalSearch_example;  // String |  (optional) 
            var from = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var to = 2013-10-20T19:20:30+01:00;  // Date |  (optional) 
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 

            try
            {
                // Get all challenges
                PageableResourceChallengeResource result = apiInstance.getAllChallenges(xClientId, xClientApiKey, id, globalSearch, from, to, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChallengeControllerApi.getAllChallenges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChallengeControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$globalSearch = globalSearch_example; // String | 
$from = 2013-10-20T19:20:30+01:00; // Date | 
$to = 2013-10-20T19:20:30+01:00; // Date | 
$skip = 56; // Integer | 
$take = 56; // Integer | 

try {
    $result = $api_instance->getAllChallenges($xClientId, $xClientApiKey, $id, $globalSearch, $from, $to, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChallengeControllerApi->getAllChallenges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChallengeControllerApi;

my $api_instance = WWW::SwaggerClient::ChallengeControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $globalSearch = globalSearch_example; # String | 
my $from = 2013-10-20T19:20:30+01:00; # Date | 
my $to = 2013-10-20T19:20:30+01:00; # Date | 
my $skip = 56; # Integer | 
my $take = 56; # Integer | 

eval { 
    my $result = $api_instance->getAllChallenges(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id, globalSearch => $globalSearch, from => $from, to => $to, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChallengeControllerApi->getAllChallenges: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChallengeControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
globalSearch = globalSearch_example # String |  (optional)
from = 2013-10-20T19:20:30+01:00 # Date |  (optional)
to = 2013-10-20T19:20:30+01:00 # Date |  (optional)
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)

try: 
    # Get all challenges
    api_response = api_instance.get_all_challenges(xClientId, xClientApiKey, id, globalSearch=globalSearch, from=from, to=to, skip=skip, take=take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChallengeControllerApi->getAllChallenges: %s\n" % e)

Parameters

Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Query parameters
Name Description
id*
UUID (uuid)
Required
globalSearch
String
from
Date (date-time)
to
Date (date-time)
skip
Integer (int32)
take
Integer (int32)

Responses

Status: 200 - OK


getChallenge

Get a challenge


/api/v1/challenge/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/challenge/{id}?resource="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChallengeControllerApi;

import java.io.File;
import java.util.*;

public class ChallengeControllerApiExample {

    public static void main(String[] args) {
        
        ChallengeControllerApi apiInstance = new ChallengeControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Challenge ID
        ChallengeResource resource = ; // ChallengeResource | 
        try {
            ChallengeResource result = apiInstance.getChallenge(xClientId, xClientApiKey, id, resource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChallengeControllerApi#getChallenge");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChallengeControllerApi;

public class ChallengeControllerApiExample {

    public static void main(String[] args) {
        ChallengeControllerApi apiInstance = new ChallengeControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Challenge ID
        ChallengeResource resource = ; // ChallengeResource | 
        try {
            ChallengeResource result = apiInstance.getChallenge(xClientId, xClientApiKey, id, resource);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChallengeControllerApi#getChallenge");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Challenge ID
ChallengeResource *resource = ; // 

ChallengeControllerApi *apiInstance = [[ChallengeControllerApi alloc] init];

// Get a challenge
[apiInstance getChallengeWith:xClientId
    xClientApiKey:xClientApiKey
    id:id
    resource:resource
              completionHandler: ^(ChallengeResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.ChallengeControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Challenge ID
var resource = ; // {{ChallengeResource}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChallenge(xClientId, xClientApiKey, id, resource, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getChallengeExample
    {
        public void main()
        {

            var apiInstance = new ChallengeControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Challenge ID
            var resource = new ChallengeResource(); // ChallengeResource | 

            try
            {
                // Get a challenge
                ChallengeResource result = apiInstance.getChallenge(xClientId, xClientApiKey, id, resource);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChallengeControllerApi.getChallenge: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChallengeControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Challenge ID
$resource = ; // ChallengeResource | 

try {
    $result = $api_instance->getChallenge($xClientId, $xClientApiKey, $id, $resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChallengeControllerApi->getChallenge: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChallengeControllerApi;

my $api_instance = WWW::SwaggerClient::ChallengeControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Challenge ID
my $resource = ; # ChallengeResource | 

eval { 
    my $result = $api_instance->getChallenge(xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id, resource => $resource);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChallengeControllerApi->getChallenge: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChallengeControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Challenge ID
resource =  # ChallengeResource | 

try: 
    # Get a challenge
    api_response = api_instance.get_challenge(xClientId, xClientApiKey, id, resource)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChallengeControllerApi->getChallenge: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Challenge ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Query parameters
Name Description
resource*
ChallengeResource
Required

Responses

Status: 200 - OK


updateChallenge

Update a challenge


/api/v1/challenge/{id}

Usage and SDK Samples

curl -X PUT\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"http://localhost:8085/api/v1/api/v1/challenge/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChallengeControllerApi;

import java.io.File;
import java.util.*;

public class ChallengeControllerApiExample {

    public static void main(String[] args) {
        
        ChallengeControllerApi apiInstance = new ChallengeControllerApi();
        ChallengeResource body = ; // ChallengeResource | 
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Challenge ID
        try {
            ChallengeResource result = apiInstance.updateChallenge(body, xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChallengeControllerApi#updateChallenge");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChallengeControllerApi;

public class ChallengeControllerApiExample {

    public static void main(String[] args) {
        ChallengeControllerApi apiInstance = new ChallengeControllerApi();
        ChallengeResource body = ; // ChallengeResource | 
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Challenge ID
        try {
            ChallengeResource result = apiInstance.updateChallenge(body, xClientId, xClientApiKey, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChallengeControllerApi#updateChallenge");
            e.printStackTrace();
        }
    }
}
ChallengeResource *body = ; // 
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Challenge ID

ChallengeControllerApi *apiInstance = [[ChallengeControllerApi alloc] init];

// Update a challenge
[apiInstance updateChallengeWith:body
    xClientId:xClientId
    xClientApiKey:xClientApiKey
    id:id
              completionHandler: ^(ChallengeResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.ChallengeControllerApi()
var body = ; // {{ChallengeResource}} 
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Challenge ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateChallenge(bodyxClientIdxClientApiKeyid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateChallengeExample
    {
        public void main()
        {

            var apiInstance = new ChallengeControllerApi();
            var body = new ChallengeResource(); // ChallengeResource | 
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var id = new UUID(); // UUID | Challenge ID

            try
            {
                // Update a challenge
                ChallengeResource result = apiInstance.updateChallenge(body, xClientId, xClientApiKey, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChallengeControllerApi.updateChallenge: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiChallengeControllerApi();
$body = ; // ChallengeResource | 
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Challenge ID

try {
    $result = $api_instance->updateChallenge($body, $xClientId, $xClientApiKey, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChallengeControllerApi->updateChallenge: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChallengeControllerApi;

my $api_instance = WWW::SwaggerClient::ChallengeControllerApi->new();
my $body = WWW::SwaggerClient::Object::ChallengeResource->new(); # ChallengeResource | 
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Challenge ID

eval { 
    my $result = $api_instance->updateChallenge(body => $body, xClientId => $xClientId, xClientApiKey => $xClientApiKey, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChallengeControllerApi->updateChallenge: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ChallengeControllerApi()
body =  # ChallengeResource | 
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Challenge ID

try: 
    # Update a challenge
    api_response = api_instance.update_challenge(body, xClientId, xClientApiKey, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChallengeControllerApi->updateChallenge: %s\n" % e)

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Challenge ID
Required
Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


TradeController

getTradingActivity

Get all trading accounts activity


/api/v1/trading/activity

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/trading/activity?globalSearch=&sort=&skip=&take=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TradeControllerApi;

import java.io.File;
import java.util.*;

public class TradeControllerApiExample {

    public static void main(String[] args) {
        
        TradeControllerApi apiInstance = new TradeControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        String globalSearch = globalSearch_example; // String | 
        array[String] sort = ; // array[String] | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            PageableResourceTradingAccountStageResource result = apiInstance.getTradingActivity(xClientId, xClientApiKey, globalSearch, sort, skip, take, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TradeControllerApi#getTradingActivity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TradeControllerApi;

public class TradeControllerApiExample {

    public static void main(String[] args) {
        TradeControllerApi apiInstance = new TradeControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        String globalSearch = globalSearch_example; // String | 
        array[String] sort = ; // array[String] | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            PageableResourceTradingAccountStageResource result = apiInstance.getTradingActivity(xClientId, xClientApiKey, globalSearch, sort, skip, take, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TradeControllerApi#getTradingActivity");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
String *globalSearch = globalSearch_example; //  (optional)
array[String] *sort = ; //  (optional)
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)
String *filter = filter_example; //  (optional)

TradeControllerApi *apiInstance = [[TradeControllerApi alloc] init];

// Get all trading accounts activity
[apiInstance getTradingActivityWith:xClientId
    xClientApiKey:xClientApiKey
    globalSearch:globalSearch
    sort:sort
    skip:skip
    take:take
    filter:filter
              completionHandler: ^(PageableResourceTradingAccountStageResource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.TradeControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var opts = { 
  'globalSearch': globalSearch_example, // {{String}} 
  'sort': , // {{array[String]}} 
  'skip': 56, // {{Integer}} 
  'take': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTradingActivity(xClientId, xClientApiKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTradingActivityExample
    {
        public void main()
        {

            var apiInstance = new TradeControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var globalSearch = globalSearch_example;  // String |  (optional) 
            var sort = new array[String](); // array[String] |  (optional) 
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get all trading accounts activity
                PageableResourceTradingAccountStageResource result = apiInstance.getTradingActivity(xClientId, xClientApiKey, globalSearch, sort, skip, take, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TradeControllerApi.getTradingActivity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTradeControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$globalSearch = globalSearch_example; // String | 
$sort = ; // array[String] | 
$skip = 56; // Integer | 
$take = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getTradingActivity($xClientId, $xClientApiKey, $globalSearch, $sort, $skip, $take, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TradeControllerApi->getTradingActivity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TradeControllerApi;

my $api_instance = WWW::SwaggerClient::TradeControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $globalSearch = globalSearch_example; # String | 
my $sort = []; # array[String] | 
my $skip = 56; # Integer | 
my $take = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getTradingActivity(xClientId => $xClientId, xClientApiKey => $xClientApiKey, globalSearch => $globalSearch, sort => $sort, skip => $skip, take => $take, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TradeControllerApi->getTradingActivity: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TradeControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
globalSearch = globalSearch_example # String |  (optional)
sort =  # array[String] |  (optional)
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)
filter = filter_example # String |  (optional)

try: 
    # Get all trading accounts activity
    api_response = api_instance.get_trading_activity(xClientId, xClientApiKey, globalSearch=globalSearch, sort=sort, skip=skip, take=take, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TradeControllerApi->getTradingActivity: %s\n" % e)

Parameters

Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Query parameters
Name Description
globalSearch
String
sort
array[String]
skip
Integer (int32)
take
Integer (int32)
filter
String

Responses

Status: 200 - OK


getTradingStatistics

Get all accounts stats


/api/v1/trading/stats

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"http://localhost:8085/api/v1/api/v1/trading/stats?globalSearch=&filter=&sort=&skip=&take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TradeControllerApi;

import java.io.File;
import java.util.*;

public class TradeControllerApiExample {

    public static void main(String[] args) {
        
        TradeControllerApi apiInstance = new TradeControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        String globalSearch = globalSearch_example; // String | 
        String filter = filter_example; // String | 
        array[String] sort = ; // array[String] | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            TradeStats result = apiInstance.getTradingStatistics(xClientId, xClientApiKey, globalSearch, filter, sort, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TradeControllerApi#getTradingStatistics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TradeControllerApi;

public class TradeControllerApiExample {

    public static void main(String[] args) {
        TradeControllerApi apiInstance = new TradeControllerApi();
        String xClientId = xClientId_example; // String | 
        String xClientApiKey = xClientApiKey_example; // String | 
        String globalSearch = globalSearch_example; // String | 
        String filter = filter_example; // String | 
        array[String] sort = ; // array[String] | 
        Integer skip = 56; // Integer | 
        Integer take = 56; // Integer | 
        try {
            TradeStats result = apiInstance.getTradingStatistics(xClientId, xClientApiKey, globalSearch, filter, sort, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TradeControllerApi#getTradingStatistics");
            e.printStackTrace();
        }
    }
}
String *xClientId = xClientId_example; // 
String *xClientApiKey = xClientApiKey_example; // 
String *globalSearch = globalSearch_example; //  (optional)
String *filter = filter_example; //  (optional)
array[String] *sort = ; //  (optional)
Integer *skip = 56; //  (optional)
Integer *take = 56; //  (optional)

TradeControllerApi *apiInstance = [[TradeControllerApi alloc] init];

// Get all accounts stats
[apiInstance getTradingStatisticsWith:xClientId
    xClientApiKey:xClientApiKey
    globalSearch:globalSearch
    filter:filter
    sort:sort
    skip:skip
    take:take
              completionHandler: ^(TradeStats output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var NobossoRestApiDocumentation = require('nobosso_rest_api_documentation');

var api = new NobossoRestApiDocumentation.TradeControllerApi()
var xClientId = xClientId_example; // {{String}} 
var xClientApiKey = xClientApiKey_example; // {{String}} 
var opts = { 
  'globalSearch': globalSearch_example, // {{String}} 
  'filter': filter_example, // {{String}} 
  'sort': , // {{array[String]}} 
  'skip': 56, // {{Integer}} 
  'take': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTradingStatistics(xClientId, xClientApiKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTradingStatisticsExample
    {
        public void main()
        {

            var apiInstance = new TradeControllerApi();
            var xClientId = xClientId_example;  // String | 
            var xClientApiKey = xClientApiKey_example;  // String | 
            var globalSearch = globalSearch_example;  // String |  (optional) 
            var filter = filter_example;  // String |  (optional) 
            var sort = new array[String](); // array[String] |  (optional) 
            var skip = 56;  // Integer |  (optional) 
            var take = 56;  // Integer |  (optional) 

            try
            {
                // Get all accounts stats
                TradeStats result = apiInstance.getTradingStatistics(xClientId, xClientApiKey, globalSearch, filter, sort, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TradeControllerApi.getTradingStatistics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTradeControllerApi();
$xClientId = xClientId_example; // String | 
$xClientApiKey = xClientApiKey_example; // String | 
$globalSearch = globalSearch_example; // String | 
$filter = filter_example; // String | 
$sort = ; // array[String] | 
$skip = 56; // Integer | 
$take = 56; // Integer | 

try {
    $result = $api_instance->getTradingStatistics($xClientId, $xClientApiKey, $globalSearch, $filter, $sort, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TradeControllerApi->getTradingStatistics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TradeControllerApi;

my $api_instance = WWW::SwaggerClient::TradeControllerApi->new();
my $xClientId = xClientId_example; # String | 
my $xClientApiKey = xClientApiKey_example; # String | 
my $globalSearch = globalSearch_example; # String | 
my $filter = filter_example; # String | 
my $sort = []; # array[String] | 
my $skip = 56; # Integer | 
my $take = 56; # Integer | 

eval { 
    my $result = $api_instance->getTradingStatistics(xClientId => $xClientId, xClientApiKey => $xClientApiKey, globalSearch => $globalSearch, filter => $filter, sort => $sort, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TradeControllerApi->getTradingStatistics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TradeControllerApi()
xClientId = xClientId_example # String | 
xClientApiKey = xClientApiKey_example # String | 
globalSearch = globalSearch_example # String |  (optional)
filter = filter_example # String |  (optional)
sort =  # array[String] |  (optional)
skip = 56 # Integer |  (optional)
take = 56 # Integer |  (optional)

try: 
    # Get all accounts stats
    api_response = api_instance.get_trading_statistics(xClientId, xClientApiKey, globalSearch=globalSearch, filter=filter, sort=sort, skip=skip, take=take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TradeControllerApi->getTradingStatistics: %s\n" % e)

Parameters

Header parameters
Name Description
X-Client-Id*
String
Required
X-Client-Api-Key*
String
Required
Query parameters
Name Description
globalSearch
String
filter
String
sort
array[String]
skip
Integer (int32)
take
Integer (int32)

Responses

Status: 200 - OK