Skip to content

Get config

GetConfig

Description: Retrieves the global configuration of the trading server, including license details, operational modes, paths, and system-wide settings.

Access Control

🛡️ Access Level Required: SESSION_ADMIN or SESSION_MANAGER


Request Parameters

None required.


Response Parameters

Name Type Description
server_build string Server build version
typeofdemo int Demo type (0 = none, 1 = time-limited, etc.)
timeofdemo int Demo duration in seconds or milliseconds
timezone int Server timezone offset
antiflood int Anti-flood flag
floodcontrol int Flood control settings
daylightcorrection int 1 if daylight saving is enabled
feeder_timeout int Timeout value for feeders
rollovers_mode int Rollovers handling mode
path_database string Path to the database
path_history string Path to historical data/logs
name string Server name
owner string Server owner name
brand string Brand or company name
account_url string Account-related external URL
keepticks int Number of ticks to retain
monthly_state_mode int Monthly reporting mode
statement_mode int Statement reporting mode
statement_weekend int 1 if statements are allowed on weekends
license_status int License status code
license_expire int License expiration timestamp
license_init int License initialization timestamp
license string License string
time_backup string Cron for backup schedule (/2 * * * )
http_port int Port for http connection (this internal port not a PROXY)
tcp_port int Port for tcp connection (this internal port not a PROXY)
fix_port int Port for FIX connection
ws_port int Port for WS connection (this internal port not a PROXY)

Response Example

{
  "server_build": "v2.0.0",
  "typeofdemo": 1,
  "timeofdemo": 2592000,
  "timezone": 3,
  "antiflood": 1,
  "floodcontrol": 100,
  "daylightcorrection": 1,
  "feeder_timeout": 60,
  "rollovers_mode": 2,
  "path_database": "/var/app/db",
  "path_history": "/var/app/history",
  "name": "MyTradingServer",
  "owner": "Broker Inc.",
  "brand": "TradeX",
  "account_url": "https://client.tradex.com",
  "keepticks": 1000,
  "monthly_state_mode": 1,
  "statement_mode": 0,
  "statement_weekend": 1,
  "license_status": 1,
  "license_expire": 1704067200,
  "license_init": 1698883200,
  "license": "TRX-123456-7890",
  "time_backup": "* * * * *" // CRON EVERY MINS
}