HKbitEX 开发文档

🌙 主题

API Reference ​

1. Info ​

  • Title: gRPC API
  • Version: 1.0.0
  • Description: This documentation is generated from protobuf files using protoc-gen-doc.

2. Paths ​

Notify ​

Time ​

  • Summary: Time
  • Method: Time
  • Endpoint: notify.Notify/Time
  • Request:
    • Content-Type: application/grpc
    • Schema: Empty
  • Response:

AddMessage ​

  • Summary: 添加站内信
  • Method: AddMessage
  • Endpoint: notify.Notify/AddMessage
  • Request:
  • Response:

DeleteMessage ​

  • Summary: 删除站内信
  • Method: DeleteMessage
  • Endpoint: notify.Notify/DeleteMessage
  • Request:
  • Response:
    • Content-Type: application/grpc
    • Schema: Empty

GetMessageList ​

  • Summary: 获取站内信列表
  • Method: GetMessageList
  • Endpoint: notify.Notify/GetMessageList
  • Request:
  • Response:

GetUserMessageList ​

GetUserMessage ​

  • Summary: 获取单个用户信息详情
  • Method: GetUserMessage
  • Endpoint: notify.Notify/GetUserMessage
  • Request:
  • Response:

UpdateUserMessage ​

  • Summary: 更新用户站内信
  • Method: UpdateUserMessage
  • Endpoint: notify.Notify/UpdateUserMessage
  • Request:
  • Response:
    • Content-Type: application/grpc
    • Schema: Empty

DeleteUserMessage ​

  • Summary: 删除用户站内信
  • Method: DeleteUserMessage
  • Endpoint: notify.Notify/DeleteUserMessage
  • Request:
  • Response:
    • Content-Type: application/grpc
    • Schema: Empty

AddUserMessage ​

  • Summary: 增加用户站内信
  • Method: AddUserMessage
  • Endpoint: notify.Notify/AddUserMessage
  • Request:
  • Response:

SendEmail ​

  • Summary: 发送邮件
  • Method: SendEmail
  • Endpoint: notify.Notify/SendEmail
  • Request:
  • Response:

GetSenderList ​

  • Summary: 获取发件人列表
  • Method: GetSenderList
  • Endpoint: notify.Notify/GetSenderList
  • Request:
  • Response:

GetSender ​

  • Summary: 获取发件人信息
  • Method: GetSender
  • Endpoint: notify.Notify/GetSender
  • Request:
  • Response:

GetMessageStatistics ​

3. Components ​

3.1 Schemas ​

AccountMessage ​

FieldTypeDescription
eEventName事件名称:1-订单事件,2-账户信息
eTint64事件发生时间
tint32事件类型
bBalanceMessagenone

AddMessageRequest ​

FieldTypeDescription
senderstring发送人
receiverstring接收者:all所有人
titlestring站内信标题
contentstring站内信内容
senderTypeSenderType消息类型:1-站内信 2-邮件 3-短信
sendEmailstringsend email
operatorstring操作人名称

AddMessageResponse ​

FieldTypeDescription
messageIdint64站内信id

AddUserMessageRequest ​

FieldTypeDescription
userIdstring用户id
messageTypeMessageType站内信id
titlestringtitle
contentstring消息内容
templateTypeMessageTemplateType站内信类型

AddUserMessageResponse ​

FieldTypeDescription
userMessageIdint64站内信id

BalanceMessage ​

FieldTypeDescription
cstring变动量
vstring总量
lstring冻结
fstring可用
astring资产id

DeleteMessageRequest ​

FieldTypeDescription
messageIdsint64站内信id

DeleteUserMessageRequest ​

FieldTypeDescription
userMessageIdsint64站内信id
userIdstring用户id
messageTypeMessageType消息类型:1-系统消息,2-成交消息,3-后台消息

EmailAttachment ​

FieldTypeDescription
attachmentBase64stringnone
fileNamestringnone

GetMessageListRequest ​

FieldTypeDescription
offsetint32none
limitint32链id
searchValuestring搜索关键字
senderTypeSenderType消息类型:1-站内信 2-邮件 3-短信

GetMessageListResponse ​

FieldTypeDescription
listGetMessageListResponse.Messagenone
offsetint32总页数
limitint32当前页
totalint64none

Message ​

FieldTypeDescription
messageIdint64站内信id
senderstring发送者
receiverstring接收者
titlestring站内信标题
contentstring站内信内容
createTimeint64站内信创建时间
senderTypeSenderType消息类型:1-站内信 2-邮件 3-短信
sendEmailstring发送者邮箱地址
operatorstring操作人名称

GetMessageStatisticsRequest ​

FieldTypeDescription
userIdstring用户id
limitint32需要查询的消息条数:默认为1条

GetMessageStatisticsResponse ​

FieldTypeDescription
userIdstring用户id
statisticsGetMessageStatisticsResponse.Statistics站内信统计信息
totalint64总消息数

Statistics ​

统计信息

FieldTypeDescription
unreadint64未读消息数量
readint64已读消息数量
totalint64总消息数量
messageTypeMessageType消息类型:1-系统消息,2-成交消息,3-后台消息
messageListGetUserMessageResponse消息列表

GetSenderListRequest ​

FieldTypeDescription
senderTypeSenderType消息类型:1-站内信 2-邮件 3-短信
messageTypeMessageType消息类型:1-系统消息,2-成交消息,3-后台消息

GetSenderListResponse ​

FieldTypeDescription
listGetSenderResponsenone

GetSenderRequest ​

FieldTypeDescription
senderTypeSenderType消息类型:1-站内信 2-邮件 3-短信
messageTypeMessageType消息类型:1-系统消息,2-成交消息,3-后台消息

GetSenderResponse ​

FieldTypeDescription
namestring发送者
senderTypeSenderType消息类型:1-站内信 2-邮件 3-短信
fromstring发送者来源
messageTypeMessageType消息类型:1-系统消息,2-成交消息,3-后台消息

GetUserMessageListRequest ​

FieldTypeDescription
userIdstring用户id
isReadMessageStatus站内信状态:1-未读,2-已读
messageTypeMessageType站内信类型：1-系统消息,2-成交消息,3-后台消息
offsetint32none
limitint32none

GetUserMessageListResponse ​

FieldTypeDescription
listGetUserMessageResponsenone
offsetint32总页数
limitint32当前页
totalint64none

GetUserMessageRequest ​

FieldTypeDescription
userMessageIdint64站内信id
userIdstring用户id

GetUserMessageResponse ​

FieldTypeDescription
userMessageIdint64站内信id
userIdstring用户id
titlestring消息头
contentstring消息内容
messageTypeMessageType站内信类型:1-系统消息,2-成交消息,3-后台消息
isReadMessageStatus站内信状态:1-未读,2-已读
createTimeint64站内信创建时间
templateTypeMessageTemplateType站内信类型:1-注册完成,2-登陆IP改变,3-修改密码成功,4-解绑GA成功,5-修改GA成功,6-KYC身份证审核通过,7-KYC身份证被拒,8-KYC居住地认证通过,9-KYC居住地认证被拒,10-充值到账,11-充值被隔离,12-充值地址更新,13-提现成功,14-提现审核被拒,15-补充保证金警报,16-强行平仓,17-对手盘减仓

NotifyMessage ​

FieldTypeDescription
eEventName事件名称:1-订单事件,2-站内信事件
eTint64事件发生时间
hstring消息头部
cstring消息内容

OrderMessage ​

FieldTypeDescription
eEventName事件名称:1-订单事件,2-站内信事件
eTint64事件发生时间
tint32事件类型:1-挂单成功,2-成交,3-撤单成功,4-强平,5-自成交,6-挂单成交,7-吃单成交
ostring订单id
sstring交易对
pstring价格
vstring成交量
oSstring买卖方向

PlatformEvent ​

FieldTypeDescription
PlatformEventTypePlatformEventTypenone
AccountIdstringnone
Emailstringnone
DataPlatformEvent.DataEntrynone
emailAttachmentEmailAttachment附件：文件的base编码，若发送携带附件的文件，建议使用grpc调用

DataEntry ​

FieldTypeDescription
keystringnone
valuestringnone

Receiver ​

FieldTypeDescription
receiver_type.emailstringnone
receiver_type.userIdstringnone

SendEmailRequest ​

FieldTypeDescription
subjectstringtitle
templatePlatformEventType邮件模版编号
receiverReceivernone
senderstring邮件发送者:可为空
msgSendEmailRequest.MsgEntry邮件内容
emailAttachmentEmailAttachment附件：文件的base编码，若发送携带附件的文件，建议使用grpc调用
messageTypeMessageType消息类型:1-系统消息,2-成交消息,3-后台消息,默认为1
requestIdstringnone

MsgEntry ​

FieldTypeDescription
keystringnone
valuestringnone

SendEmailResponse ​

FieldTypeDescription
requestIdstringnone

TimeResponse ​

FieldTypeDescription
serverTimeint64当前服务器时间

UpdateUserMessageRequest ​

FieldTypeDescription
userMessageIdsint64站内信id
isReadMessageStatus站内信状态:1-未读,2-已读
userIdstring用户id
messageTypeMessageType消息类型:1-系统消息,2-成交消息,3-后台消息

3.2 Enums ​

EventName ​

NameNumberDescription
NONE0none
ORDER1订单事件
ACCOUNT2账户更新
KEY_EXPIRED3Key过期

MessageStatus ​

NameNumberDescription
STATUSNONE0none
UNREAD1未读
READ2已读

MessageTemplateType ​

NameNumberDescription
TYPENONE0none
REGISTER1注册完成
LOGINIP2登陆IP改变
CHANGEPASSWORD3修改密码成功
UNBINDGA4解绑GA成功
CHANGEGA5修改GA成功
KYC_IDCARD_PASS6KYC身份证审核通过
KYC_IDCARD7KYC身份证被拒
KYC_RESIDENCE_PASS8KYC居住地认证通过
KYC_RESIDENCE9KYC居住地认证被拒
DEPOSIT10充值到账
DEPOSIT_ISOLATED11充值被隔离
DEPOSIT_ADDRESS12充值地址更新
WITHDRAW13提现成功
WITHDRAW_AUDIT14提现审核被拒
ADDITIONAL_MARGIN15补充保证金警报
FORCED_LIQUIDATION16强行平仓
REDUCE_POSITION17对手盘减仓
ADMIN_MESSAGE18后台消息
KYC_PASS19KYC审核通过

MessageType ​

NameNumberDescription
MESSAGENONE0none
SYSTEM1系统消息
TRADE2交易信息
ADMIN3后台发送消息

PlatformEventType ​

NameNumberDescription
PlatformEventTypeUnknown0not used, just for 0 check in proto3
PlatformEventTypeRegistrationCompleted1注册成功。--
PlatformEventTypeLoginIPChanged2登录IP变更。email, ip, time --
PlatformEventTypeResetPasswordCompleted3密码重置成功。--
PlatformEventTypeGADisabled4解绑GA成功。--
PlatformEventTypeGAUpdated5修改GA成功。--
PlatformEventTypeKYCPassed6KYC审核通过。--
PlatformEventTypeKYCIdentityRejected7KYC身份审核拒绝。reason --
PlatformEventTypeResidentCertificationPassed8居住地认证通过。 --
PlatformEventTypeResidentCertificationRejected9居住地认证拒绝。reason --
PlatformEventTypeDepositCompleted10充值成功。amount, asset, txId
PlatformEventTypeDepositIsolated11充值被隔离。amount, asset, address
PlatformEventTypeDepositAddressUpdated12充值地址更新。
PlatformEventTypeWithdrawCompleted13提现成功。 amount, asset, address,txId
PlatformEventTypeWithdrawRejected14提现被拒绝。amount, asset, address, reason
PlatformEventTypeMarginCalled15补充保证金警报。marginRatio, marginRatioThreshold, symbol, positionSide, isolationType
PlatformEventTypeLiquidated16强平。symbol, positionSide, isolationType, markPrice, markPriceAsset
PlatformEventTypePositionReducted17对手盘强行减仓。symbol, positionSide, isolationType, markPrice, markPriceAsset, amount, realizedPnl
PlatformEventTypeTwoFARegistrationRequested18注册验证码，code, ip, validMinutes --
PlatformEventTypeTwoFALoginRequested19登录验证码，code, validMinutes --
PlatformEventTypeTwoFAResetPasswordRequested20重置密码验证码，code, validMinutes --
PlatformEventTypeTwoFABindGARequested21绑定GA验证码，code, validMinutes --
PlatformEventTypeTwoFAWithdrawRequested22提现验证码，code, validMinutes, amount, asset, address
PlatformEventTypeAdminMessage23后台邮件
PlatformEventTypeKYCIdentityPassed24KYC身份审核通过 --
SpotEventTypeRegistrationCode25Spot

注册验证码,code, ip, validMinutes | | SpotEventTypeRegistrationCompleted | 26 | 注册完成 | | SpotEventTypeLoginCode | 27 | 登录验证码,code, validMinutes | | SpotEventTypeResetPasswordCode | 28 | 重设密码验证码，code, validMinutes | | SpotEventTypeResetPasswordSuccess | 29 | 重设密码成功 | | SpotEventTypeBindGACode | 30 | 绑定GA验证码，code, validMinutes | | SpotEventTypeUnbindGACodeSuccess | 31 | 解绑GA成功 | | SpotEventTypeUpdateGASuccess | 32 | 修改GA成功 | | SpotEventTypeKYCIdentityPassed | 33 | KYC身份认证通过 | | SpotEventTypeKYCIdentityReturned | 34 | KYC身份认证退回,reason | | SpotEventTypeKYCIdentityPermanentlyRejected | 35 | KYC身份认证永久被拒绝,reason | | SpotEventTypeKYCComplete | 36 | KYC认证完成 | | SpotEventTypeDigitalCurrencyDepositReceived | 37 | 充值数字币到账,amount, asset,txId | | SpotEventTypeFiatCurrencyDepositReceived | 38 | 充值法币到账,amount, asset,orderId | | SpotEventTypeDepositAddressNotVerified | 39 | 充值地址未认证,amount, asset,address,blockchain | | SpotEventTypeDepositAmountMismatch | 40 | 充值金额不符,amount, asset | | SpotEventTypeDepositRejected | 41 | 充值被拒绝,amount, asset,address,txId | | SpotEventTypeDepositAddressUpdatePending | 42 | 充值地址即将更新,assets | | SpotEventTypeDepositAddressUpdated | 43 | 充值地址更新,assets | | SpotEventTypeFiatCurrencyWithdrawCode | 44 | 提现数字币验证码,amount, asset,address,code,validMinutes | | SpotEventTypeDigitalCurrencyWithdrawSuccess | 45 | 提现数字币成功,amount, asset,address,txId,time | | SpotEventTypeFiatCurrencyWithdrawSuccess | 46 | 提现法币成功,amount, currency,fee,txId,orderTime | | SpotEventTypeWithdrawRejected | 47 | 提现被拒绝,amount, asset,reason | | SpotEventTypeTradeSettlementStatistics | 48 | 交易成交统计 | | SpotEventTypeSelfTradeCancellationNotice | 49 | 交易自成交取消提示 | | SpotEventTypePositionLimitReminder | 50 | 持仓上限提醒 | | SpotEventTypeAddDepositWhiteList | 51 | 添加充值白名单,address,code,validMinutes | | SpotEventTypeRemoveDepositWhiteList | 52 | 删除充值白名单,address,code,validMinutes | | SpotEventTypeAddWithdrawWhiteList | 53 | 添加提现白名单,address,code,validMinutes | | SpotEventTypeRemoveWithdrawWhiteList | 54 | 删除提现白名单,address,code,validMinutes | | SpotEventTypeLoginNotification | 55 | 以下为新增内容

登录通知,userAgent,ip,ipCountry(HongKong),loginTime(2024-05-23 12:11:53(UTC)) | | SpotEventTypeLoginPasswordExpire | 56 | 登录密码过期,儅用戶密碼創建時間6個月時發送，告知用戶必須更改密碼，未修改密碼的用戶會被限制登陸。 | | SpotEventTypeDigitalCurrencyWithdrawCode | 57 | 提现法币验证码,amount, asset,bankName,bankNo,code,validMinutes | | SpotEventTypeAddDepositWhiteListSuccess | 58 | 添加充值地址白名单成功, address,time(2024-05-16 08:11:11) | | SpotEventTypeAddWithdrawWhiteListSuccess | 59 | 新增提现白名单地址成功, address,time(2024-05-16 08:11:11) | | SpotEventTypeAddBankAccountWhiteListSuccess | 60 | 添加银行账户白名单成功, bankName,bankNo,time(2024-05-16 08:11:11) | | SpotEventTypeRemoveBankAccountWhiteList | 61 | 删除银行账户白名单, //code,validMinutes,bankName,bankNo | | SpotEventTypeKYCUpdateRequired | 62 | KYC需要更新, 用戶KYC認證還有30天過期，或者管理員在後臺點擊需要更新時發送 | | SpotEventTypeKYCExpired | 63 | KYC失效, 用戶KYC認證過期時發送 | | SpotEventTypeHotWalletThresholdWarning | 64 | amount,asset,rate(2.35),valuation(1.5) | | SpotEventTypeDailyStatement | 65 | 日结

userId,date | | SpotEventTypeMonthlyStatement | 66 | 月结

userId,date | | SpotEventTypePasswordWillExpire | 67 | 密码即将过期

onlyDay | | SpotEventTypeOTCTradeNotification | 68 | OTC成交通知 | | SpotEventTypeOTCSettlementCompletedNotification | 69 | OTC結算完成通知 | | SpotEventTypeOTCSettlementCancelledNotification | 70 | OTC結算撤銷通知 | | SpotEventTypeUserTermsandConditions | 71 | KYC签名授权模版 | | SpotEventTypeIPMonitoring | 72 | IP Monitoring | | SpotEventTypeWalletAddressCountWarning | 73 | 地址数量不足报警

asset,walletTypes,count eg:assets=BTC/ETH walletTypes=hot/cold count=10 | | SpotEventTypeAddressScanningWarning | 74 | 白名单地址扫描警报

date/December 2, 2024,walletTypes,num,total | | SpotEventTypeWhiteListExpired | 75 | 白名单失效通知

type,blockchain,address eg:type=deposit/withdrawal,blockchain=ETH,address=0x1234567890123456789 | | SpotEventTypeBankAccountNotification | 76 | 银行账户通知模版

userId,username,no | | SpotEventTypeFiatSwapSubmitted | 77 | 法币换汇申请

fromAmount,fromAsset,toAmount,toAsset | | SpotEventTypeFiatSwapCompleted | 78 | 法币换汇审核通过

fromAmount,fromAsset,toAmount,toAsset,rate | | SpotEventTypeFiatSwapRejected | 79 | 法币换汇审核拒绝

fromAmount,fromAsset,toAmount,toAsset,remark | | SpotEventTypeRetailUpgradeToPI | 80 | 零售升级为PI | | SpotEventTypePIDowngradeToRetail | 81 | PI降级为零售 | | SpotEventTypeIDExpirationReminder | 82 | 身份证件到期提醒

users | | SpotEventTypeDigitalCurrencyDepositReminder | 83 | 数字币充值提醒

amount,asset | | SpotEventTypeDigitalCurrencyWithdrawReminder | 84 | 数字币提现提醒

amount,asset | | SpotEventTypeFiatCurrencyDepositReminder | 85 | 法币充值提醒

amount,asset | | SpotEventTypeFiatCurrencyWithdrawReminder | 86 | 法币提现提醒

amount,asset | | SpotEventTypeAddAddressWhiteListReminder | 87 | 添加地址白名单提醒

userId | | SpotEventTypeKYCSubmissionReminder | 88 | KYC信息提交提醒

userId |

SenderType ​

NameNumberDescription
SENDNONE0none
NOTIFY1站内信
EMAIL2邮件
SMS3短信

4. Scalar Value Types ​

Proto TypeGo TypeC++ TypeJava TypePython TypeNotes
doublefloat64doubledoublefloat
floatfloat32floatfloatfloat
int32int32int32intintUses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.
int64int64int64longint/longUses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.
uint32uint32uint32intint/longUses variable-length encoding.
uint64uint64uint64longint/longUses variable-length encoding.
sint32int32int32intintUses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.
sint64int64int64longint/longUses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.
fixed32uint32uint32intintAlways four bytes. More efficient than uint32 if values are often greater than 2^28.
fixed64uint64uint64longint/longAlways eight bytes. More efficient than uint64 if values are often greater than 2^56.
sfixed32int32int32intintAlways four bytes.
sfixed64int64int64longint/longAlways eight bytes.
boolboolboolbooleanboolean
stringstringstringStringstr/unicodeA string must always contain UTF-8 encoded or 7-bit ASCII text.
bytes[]bytestringByteStringstrMay contain any arbitrary sequence of bytes.

🚀 构建现代化数字资产交易平台

Copyright © 2025 HKbitEX Development Team