Class FTSession

constructor

• new FTSession(options?: FTSessionOptions): FTSession

  Initializes a new instance of the FTSession class.

  Parameters

  • options: FTSessionOptions = {}

    FTSession configuration options.

  Returns FTSession

cookieJar

debug

Optionalemail

loginJson

OptionalmfaSecret

OptionalotpOptions

Optionalpassword

Optionalphone

Optionalpin

OptionalprofilePath

saveSession

session

OptionaltToken

username

buildSessionFromTokens

• buildSessionFromTokens(tokens: Record<string, any>): Promise<void>

  Builds the session headers and cookies from provided tokens.

  Parameters

  • tokens: Record<string, any>

  Returns Promise<void>

deleteCookies

• deleteCookies(): void

  Deletes the session cookies.

  Returns void

getTokens

• getTokens(): Promise<Record<string, any>>

  Returns the current session tokens (access_token, ftat, sid and cookies).

  Returns Promise<Record<string, any>>

login

• login(): Promise<boolean>

  Validate and log into the Firstrade platform.

  Returns Promise<boolean>

  True if further MFA action is required, otherwise false.

  Throws

  If the login request fails.

  Throws

  If the API returns an error.

loginTwo

• loginTwo(code: string): Promise<void>

  Finish the login process to the Firstrade platform when using email or phone MFA.

  Parameters

  • code: string

    The MFA code provided by the user.

  Returns Promise<void>

request

• request(
      method: string,
      url: string,
      config?: AxiosRequestConfig<any>,
  ): Promise<AxiosResponse<any, any, {}>>

  HTTP requests wrapper to the API.

  Parameters

  • method: string
  • url: string
  • Optionalconfig: AxiosRequestConfig<any>

  Returns Promise<AxiosResponse<any, any, {}>>

StaticmaskEmail

• maskEmail(email: string): string

  Masks the email for use in the API.

  Parameters

  • email: string

    The email address to be masked.

  Returns string

  The masked email address.