# General Definitions

# Interface Result

RET_CODE

  • RET_OK

    Success

  • RET_ERROR

    Failed

# Protocol Format

ProtoFMT

  • Protobuf

    Google Protobuf

  • Json

    Json

# Packet Encryption Algorithm

# Program Status Type

ProgramStatusType

  • NONE

    Unknown

  • LOADED

    The necessary modules have been loaded

  • LOGING

    Logging in

  • NEED_PIC_VERIFY_CODE

    Need graphic verification code

  • NEED_PHONE_VERIFY_CODE

    Need mobile phone verification code

  • LOGIN_FAILED

    Login failed

  • FORCE_UPDATE

    The client version is too low

  • NESSARY_DATA_PREPARING

    Pulling necessary information

  • NESSARY_DATA_MISSING

    Missing necessary information

  • UN_AGREE_DISCLAIMER

    Disclaimer is not agreed

  • READY

    Ready to use

  • FORCE_LOGOUT

    FutuOpenD was forced to log out

# FutuOpenD Event Notification Type

GtwEventType

  • LocalCfgLoadFailed

    Failed to load the local configuration file

  • APISvrRunFailed

    Failed to run the FutuOpenD monitoring service

  • ForceUpdate

    Force upgrade of the FutuOpenD

  • LoginFailed

    Failed to log in to Futu server

  • UnAgreeDisclaimer

    Did not agree to the disclaimer, unable to run

  • LOGIN_FAILED

    Login failed

  • NetCfgMissing

    Missing network connection configuration

  • KickedOut

    Login kicked offline

  • LoginPwdChanged

    Login password has been changed

  • BanLogin

    This account is not allowed to log in by Futu server

  • NeedPicVerifyCode

    Need graphic verification code

  • NeedPhoneVerifyCode

    Need mobile verification code

  • AppDataNotExist

    Program package data loss

  • NessaryDataMissing

    The necessary data is not synchronized successfully

  • TradePwdChanged

    Transaction password change notice

  • EnableDeviceLock

    Need to enable device lock

# System Notification Type

SysNotifyType

  • GTW_EVENT

    Gateway event

  • PROGRAM_STATUS

    Program status changes

  • CONN_STATUS

    Status of Connection to Futu server has been changed

  • QOT_RIGHT

    Quotes authority changed

# Package Unique Identifier

PacketID

message PacketID
{
  required uint64 connID = 1; //The current TCP connection ID, the unique identifier of a connection, returned by the InitConnect protocol
  required uint32 serialNo = 2; //Increment serial number
}
1
2
3
4
5

# Program Status

ProgramStatus

message ProgramStatus
{
  required ProgramStatusType type = 1; //Current status
  optional string strExtDesc = 2; //Additional description
}
1
2
3
4
5