latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

accountManagementAccounts14

accountManagementBanking20

accountManagementReports6

accountManagementUtilities9

authorizationSsoBrowserSessions1

authorizationSsoSessions1

authorizationToken1

preTradeComplianceRestrictions6

thirdPartiesCashBalances1

thirdPartiesTaxVouchers6

tradingAccounts11

tradingAlerts6

tradingContracts16

tradingEventContracts5

tradingFaAllocationManagement18

tradingFyIsAndNotifications11

tradingMarketData4

tradingOAuth10A3

tradingOrders11

tradingPortfolio13

tradingPortfolioAnalyst4

tradingScanner2

tradingSession5

tradingWatchlists4

tradingWebsocket1

utilitiesEcho2

tradingSession

Validate SSO Web API Session

Validates the current session for the SSO user.

get/sso/validate

Response

An array of objects detailing contract information.

USER_IDinteger

Internal user identifier.

USER_NAMEstring

current username logged in for the session.

RESULTboolean

Confirms if validation was successful. True if session was validated; false if not.

AUTH_TIMEinteger

Returns the time of authentication in epoch time.

SF_ENABLEDboolean

(Internal use only)

IS_FREE_TRIALboolean

Returns if the account is a trial account or a funded account.

CREDENTIALstring

Returns the underlying username of the account.

IPstring

Internal use only. Does not reflect the IP address of the user.

EXPIRESinteger

Returns the time until SSO session expiration in milliseconds.

QUALIFIED_FOR_MOBILE_AUTHboolean

Returns if the customer requires two factor authentication.

LANDING_APPstring

Used for Client Portal (Internal use only)

IS_MASTERboolean

Returns whether the account is a master account (true) or subaccount (false).

lastAccessedinteger

Returns the last time the user was accessed in epoch time.

loginTypeinteger

Returns the login type. 1 for Live, 2 for Paper

PAPER_USER_NAMEstring

Returns the paper username for the account.

regionstring

Returns the region connected to internally.