Skip to content
ScaleTrade platform
ScaleTrade Plugin API - Hook Trade Process Commission
Initializing search
ScaleTrade
Home
Trading Platform
Platform
Plugins
Client API
FIX API
Report
STS Script
AST protocol
Custom Development
Ecosystem
ScaleTrade Blog
About Us
Downloads
Mission and Principles
Technology Stack
Career
Info
Self-Hosted Platform
White Label Platform
Platform Migration Guide
ScaleTrade platform
ScaleTrade
Home
Trading Platform
Trading Platform
Platform
Platform
Main Server
Main Server
Installation
Configurations
Backup Server
Backup Server
Installation
Trading Terminal
Trading Terminal
Introduction
Login
Layout and Modules Overview
Market list
Trading panel
Positions, Pending Orders and History
Chart
Header values and buttons
Footer tools
Mobile Apps
Mobile Apps
Backoffice
Backoffice
Instructions
Instructions
Domain parking
Single Sign On (SSO)
Custom CRM integration
Wildcard Masks
Where Filter
Plugins
Plugins
Features
Processing
Recommendations
Debugging
Events
Events
Trade
Trade
OnTradeRequestOpen
OnTradeAddOpen
OnTradeRequestUpdate
OnTradeRequestDelete
OnTradeRequestClose
Accounts
Accounts
OnAccountAdd
OnAccountUpdate
OnAccountDelete
OnAccountLogin
OnAccountLogout
OnAccountSync
Symbols
Symbols
OnSymbolAdd
OnSymbolUpdate
OnSymbolDelete
OnSymbolSync
Spreads
Spreads
OnSpreadAdd
OnSpreadUpdate
OnSpreadDelete
Groups
Groups
OnGroupAdd
OnGroupUpdate
OnGroupDelete
OnGroupSync
System
System
OnServerConnect
OnConServerUpdate
OnPluginUpdate
OnFeederUpdate
OnTimeUpdate
OnHolidayUpdate
Hooks
Hooks
Trade
Trade
HookTradeRequestOpen
HookTradeProcessOpen
HookTradeRequestClose
HookTradeProcessClose
HookTradeProcessCommission
HookTradeProcessMarginCall
HookTradeProcessStopOut
Accounts
Accounts
HookAccountAdd
HookAccountUpdate
HookAccountDelete
HookAccountLogin
System
System
HookServerConnect
Plugins API
Plugins API
Trade
Trade
Open Trade
Close Trade
Check Open Trade
Check Close Trade
Update Open Trade
Update Close Trade
Update Pending Trade
Set Trade Gateway Data
Get Open Trades By Login
Get Open Trades By Magic
Get Open Trade By Order
Get Open Trade By Gateway UUID
Get Close Trade By Gateway UUID
Get Open Trade By Gateway Order
Get Close Trade By Gateway Order
Get Open Trades By Group
Get Close Trades By Login
Get Close Trades By Group
Get All Open Trades
Accounts
Accounts
Add Account
Update Account
Delete Account
Get Account Balance
Get Account By Login
Get Accounts By Group
Groups
Groups
Get Group
Get All Groups
Symbols
Symbols
Get Symbol
Finance
Finance
Balance In
Balance Out
Credit In
Credit Out
Get Transactions By Group
System
System
Get Info
Get Server Time
Get Working Time
Get Holidays
Client API
Client API
Rest API
Rest API
HTTP Status Codes
Auth
Auth
P
Sign In
P
Sign Up
P
CustomerRegistration
P
AuthCustomer
G
GetCustomerSelf
G
GetCustomerAccountGroups
P
OpenCustomerAccount
Customer Auth Overview
G
GetCustomerSessionAccounts
G
GetCustomerOTP
U
SetCustomerOTP
P
CheckCustomerOTP
D
ResetCustomerOTP
G
Check session
U
Update account password
Trading
Trading
P
Open Trade
P
Open Pending Trade
DELETE
Close Trade
DELETE
Cancel pending Trade
DELETE
Close Group Trade
DELETE
Cancel Group Pending Trade
U
Modify Open Trade
U
Modify Pending Trade
G
Get Open Trades
P
Export Trades By Login
G
Get History Trades
Market
Market
G
Get Market Info
G
Get Market Short List
G
Get Assets List
G
Get Candle History
G
Market Watch
P
Add Market Watch
U
Update Market Watch
D
Delete Market Watch
G
Get Asset Info
Scripts
Scripts
G
Get Scripts
G
Get Script
P
Add Script
U
Update Script
D
Delete Script
Account
Account
G
Get Account Profile
U
Update Account Profile
P
Upload Account Avatar
G
Get Balance Snapshot
Cashier
Cashier
G
Get Cashier Methods
P
Create Cashier Deposit
P
Create Cashier Withdrawal
G
Get Cashier Transactions
P
Process Cashier Webhook
Settings
Settings
G
Get Settings By Login
U
Set Setting
D
Delete Setting
Price Alerts
Price Alerts
G
Get Price Alerts
G
Get Price Alert Logs
P
Create Price Alert
U
Update Price Alert
DELETE
Delete Price Alert
DELETE
Delete Price Alert Log
DELETE
Delete All Price Alert Logs
Notifications
Notifications
G
Get Notifications
U
Update Notification Status
U
Read All Notifications
D
Delete Notification
D
Delete All Notifications
Prop Trading
Prop Trading
G
Get Prop Programs
G
Get Prop Program
P
Preview Prop Challenge
G
Get Prop Program Payer Accounts
P
Buy Prop Challenge
G
Get Prop Purchase
G
Get My Prop Challenges
Copy Trading
Copy Trading
G
Get Copy Trade Masters
G
Get Copy Trade My
G
Get Customer Subscriptions By Filter
G
Get Copy Trade Links
G
Get Copy Trade Rewards
P
Create Copy Trade Master
U
Update Copy Trade Master
D
Delete Copy Trade Master
P
Create Copy Trade Follower
U
Update Copy Trade Follower
D
Delete Copy Trade Follower
P
Create Copy Trade Subscription
U
Update Copy Trade Subscription
D
Delete Copy Trade Subscription
KYC
KYC
G
Customer KYC Status
P
Submit KYC Step
P
Add KYC Document
Statistics
Statistics
G
Get ROI Statistics
G
Get Closed Trade Summary
WS Stream
WS Stream
Quotes event
Balance event
Margin State event
Trade event
Notification event
Price Alert event
Server API
Server API
Getting Started
Getting Started
Filtering
Auth
Auth
Manager auth
Manager OTP flow
Check account session
Check account session
SSO account
Update account password
Check account password
Clients & CRM
Clients & CRM
Accounts
Accounts
MngAddAccount
New
Get Account By Login
MngUpdateAccount
Link Account To Customer
Unlink Account From Customer
MngDeleteAccount
MngDeleteAccountsList
MngGetAccountsByFilter
Export Accounts By Filter
MngGetAccountsByGroup
MngGetAccountsByLogins
Get Accounts By Customer ID
MngGetAccountInfo
GetAccountBalance
MngGetAccountsBalanceList
MngGetAccountsListByGrpoup
Get Accounts Short List By Desk
Get Margin Calls
Customers
Customers
Add Customer
Update Customer
Delete Customer
Get Customer
Get Customers By Filter
Get Customers Short List By Desk
Get Customer Contacts
Export Customers By Filter
Get Customer Accounts
Get Customer By Login
Set Customer Password
Check Customer Password
Customer Statuses
Customer Statuses
Add Customer Status
Update Customer Status
Delete Customer Status
Get Customer Status
Get Customer Statuses By Filter
Leads
Leads
Add Lead
Update Lead
Delete Lead
Archive Lead
Get Lead
Get Leads By Filter
Get Leads Short List By Desk
Convert Lead To Customer
Desks
Desks
Add Desk
Update Desk
Archive Desk
Delete Desk
Get Desk
Get Desks By Filter
Notes
Notes
Add Note
Update Note
Delete Note
Archive Note
Get Note
Get Notes By Customer ID
Get Notes By Lead ID
Calendar
Calendar
Add Calendar Event
Update Calendar Event
Delete Calendar Event
Archive Calendar Event
Complete Calendar Event
Get Calendar Event
Get Calendar Events By Filter
KYC
KYC
Add KYC Step Template
Update KYC Step Template
Delete KYC Step Template
Get KYC Step Templates
Get KYC Profile
Get KYC Profiles
Get KYC Step
Require KYC Step
Set KYC Required Level
Approve KYC Step
Reject KYC Step
Add KYC Document
Get KYC Documents
Approve KYC Document
Reject KYC Document
Get KYC Audit
Workflow
Workflow
Get Workflow Triggers
Get Workflow Actions By Trigger
Get Workflow Conditions By Trigger
Validate Workflow Rule
Test Workflow Rule
Add Workflow Rule
Update Workflow Rule
Archive Workflow Rule
Delete Workflow Rule
Get Workflow Rule
Get Workflow Rules By Filter
Get Workflow Run
Get Workflow Runs By Filter
Trading
Trading
Trading
Trading
Overview
Trade Request Lifecycle
Get Trades By Group
Get Trade By Order
Get Trade By Orders List
Get History By Login
Open Trade
Open Trade Sync
Open Pending Trade
Close Trade
Close Trade Sync
Update Open Trade
Update Open Trade Sync
Update Pending Trade
Update Pending Trade Sync
Update Close Trade
Update Close Trade Sync
Update Trade Sync
Reopen Trade
Delete Trade
Delete Trades List
Cancel Trade
Cancel Trades List
Cancel Pending Trade
Cancel Pending Trades List
Get Trades By Filter
Export Trades By Filter
Export Trades By Login
Get Trades By Login
Get Trades By Symbol
Get Exposure By Login
Get Exposure By Group
Import Open Trade
Import History Trade
Import History Trades List
Update Trade
Market
Market
Get Market Info
Get Market Short List
Get Market Symbol
Get Symbol Tickers
Get Cross Currency Symbols
Get Market Watch
Add Market Watch
Update Market Watch
Delete Market Watch
Symbols
Symbols
Get symbols list
Get symbols tickers
Get symbol
Add symbol
Update symbol
Delete symbol
Delete symbols list
Reindex symbols
Get symbols group list
Add symbols group
Update symbol group
Delete symbol group
Reindex symbol groups
Get symbols summary
Get Cross Currency Symbols
Groups
Groups
Overview
Add group
Update group
Delete group
Get groups list
Dealing Center
Dealing Center
Model and lifecycle
TCP API
Dealer pools
Dealer pools
Get dealer pools
Get dealer pool
Add dealer pool
Update dealer pool
Delete dealer pool
Enable or disable dealer pool
Dealer requests
Dealer requests
Dealer request events
Get dealer requests
Get dealer request
Claim dealer request
Release dealer request
Accept dealer request
Reject dealer request
Virtual Dealer
Virtual Dealer
Model and execution
Get policies
Get policy
Add policy
Update policy
Delete policy
Enable or disable policy
Execution Routing
Execution Routing
Model and matching
TCP API
Get routes
Get route
Add route
Update route
Delete route
Enable or disable route
Resolve route
Copy Trading
Copy Trading
Create Copy Master
Update Copy Master
Delete Copy Master
Get Copy Masters By Filter
Create Copy Follower
Update Copy Follower
Delete Copy Follower
Get Copy Followers By Filter
Create Copy Subscription
Update Copy Subscription
Delete Copy Subscription
Get Copy Subscriptions By Filter
Get Copy Trade Links By Filter
Create Copy Reward Policy
Update Copy Reward Policy
Delete Copy Reward Policy
Get Copy Reward Policies By Filter
Get Copy Reward Accruals By Filter
Prop Trading
Prop Trading
Create Prop Program
Update Prop Program
Delete Prop Program
Get Prop Program
Get Prop Programs By Filter
Get Prop Purchase
Get Prop Purchases By Filter
Update Prop Purchase
Delete Prop Purchase
Get Prop Challanges By Filter
Get Prop Challenge
Get Prop Challenge Metrics
Get Prop Challenge Breaches
Finance & Payments
Finance & Payments
Finances
Finances
Credit and withdrawal policy
Fix balance
Create Finance Request
Approve Finance Request
Decline Finance Request
Add balance
Add balance sync
Decrease balance
Decrease balance sync
Add credit
Add credit sync
Decrease credit
Decrease credit sync
Delete balance
Delete balance sync
Delete credit
Delete credit sync
Add bonus
Decrease bonus
Delete bonus
Convert bonus to balance
Get bonus transactions
Cashier
Cashier
Get Cashier Transactions By Filter
Get Cashier Transaction
Update Cashier Transaction
Create Manual Cashier Deposit
Create Manual Cashier Withdrawal
Process Manual Cashier Transaction
Get Cashier Provider Events By Filter
Get Cashier Payment Modules
Get Cashier Provider Configs By Filter
Add Cashier Provider Config
Update Cashier Provider Config
Delete Cashier Provider Config
Get Cashier Customer Provider Overrides By Filter
Get Cashier Customer Provider Override
Update Cashier Customer Provider Override
Get Cashier Providers
Connectivity & Market Data
Connectivity & Market Data
FIX Session Management
FIX Session Management
Get FIX slots
Get FIX slot by id
Assign FIX slot
Release FIX slot
Release FIX slots by login
Rotate FIX slot password
Set FIX slot password
Set FIX slot enabled
Update FIX slot rules
Gateways
Gateways
Get available gateways
Get gateways
Get gateway
Get gateways runtime
Get gateway runtime
Add gateway
Update gateway
Delete gateway
Enable or disable gateway
Start gateway
Stop gateway
Restart gateway
Chart
Chart
Get candles data
Get candles data by count
Import candles data
Update candle data
Delete candle data
Delete candle period
Fix spike candle
Sync history chart data
Set custom quote
Events
Events
Event info
Notify event
Symbols event
Managers event
Trades event
Quotes event
Margin State event
Reindex symbols event
Administration
Administration
Managers
Managers
Staff Access Model
Add Manager
Update Manager
Delete Manager
Get Managers
Get Managers By Filter
Update Password
Manager OTP flow
Get OTP Link
Set OTP secret
Check OTP Code
Reset OTP
Config
Config
Get config
Update config
Add brand
Update brand
Delete brand
Get brands list
Get brands names
Settings
Settings
Get settings
Set setting
Delete setting
Reset settings
Plugins
Plugins
Structures
Get plugins connectors
Get plugins list
Add plugin
Update plugin
Sort plugin
Delete plugin
Start plugin
Stop plugin
Scripts
Scripts
Get scripts
Get script
Add script
Update script
Delete script
Notifications
Notifications
Get notifications
Add notification
Update notification
Delete notification
Read all notifications
Delete all notifications
Operations & Monitoring
Operations & Monitoring
Logs
Logs
Get logs
Get logs by filter
Export logs by filter
Statistics
Statistics
Get stat by group
Get server stat
Get dashboard account stats by group mask
Get dashboard daily stats by group mask
Get dashboard trade stats by group mask
Get margin level distribution by group mask
Get trading activity by group mask
Reports
Reports
Get reports list
Create report
Backups
Backups
Backup flow
Get backup config
Add backup config
Update backup config
Delete backup config
Start full backup
Get backup progress
Get backup runs
Get backup run
Delete backup run
Get backup participants
Get remote backup runs
Delete remote backup run
Import remote backup run
Validate backup run
Start restore run
Get restore runs
Get restore run
Stop backup server
Legacy get config
Utilities
Utilities
Calculate commission
Calculate swap
Calculate margin
Calculate profit
Global search
FIX API
FIX API
Connection and Logon
Heartbeat and Test Request
Logout
NewOrderSingle
ExecutionReport
MarketDataRequest
MarketDataSnapshotFullRefresh
Specification
Report
Report
Interaction
Requirements
Simple example
STS Script
STS Script
Runtime
AST
API Reference
API Reference
Inputs
Series
Events
Technical Analysis
Chart
Trade
Examples
AST protocol
AST protocol
Architecture
Getting Started
API Reference
API Reference
Node Structure
Constructors
Serialization
Examples
Examples
HTML Reports
Charts and Tables
Charts and Tales Draft
Custom Development
Ecosystem
ScaleTrade Blog
About Us
Downloads
Mission and Principles
Technology Stack
Career
Info
Info
Self-Hosted Platform
White Label Platform
Platform Migration Guide
In Progress
¶
This page is under development.
The content will be added soon.