├── .gitignore ├── .travis.yml ├── README.md ├── _example ├── README.md ├── config.go ├── futures.go ├── main.go ├── margin.go └── spot.go ├── api_account.go ├── api_collateral_loan.go ├── api_delivery.go ├── api_earn.go ├── api_earn_uni.go ├── api_flash_swap.go ├── api_futures.go ├── api_margin.go ├── api_margin_uni.go ├── api_multi_collateral_loan.go ├── api_options.go ├── api_rebate.go ├── api_spot.go ├── api_sub_account.go ├── api_unified.go ├── api_wallet.go ├── api_withdrawal.go ├── client.go ├── configuration.go ├── docs ├── AccountApi.md ├── AccountBalance.md ├── AccountDetail.md ├── AccountDetailKey.md ├── AccountRateLimit.md ├── AgencyCommission.md ├── AgencyCommissionHistory.md ├── AgencyTransaction.md ├── AgencyTransactionHistory.md ├── AutoRepaySetting.md ├── BatchAmendItem.md ├── BatchAmendOrderReq.md ├── BatchFuturesOrder.md ├── BatchOrder.md ├── BorrowCurrencyInfo.md ├── BrokerCommission.md ├── BrokerCommission1.md ├── BrokerTransaction.md ├── BrokerTransaction1.md ├── CancelBatchOrder.md ├── CancelOrderResult.md ├── CollateralAdjust.md ├── CollateralAdjustRes.md ├── CollateralAlign.md ├── CollateralCurrency.md ├── CollateralCurrencyInfo.md ├── CollateralCurrencyRes.md ├── CollateralCurrentRate.md ├── CollateralFixRate.md ├── CollateralLoanApi.md ├── CollateralLoanCurrency.md ├── CollateralLtv.md ├── CollateralOrder.md ├── CollateralRecord.md ├── Contract.md ├── ContractStat.md ├── ConvertSmallBalance.md ├── CountdownCancelAllFuturesTask.md ├── CountdownCancelAllOptionsTask.md ├── CountdownCancelAllSpotTask.md ├── CreateCollateralOrder.md ├── CreateMultiCollateralOrder.md ├── CreateUniLend.md ├── CreateUniLoan.md ├── CrossMarginAccount.md ├── CrossMarginAccountBook.md ├── CrossMarginBalance.md ├── CrossMarginBalance1.md ├── CrossMarginCurrency.md ├── CrossMarginLoan.md ├── CrossMarginRepayRequest.md ├── CrossMarginRepayment.md ├── CrossMarginTransferable.md ├── Currency.md ├── CurrencyChain.md ├── CurrencyPair.md ├── CurrencyQuota.md ├── DebitFee.md ├── DeliveryApi.md ├── DeliveryCandlestick.md ├── DeliveryContract.md ├── DeliverySettlement.md ├── DeliveryTicker.md ├── DepositAddress.md ├── DepositRecord.md ├── DualGetOrders.md ├── DualGetPlans.md ├── EarnApi.md ├── EarnUniApi.md ├── Eth2RateList.md ├── Eth2Swap.md ├── FlashSwapApi.md ├── FlashSwapCurrencyPair.md ├── FlashSwapOrder.md ├── FlashSwapOrderPreview.md ├── FlashSwapOrderRequest.md ├── FlashSwapPreviewRequest.md ├── FundingAccount.md ├── FundingRateRecord.md ├── FutureCancelOrderResult.md ├── FuturesAccount.md ├── FuturesAccountBook.md ├── FuturesAccountHistory.md ├── FuturesApi.md ├── FuturesAutoDeleverage.md ├── FuturesBatchAmendOrderRequest.md ├── FuturesCandlestick.md ├── FuturesFee.md ├── FuturesIndexConstituents.md ├── FuturesInitialOrder.md ├── FuturesLimitRiskTiers.md ├── FuturesLiqOrder.md ├── FuturesLiquidate.md ├── FuturesOrder.md ├── FuturesOrderAmendment.md ├── FuturesOrderBook.md ├── FuturesOrderBookItem.md ├── FuturesPremiumIndex.md ├── FuturesPriceTrigger.md ├── FuturesPriceTriggeredOrder.md ├── FuturesTicker.md ├── FuturesTrade.md ├── IndexConstituent.md ├── InlineObject.md ├── InlineResponse200.md ├── InlineResponse2001.md ├── InsuranceRecord.md ├── LedgerRecord.md ├── LiquidateOrder.md ├── MarginAccount.md ├── MarginAccountBook.md ├── MarginAccountCurrency.md ├── MarginApi.md ├── MarginLeverageTier.md ├── MarginMarketLeverage.md ├── MarginTiers.md ├── MarginTransferable.md ├── MarginUniApi.md ├── MaxUniBorrowable.md ├── MockFuturesOrder.md ├── MockFuturesPosition.md ├── MockMarginResult.md ├── MockOptionsOrder.md ├── MockOptionsPosition.md ├── MockRiskUnit.md ├── MockSpotBalance.md ├── MockSpotOrder.md ├── MultiChainAddressItem.md ├── MultiCollateralCurrency.md ├── MultiCollateralItem.md ├── MultiCollateralLoanApi.md ├── MultiCollateralOrder.md ├── MultiCollateralRecord.md ├── MultiCollateralRecordCurrency.md ├── MultiLoanItem.md ├── MultiLoanRepayItem.md ├── MultiRepayRecord.md ├── MultiRepayResp.md ├── MyFuturesTrade.md ├── MyFuturesTradeTimeRange.md ├── OpenOrders.md ├── OptionsAccount.md ├── OptionsAccountBook.md ├── OptionsApi.md ├── OptionsCandlestick.md ├── OptionsContract.md ├── OptionsMmp.md ├── OptionsMmpReset.md ├── OptionsMySettlements.md ├── OptionsMyTrade.md ├── OptionsOrder.md ├── OptionsPosition.md ├── OptionsPositionClose.md ├── OptionsPositionCloseOrder.md ├── OptionsSettlement.md ├── OptionsTicker.md ├── OptionsUnderlying.md ├── OptionsUnderlyingTicker.md ├── Order.md ├── OrderBook.md ├── OrderCancel.md ├── OrderPatch.md ├── OrderResp.md ├── PartnerCommissionHistory.md ├── PartnerSub.md ├── PartnerSubList.md ├── PartnerTransactionHistory.md ├── PatchUniLend.md ├── PlaceDualInvestmentOrder.md ├── Position.md ├── PositionClose.md ├── PositionCloseOrder.md ├── ProfitLossRange.md ├── RebateApi.md ├── RebateUserInfo.md ├── RepayCurrencyRes.md ├── RepayLoan.md ├── RepayMultiLoan.md ├── RepayRecord.md ├── RepayRecordCurrency.md ├── RepayRecordLeftInterest.md ├── RepayRecordRepaidCurrency.md ├── RepayRecordTotalInterest.md ├── RepayResp.md ├── RiskUnits.md ├── SavedAddress.md ├── SmallBalance.md ├── SmallBalanceHistory.md ├── SpotAccount.md ├── SpotAccountBook.md ├── SpotApi.md ├── SpotCurrencyChain.md ├── SpotFee.md ├── SpotInsuranceHistory.md ├── SpotPricePutOrder.md ├── SpotPriceTrigger.md ├── SpotPriceTriggeredOrder.md ├── StpGroup.md ├── StpGroupUser.md ├── StructuredBuy.md ├── StructuredGetProjectList.md ├── StructuredOrderList.md ├── SubAccount.md ├── SubAccountApi.md ├── SubAccountBalance.md ├── SubAccountCrossMarginBalance.md ├── SubAccountFuturesBalance.md ├── SubAccountKey.md ├── SubAccountKeyPerms.md ├── SubAccountMarginBalance.md ├── SubAccountToSubAccount.md ├── SubAccountTransfer.md ├── SubCrossMarginAccount.md ├── SubUserMode.md ├── SystemTime.md ├── Ticker.md ├── TotalBalance.md ├── Trade.md ├── TradeFee.md ├── TransactionId.md ├── Transfer.md ├── TransferOrderStatus.md ├── TransferablesResult.md ├── TriggerOrderResponse.md ├── TriggerTime.md ├── UidPushOrder.md ├── UidPushWithdrawal.md ├── UidPushWithdrawalResp.md ├── UniCurrency.md ├── UniCurrencyInterest.md ├── UniCurrencyPair.md ├── UniInterestMode.md ├── UniInterestRecord.md ├── UniLend.md ├── UniLendInterest.md ├── UniLendRecord.md ├── UniLoan.md ├── UniLoanInterestRecord.md ├── UniLoanRecord.md ├── UnifiedAccount.md ├── UnifiedApi.md ├── UnifiedBalance.md ├── UnifiedBorrowable.md ├── UnifiedBorrowable1.md ├── UnifiedCurrency.md ├── UnifiedDiscount.md ├── UnifiedDiscountTiers.md ├── UnifiedHistoryLoanRate.md ├── UnifiedHistoryLoanRateRates.md ├── UnifiedLeverageConfig.md ├── UnifiedLeverageSetting.md ├── UnifiedLoan.md ├── UnifiedLoanRecord.md ├── UnifiedLoanResult.md ├── UnifiedMarginTiers.md ├── UnifiedModeSet.md ├── UnifiedPortfolioInput.md ├── UnifiedPortfolioOutput.md ├── UnifiedRiskUnits.md ├── UnifiedSettings.md ├── UnifiedTransferable.md ├── UserLtvInfo.md ├── UserSub.md ├── UserSubRelation.md ├── UserTotalAmount.md ├── WalletApi.md ├── WithdrawStatus.md ├── WithdrawalApi.md └── WithdrawalRecord.md ├── git_push.sh ├── go.mod ├── go.sum ├── model_account_balance.go ├── model_account_detail.go ├── model_account_detail_key.go ├── model_account_rate_limit.go ├── model_agency_commission.go ├── model_agency_commission_history.go ├── model_agency_transaction.go ├── model_agency_transaction_history.go ├── model_auto_repay_setting.go ├── model_batch_amend_item.go ├── model_batch_amend_order_req.go ├── model_batch_futures_order.go ├── model_batch_order.go ├── model_borrow_currency_info.go ├── model_broker_commission.go ├── model_broker_commission_1.go ├── model_broker_transaction.go ├── model_broker_transaction_1.go ├── model_cancel_batch_order.go ├── model_cancel_order_result.go ├── model_collateral_adjust.go ├── model_collateral_adjust_res.go ├── model_collateral_align.go ├── model_collateral_currency.go ├── model_collateral_currency_info.go ├── model_collateral_currency_res.go ├── model_collateral_current_rate.go ├── model_collateral_fix_rate.go ├── model_collateral_loan_currency.go ├── model_collateral_ltv.go ├── model_collateral_order.go ├── model_collateral_record.go ├── model_contract.go ├── model_contract_stat.go ├── model_convert_small_balance.go ├── model_countdown_cancel_all_futures_task.go ├── model_countdown_cancel_all_options_task.go ├── model_countdown_cancel_all_spot_task.go ├── model_create_collateral_order.go ├── model_create_multi_collateral_order.go ├── model_create_uni_lend.go ├── model_create_uni_loan.go ├── model_cross_margin_account.go ├── model_cross_margin_account_book.go ├── model_cross_margin_balance.go ├── model_cross_margin_balance_1.go ├── model_cross_margin_currency.go ├── model_cross_margin_loan.go ├── model_cross_margin_repay_request.go ├── model_cross_margin_repayment.go ├── model_cross_margin_transferable.go ├── model_currency.go ├── model_currency_chain.go ├── model_currency_pair.go ├── model_currency_quota.go ├── model_debit_fee.go ├── model_delivery_candlestick.go ├── model_delivery_contract.go ├── model_delivery_settlement.go ├── model_delivery_ticker.go ├── model_deposit_address.go ├── model_deposit_record.go ├── model_dual_get_orders.go ├── model_dual_get_plans.go ├── model_eth2_rate_list.go ├── model_eth2_swap.go ├── model_flash_swap_currency_pair.go ├── model_flash_swap_order.go ├── model_flash_swap_order_preview.go ├── model_flash_swap_order_request.go ├── model_flash_swap_preview_request.go ├── model_funding_account.go ├── model_funding_rate_record.go ├── model_future_cancel_order_result.go ├── model_futures_account.go ├── model_futures_account_book.go ├── model_futures_account_history.go ├── model_futures_auto_deleverage.go ├── model_futures_batch_amend_order_request.go ├── model_futures_candlestick.go ├── model_futures_fee.go ├── model_futures_index_constituents.go ├── model_futures_initial_order.go ├── model_futures_limit_risk_tiers.go ├── model_futures_liq_order.go ├── model_futures_liquidate.go ├── model_futures_order.go ├── model_futures_order_amendment.go ├── model_futures_order_book.go ├── model_futures_order_book_item.go ├── model_futures_premium_index.go ├── model_futures_price_trigger.go ├── model_futures_price_triggered_order.go ├── model_futures_ticker.go ├── model_futures_trade.go ├── model_index_constituent.go ├── model_inline_object.go ├── model_inline_response_200.go ├── model_inline_response_200_1.go ├── model_insurance_record.go ├── model_ledger_record.go ├── model_liquidate_order.go ├── model_margin_account.go ├── model_margin_account_book.go ├── model_margin_account_currency.go ├── model_margin_leverage_tier.go ├── model_margin_market_leverage.go ├── model_margin_tiers.go ├── model_margin_transferable.go ├── model_max_uni_borrowable.go ├── model_mock_futures_order.go ├── model_mock_futures_position.go ├── model_mock_margin_result.go ├── model_mock_options_order.go ├── model_mock_options_position.go ├── model_mock_risk_unit.go ├── model_mock_spot_balance.go ├── model_mock_spot_order.go ├── model_multi_chain_address_item.go ├── model_multi_collateral_currency.go ├── model_multi_collateral_item.go ├── model_multi_collateral_order.go ├── model_multi_collateral_record.go ├── model_multi_collateral_record_currency.go ├── model_multi_loan_item.go ├── model_multi_loan_repay_item.go ├── model_multi_repay_record.go ├── model_multi_repay_resp.go ├── model_my_futures_trade.go ├── model_my_futures_trade_time_range.go ├── model_open_orders.go ├── model_options_account.go ├── model_options_account_book.go ├── model_options_candlestick.go ├── model_options_contract.go ├── model_options_mmp.go ├── model_options_mmp_reset.go ├── model_options_my_settlements.go ├── model_options_my_trade.go ├── model_options_order.go ├── model_options_position.go ├── model_options_position_close.go ├── model_options_position_close_order.go ├── model_options_settlement.go ├── model_options_ticker.go ├── model_options_underlying.go ├── model_options_underlying_ticker.go ├── model_order.go ├── model_order_book.go ├── model_order_cancel.go ├── model_order_patch.go ├── model_order_resp.go ├── model_partner_commission_history.go ├── model_partner_sub.go ├── model_partner_sub_list.go ├── model_partner_transaction_history.go ├── model_patch_uni_lend.go ├── model_place_dual_investment_order.go ├── model_position.go ├── model_position_close.go ├── model_position_close_order.go ├── model_profit_loss_range.go ├── model_rebate_user_info.go ├── model_repay_currency_res.go ├── model_repay_loan.go ├── model_repay_multi_loan.go ├── model_repay_record.go ├── model_repay_record_currency.go ├── model_repay_record_left_interest.go ├── model_repay_record_repaid_currency.go ├── model_repay_record_total_interest.go ├── model_repay_resp.go ├── model_risk_units.go ├── model_saved_address.go ├── model_small_balance.go ├── model_small_balance_history.go ├── model_spot_account.go ├── model_spot_account_book.go ├── model_spot_currency_chain.go ├── model_spot_fee.go ├── model_spot_insurance_history.go ├── model_spot_price_put_order.go ├── model_spot_price_trigger.go ├── model_spot_price_triggered_order.go ├── model_stp_group.go ├── model_stp_group_user.go ├── model_structured_buy.go ├── model_structured_get_project_list.go ├── model_structured_order_list.go ├── model_sub_account.go ├── model_sub_account_balance.go ├── model_sub_account_cross_margin_balance.go ├── model_sub_account_futures_balance.go ├── model_sub_account_key.go ├── model_sub_account_key_perms.go ├── model_sub_account_margin_balance.go ├── model_sub_account_to_sub_account.go ├── model_sub_account_transfer.go ├── model_sub_cross_margin_account.go ├── model_sub_user_mode.go ├── model_system_time.go ├── model_ticker.go ├── model_total_balance.go ├── model_trade.go ├── model_trade_fee.go ├── model_transaction_id.go ├── model_transfer.go ├── model_transfer_order_status.go ├── model_transferables_result.go ├── model_trigger_order_response.go ├── model_trigger_time.go ├── model_uid_push_order.go ├── model_uid_push_withdrawal.go ├── model_uid_push_withdrawal_resp.go ├── model_uni_currency.go ├── model_uni_currency_interest.go ├── model_uni_currency_pair.go ├── model_uni_interest_mode.go ├── model_uni_interest_record.go ├── model_uni_lend.go ├── model_uni_lend_interest.go ├── model_uni_lend_record.go ├── model_uni_loan.go ├── model_uni_loan_interest_record.go ├── model_uni_loan_record.go ├── model_unified_account.go ├── model_unified_balance.go ├── model_unified_borrowable.go ├── model_unified_borrowable_1.go ├── model_unified_currency.go ├── model_unified_discount.go ├── model_unified_discount_tiers.go ├── model_unified_history_loan_rate.go ├── model_unified_history_loan_rate_rates.go ├── model_unified_leverage_config.go ├── model_unified_leverage_setting.go ├── model_unified_loan.go ├── model_unified_loan_record.go ├── model_unified_loan_result.go ├── model_unified_margin_tiers.go ├── model_unified_mode_set.go ├── model_unified_portfolio_input.go ├── model_unified_portfolio_output.go ├── model_unified_risk_units.go ├── model_unified_settings.go ├── model_unified_transferable.go ├── model_user_ltv_info.go ├── model_user_sub.go ├── model_user_sub_relation.go ├── model_user_total_amount.go ├── model_withdraw_status.go ├── model_withdrawal_record.go └── response.go /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 2 | *.o 3 | *.a 4 | *.so 5 | 6 | # Folders 7 | _obj 8 | _test 9 | 10 | # Architecture specific extensions/prefixes 11 | *.[568vq] 12 | [568vq].out 13 | 14 | *.cgo1.go 15 | *.cgo2.c 16 | _cgo_defun.c 17 | _cgo_gotypes.go 18 | _cgo_export.* 19 | 20 | _testmain.go 21 | 22 | *.exe 23 | *.test 24 | *.prof 25 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | 3 | install: 4 | - go get -d -v . 5 | 6 | script: 7 | - go build -v ./ 8 | 9 | -------------------------------------------------------------------------------- /docs/AccountBalance.md: -------------------------------------------------------------------------------- 1 | # AccountBalance 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Amount** | **string** | Account total balance amount | [optional] 8 | **Currency** | **string** | Currency | [optional] 9 | **UnrealisedPnl** | **string** | Unrealised_pnl, this field will only appear in futures, options, delivery, and total accounts | [optional] 10 | **Borrowed** | **string** | Borrowed,this field will only appear in margin and cross_margin accounts | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/AccountDetail.md: -------------------------------------------------------------------------------- 1 | # AccountDetail 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **IpWhitelist** | **[]string** | IP whitelist | [optional] 8 | **CurrencyPairs** | **[]string** | CurrencyPair whitelisting | [optional] 9 | **UserId** | **int64** | User ID | [optional] 10 | **Tier** | **int64** | User VIP level | [optional] 11 | **Key** | [**AccountDetailKey**](AccountDetail_key.md) | | [optional] 12 | **CopyTradingRole** | **int32** | User role: 0 - Ordinary user 1 - Order leader 2 - Follower 3 - Order leader and follower | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/AccountDetailKey.md: -------------------------------------------------------------------------------- 1 | # AccountDetailKey 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Mode** | **int32** | mode: 1 - classic account 2 - portfolio margin account | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AccountRateLimit.md: -------------------------------------------------------------------------------- 1 | # AccountRateLimit 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Tier** | **string** | Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#rate-limit-based-on-fill-ratio)) | [optional] 8 | **Ratio** | **string** | Transaction rate | [optional] 9 | **MainRatio** | **string** | Total transaction ratio of main account | [optional] 10 | **UpdatedAt** | **string** | Update time | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/AgencyCommission.md: -------------------------------------------------------------------------------- 1 | # AgencyCommission 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CommissionTime** | **int64** | Commission Time. (unix timestamp) | [optional] 8 | **UserId** | **int64** | User ID | [optional] 9 | **GroupName** | **string** | Group name | [optional] 10 | **CommissionAmount** | **string** | Commission Amount | [optional] 11 | **CommissionAsset** | **string** | Commission Asset | [optional] 12 | **Source** | **string** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/AgencyCommissionHistory.md: -------------------------------------------------------------------------------- 1 | # AgencyCommissionHistory 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CurrencyPair** | **string** | Currency pair | [optional] 8 | **Total** | **int64** | Total | [optional] 9 | **List** | [**[]AgencyCommission**](AgencyCommission.md) | List of comission history | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/AgencyTransaction.md: -------------------------------------------------------------------------------- 1 | # AgencyTransaction 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **TransactionTime** | **int64** | Transaction Time. (unix timestamp) | [optional] 8 | **UserId** | **int64** | User ID | [optional] 9 | **GroupName** | **string** | Group name | [optional] 10 | **Fee** | **string** | Fee | [optional] 11 | **FeeAsset** | **string** | Fee currency | [optional] 12 | **CurrencyPair** | **string** | Currency pair | [optional] 13 | **Amount** | **string** | Commission Amount | [optional] 14 | **AmountAsset** | **string** | Commission Asset | [optional] 15 | **Source** | **string** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/AgencyTransactionHistory.md: -------------------------------------------------------------------------------- 1 | # AgencyTransactionHistory 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CurrencyPair** | **string** | Currency pair | [optional] 8 | **Total** | **int64** | Total | [optional] 9 | **List** | [**[]AgencyTransaction**](AgencyTransaction.md) | List of transaction history | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/AutoRepaySetting.md: -------------------------------------------------------------------------------- 1 | # AutoRepaySetting 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Status** | **string** | Auto repayment status. `on` - enabled, `off` - disabled | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/BorrowCurrencyInfo.md: -------------------------------------------------------------------------------- 1 | # BorrowCurrencyInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **IndexPrice** | **string** | Currency Index Price | [optional] 9 | **LeftRepayPrincipal** | **string** | outstanding principal | [optional] 10 | **LeftRepayInterest** | **string** | outstanding interest | [optional] 11 | **LeftRepayUsdt** | **string** | Value of left total repayments amount in USDT | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/BrokerCommission.md: -------------------------------------------------------------------------------- 1 | # BrokerCommission 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Total** | **int64** | Total | [optional] 8 | **List** | [**[]BrokerCommission1**](BrokerCommission_1.md) | List of comission history | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/BrokerTransaction.md: -------------------------------------------------------------------------------- 1 | # BrokerTransaction 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Total** | **int64** | Total | [optional] 8 | **List** | [**[]BrokerTransaction1**](BrokerTransaction_1.md) | List of transaction history | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/BrokerTransaction1.md: -------------------------------------------------------------------------------- 1 | # BrokerTransaction1 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **TransactionTime** | **int64** | Transaction Time. (unix timestamp) | [optional] 8 | **UserId** | **int64** | User ID | [optional] 9 | **GroupName** | **string** | Group name | [optional] 10 | **Fee** | **string** | fee (usdt) | [optional] 11 | **CurrencyPair** | **string** | Currency pair | [optional] 12 | **Amount** | **string** | Commission Amount | [optional] 13 | **FeeAsset** | **string** | Fee currency | [optional] 14 | **Source** | **string** | Rebate Type: Spot、Futures、Options | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/CancelOrderResult.md: -------------------------------------------------------------------------------- 1 | # CancelOrderResult 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CurrencyPair** | **string** | Order currency pair | [optional] 8 | **Id** | **string** | Order ID | [optional] 9 | **Text** | **string** | Custom order information | [optional] 10 | **Succeeded** | **bool** | Whether cancellation succeeded | [optional] 11 | **Label** | **string** | Error label when failed to cancel the order; emtpy if succeeded | [optional] 12 | **Message** | **string** | Error message when failed to cancel the order; empty if succeeded | [optional] 13 | **Account** | **string** | Default is empty (deprecated) | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CollateralAdjust.md: -------------------------------------------------------------------------------- 1 | # CollateralAdjust 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **OrderId** | **int64** | Order ID | 8 | **Type** | **string** | Operation types: append - for adding collateral, redeem - for withdrawing collateral | 9 | **Collaterals** | [**[]CollateralCurrency**](CollateralCurrency.md) | Collateral Currency List | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CollateralAdjustRes.md: -------------------------------------------------------------------------------- 1 | # CollateralAdjustRes 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **OrderId** | **int64** | Order ID | [optional] 8 | **CollateralCurrencies** | [**[]CollateralCurrencyRes**](CollateralCurrencyRes.md) | Collateral Currency Information | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CollateralAlign.md: -------------------------------------------------------------------------------- 1 | # CollateralAlign 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **OrderId** | **int64** | Order ID | 8 | **CollateralCurrency** | **string** | Collateral | 9 | **CollateralAmount** | **string** | Collateral amount | 10 | **Type** | **string** | Operation types: append - for adding collateral, redeem - for withdrawing collateral | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CollateralCurrency.md: -------------------------------------------------------------------------------- 1 | # CollateralCurrency 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **Amount** | **string** | Size | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CollateralCurrencyInfo.md: -------------------------------------------------------------------------------- 1 | # CollateralCurrencyInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **IndexPrice** | **string** | Currency Index Price | [optional] 9 | **LeftCollateral** | **string** | Left Collateral Amount | [optional] 10 | **LeftCollateralUsdt** | **string** | Value of left collateral amount in USDT | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CollateralCurrencyRes.md: -------------------------------------------------------------------------------- 1 | # CollateralCurrencyRes 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Succeeded** | **bool** | Update success status | [optional] 8 | **Label** | **string** | Error identifier for unsuccessful operations; empty for successful. | [optional] 9 | **Message** | **string** | Error description in case of operation failure; empty when successful. | [optional] 10 | **Currency** | **string** | Currency | [optional] 11 | **Amount** | **string** | Quantity of successful collateral operation; 0 if the operation fails. | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CollateralCurrentRate.md: -------------------------------------------------------------------------------- 1 | # CollateralCurrentRate 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **CurrentRate** | **string** | Currency current interest rate | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CollateralFixRate.md: -------------------------------------------------------------------------------- 1 | # CollateralFixRate 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **Rate7d** | **string** | Fixed interest rate for a lending period of 7 days | [optional] 9 | **Rate30d** | **string** | Fixed interest rate for a lending period of 30 days | [optional] 10 | **UpdateTime** | **int64** | Update time, timestamp, unit in seconds | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CollateralLoanCurrency.md: -------------------------------------------------------------------------------- 1 | # CollateralLoanCurrency 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **LoanCurrency** | **string** | Borrowed currency | [optional] 8 | **CollateralCurrency** | **[]string** | List of supported collateral currencies | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CollateralLtv.md: -------------------------------------------------------------------------------- 1 | # CollateralLtv 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **InitLtv** | **string** | The initial collateralization rate | [optional] 8 | **AlertLtv** | **string** | Warning collateralization ratio | [optional] 9 | **LiquidateLtv** | **string** | The liquidation collateralization rate | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConvertSmallBalance.md: -------------------------------------------------------------------------------- 1 | # ConvertSmallBalance 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **[]string** | Currency | [optional] 8 | **IsAll** | **bool** | Whether to exchange all | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CountdownCancelAllFuturesTask.md: -------------------------------------------------------------------------------- 1 | # CountdownCancelAllFuturesTask 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Timeout** | **int32** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown | 8 | **Contract** | **string** | Futures contract | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CountdownCancelAllOptionsTask.md: -------------------------------------------------------------------------------- 1 | # CountdownCancelAllOptionsTask 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Timeout** | **int32** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown | 8 | **Contract** | **string** | Options contract name | [optional] 9 | **Underlying** | **string** | Underlying | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/CountdownCancelAllSpotTask.md: -------------------------------------------------------------------------------- 1 | # CountdownCancelAllSpotTask 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Timeout** | **int32** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown | 8 | **CurrencyPair** | **string** | Currency pair | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CreateCollateralOrder.md: -------------------------------------------------------------------------------- 1 | # CreateCollateralOrder 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CollateralAmount** | **string** | Collateral amount | 8 | **CollateralCurrency** | **string** | Collateral | 9 | **BorrowAmount** | **string** | Borrowing amount | 10 | **BorrowCurrency** | **string** | Borrowed currency | 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CreateUniLend.md: -------------------------------------------------------------------------------- 1 | # CreateUniLend 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | 8 | **Amount** | **string** | The amount of currency could be lent | 9 | **Type** | **string** | type: lend - lend, redeem - redeem | 10 | **MinRate** | **string** | The minimum interest rate. If the value is too high, it might lead to the unsuccessful lending and no profit will be gained for that hour. | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CreateUniLoan.md: -------------------------------------------------------------------------------- 1 | # CreateUniLoan 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | 8 | **Type** | **string** | type: borrow - borrow, repay - repay | 9 | **Amount** | **string** | The amount of lending or repaying | 10 | **RepaidAll** | **bool** | Full repayment. Repay operation only. If the value is `true`, the amount will be ignored and the loan will be repaid in full. | [optional] 11 | **CurrencyPair** | **string** | Currency pair | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/CrossMarginAccountBook.md: -------------------------------------------------------------------------------- 1 | # CrossMarginAccountBook 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **string** | Balance change record ID | [optional] 8 | **Time** | **int64** | The timestamp of the change (in milliseconds) | [optional] 9 | **Currency** | **string** | Currency changed | [optional] 10 | **Change** | **string** | Amount changed. Positive value means transferring in, while negative out | [optional] 11 | **Balance** | **string** | Balance after change | [optional] 12 | **Type** | **string** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/CrossMarginBalance1.md: -------------------------------------------------------------------------------- 1 | # CrossMarginBalance1 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Available** | **string** | Available amount | [optional] 8 | **Freeze** | **string** | Locked amount | [optional] 9 | **Borrowed** | **string** | Borrowed amount | [optional] 10 | **Interest** | **string** | Unpaid interests | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/CrossMarginRepayRequest.md: -------------------------------------------------------------------------------- 1 | # CrossMarginRepayRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Repayment currency | 8 | **Amount** | **string** | Repayment amount | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CrossMarginRepayment.md: -------------------------------------------------------------------------------- 1 | # CrossMarginRepayment 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **string** | Loan record ID | [optional] 8 | **CreateTime** | **int64** | Repayment time | [optional] 9 | **LoanId** | **string** | Loan record ID | [optional] 10 | **Currency** | **string** | Currency name | [optional] 11 | **Principal** | **string** | Repaid principal | [optional] 12 | **Interest** | **string** | Repaid interest | [optional] 13 | **RepaymentType** | **string** | Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment, cancel_auto_repay - automatic repayment after cancellation | [optional] [readonly] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CrossMarginTransferable.md: -------------------------------------------------------------------------------- 1 | # CrossMarginTransferable 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency detail | [optional] 8 | **Amount** | **string** | Max transferable amount | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/CurrencyQuota.md: -------------------------------------------------------------------------------- 1 | # CurrencyQuota 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **IndexPrice** | **string** | Currency Index Price | [optional] 9 | **MinQuota** | **string** | Minimum borrowing/collateral quota for the currency | [optional] 10 | **LeftQuota** | **string** | Remaining borrowing/collateral limit for the currency | [optional] 11 | **LeftQuoteUsdt** | **string** | Remaining currency limit converted to USDT | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/DebitFee.md: -------------------------------------------------------------------------------- 1 | # DebitFee 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Enabled** | **bool** | Whether GT fee discount is used | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/DeliveryCandlestick.md: -------------------------------------------------------------------------------- 1 | # DeliveryCandlestick 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **T** | **float64** | Unix timestamp in seconds | [optional] 8 | **V** | **int64** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] 9 | **C** | **string** | Close price (quote currency) | [optional] 10 | **H** | **string** | Highest price (quote currency) | [optional] 11 | **L** | **string** | Lowest price (quote currency) | [optional] 12 | **O** | **string** | Open price (quote currency) | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/DepositAddress.md: -------------------------------------------------------------------------------- 1 | # DepositAddress 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency detail | 8 | **Address** | **string** | Deposit address | 9 | **MultichainAddresses** | [**[]MultiChainAddressItem**](MultiChainAddressItem.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Eth2RateList.md: -------------------------------------------------------------------------------- 1 | # Eth2RateList 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **DateTime** | **int64** | Date and Time Stamp | [optional] 8 | **Date** | **string** | Date | [optional] 9 | **Rate** | **string** | percentage | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Eth2Swap.md: -------------------------------------------------------------------------------- 1 | # Eth2Swap 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Side** | **string** | 1-Forward Swap(ETH -> ETH2), 2-Reverse Swap(ETH2 -> ETH) | 8 | **Amount** | **string** | amount | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/FlashSwapOrderPreview.md: -------------------------------------------------------------------------------- 1 | # FlashSwapOrderPreview 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **PreviewId** | **string** | Preview result ID | [optional] 8 | **SellCurrency** | **string** | Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional] 9 | **SellAmount** | **string** | Amount to sell | [optional] 10 | **BuyCurrency** | **string** | Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional] 11 | **BuyAmount** | **string** | Amount to buy | [optional] 12 | **Price** | **string** | Price | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/FundingAccount.md: -------------------------------------------------------------------------------- 1 | # FundingAccount 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | [optional] 8 | **Available** | **string** | Available assets to lend, which is identical to spot account `available` | [optional] 9 | **Locked** | **string** | Locked amount. i.e. amount in `open` loans | [optional] 10 | **Lent** | **string** | Outstanding loan amount yet to be repaid | [optional] 11 | **TotalLent** | **string** | Amount used for lending. total_lent = lent + locked | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/FundingRateRecord.md: -------------------------------------------------------------------------------- 1 | # FundingRateRecord 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **T** | **int64** | Unix timestamp in seconds | [optional] 8 | **R** | **string** | Funding rate | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/FutureCancelOrderResult.md: -------------------------------------------------------------------------------- 1 | # FutureCancelOrderResult 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **string** | Order ID | [optional] 8 | **UserId** | **int64** | User ID | [optional] 9 | **Succeeded** | **bool** | Whether cancellation succeeded | [optional] 10 | **Message** | **string** | Error message when failed to cancel the order; empty if succeeded | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/FuturesCandlestick.md: -------------------------------------------------------------------------------- 1 | # FuturesCandlestick 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **T** | **float64** | Unix timestamp in seconds | [optional] 8 | **V** | **int64** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] 9 | **C** | **string** | Close price (quote currency) | [optional] 10 | **H** | **string** | Highest price (quote currency) | [optional] 11 | **L** | **string** | Lowest price (quote currency) | [optional] 12 | **O** | **string** | Open price (quote currency) | [optional] 13 | **Sum** | **string** | Trading volume (unit: Quote currency) | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/FuturesFee.md: -------------------------------------------------------------------------------- 1 | # FuturesFee 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **TakerFee** | **string** | Taker fee | [optional] [readonly] 8 | **MakerFee** | **string** | maker fee | [optional] [readonly] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/FuturesIndexConstituents.md: -------------------------------------------------------------------------------- 1 | # FuturesIndexConstituents 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Index** | **string** | Index name | [optional] [readonly] 8 | **Constituents** | [**[]IndexConstituent**](IndexConstituent.md) | Constituents | [optional] [readonly] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/FuturesLimitRiskTiers.md: -------------------------------------------------------------------------------- 1 | # FuturesLimitRiskTiers 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Tier** | **int32** | Tier | [optional] 8 | **RiskLimit** | **string** | Position risk limit | [optional] 9 | **InitialRate** | **string** | Initial margin rate | [optional] 10 | **MaintenanceRate** | **string** | Maintenance margin rate | [optional] 11 | **LeverageMax** | **string** | Maximum leverage | [optional] 12 | **Contract** | **string** | Markets, visible only during market pagination requests | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/FuturesLiqOrder.md: -------------------------------------------------------------------------------- 1 | # FuturesLiqOrder 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Time** | **int64** | Liquidation time | [optional] [readonly] 8 | **Contract** | **string** | Futures contract | [optional] [readonly] 9 | **Size** | **int64** | User position size | [optional] [readonly] 10 | **OrderSize** | **int64** | Number of forced liquidation orders | [optional] [readonly] 11 | **OrderPrice** | **string** | Liquidation order price | [optional] [readonly] 12 | **FillPrice** | **string** | Liquidation order average taker price | [optional] [readonly] 13 | **Left** | **int64** | System liquidation order maker size | [optional] [readonly] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/FuturesOrderBook.md: -------------------------------------------------------------------------------- 1 | # FuturesOrderBook 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **int64** | Order Book ID. Increases by 1 on every order book change. Set `with_id=true` to include this field in response | [optional] 8 | **Current** | **float64** | Response data generation timestamp | [optional] 9 | **Update** | **float64** | Order book changed timestamp | [optional] 10 | **Asks** | [**[]FuturesOrderBookItem**](futures_order_book_item.md) | Asks order depth | 11 | **Bids** | [**[]FuturesOrderBookItem**](futures_order_book_item.md) | Bids order depth | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/FuturesOrderBookItem.md: -------------------------------------------------------------------------------- 1 | # FuturesOrderBookItem 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **P** | **string** | Price (quote currency) | [optional] 8 | **S** | **int64** | Size | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/FuturesPremiumIndex.md: -------------------------------------------------------------------------------- 1 | # FuturesPremiumIndex 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **T** | **float64** | Unix timestamp in seconds | [optional] 8 | **C** | **string** | Close price | [optional] 9 | **H** | **string** | Highest price | [optional] 10 | **L** | **string** | Lowest price` | [optional] 11 | **O** | **string** | Open price | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/IndexConstituent.md: -------------------------------------------------------------------------------- 1 | # IndexConstituent 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Exchange** | **string** | Exchange | [optional] 8 | **Symbols** | **[]string** | Symbol list | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/InlineObject.md: -------------------------------------------------------------------------------- 1 | # InlineObject 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Mode** | **string** | Full position-by-position model, ISOLATED-by-position, CROSS-full position | 8 | **Contract** | **string** | Contract Market | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/InlineResponse200.md: -------------------------------------------------------------------------------- 1 | # InlineResponse200 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Time** | **int64** | | [optional] 8 | **Value** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/InlineResponse2001.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2001 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | | [optional] 8 | **EstRate** | **string** | Unconverted percentage | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/InsuranceRecord.md: -------------------------------------------------------------------------------- 1 | # InsuranceRecord 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **T** | **int64** | Unix timestamp in seconds | [optional] 8 | **B** | **string** | Insurance balance | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MarginAccountCurrency.md: -------------------------------------------------------------------------------- 1 | # MarginAccountCurrency 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | [optional] 8 | **Available** | **string** | Amount suitable for margin trading. | [optional] 9 | **Locked** | **string** | Locked amount, used in margin trading | [optional] 10 | **Borrowed** | **string** | Borrowed amount | [optional] 11 | **Interest** | **string** | Unpaid interests | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MarginLeverageTier.md: -------------------------------------------------------------------------------- 1 | # MarginLeverageTier 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **UpperLimit** | **string** | Maximum loan limit | [optional] 8 | **Mmr** | **string** | Maintenance margin rate | [optional] 9 | **Leverage** | **string** | Maximum leverage multiple | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MarginMarketLeverage.md: -------------------------------------------------------------------------------- 1 | # MarginMarketLeverage 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CurrencyPair** | **string** | Currency pair | [optional] 8 | **Leverage** | **string** | Position leverage | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MarginTiers.md: -------------------------------------------------------------------------------- 1 | # MarginTiers 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Tier** | **string** | Tier | [optional] 8 | **MarginRate** | **string** | Discount | [optional] 9 | **LowerLimit** | **string** | Lower limit | [optional] 10 | **UpperLimit** | **string** | Upper limit, \"\" indicates greater than (the last tier) | [optional] 11 | **Leverage** | **string** | Position leverage | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MarginTransferable.md: -------------------------------------------------------------------------------- 1 | # MarginTransferable 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency detail | [optional] 8 | **CurrencyPair** | **string** | Currency pair | [optional] 9 | **Amount** | **string** | Max transferable amount | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MaxUniBorrowable.md: -------------------------------------------------------------------------------- 1 | # MaxUniBorrowable 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [readonly] 8 | **CurrencyPair** | **string** | Currency pair | [optional] [readonly] 9 | **Borrowable** | **string** | Maximum borrowable | [readonly] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MockFuturesOrder.md: -------------------------------------------------------------------------------- 1 | # MockFuturesOrder 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Contract** | **string** | Futures name, currently only supports perpetual futures for BTC and ETH with USDT. | 8 | **Size** | **string** | Futures quantity, representing the initial order quantity, not involved in actual settlement. | 9 | **Left** | **string** | Unfilled contract quantity, involved in actual calculation | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MockFuturesPosition.md: -------------------------------------------------------------------------------- 1 | # MockFuturesPosition 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Contract** | **string** | Futures name, currently only supports perpetual futures for BTC and ETH with USDT. | 8 | **Size** | **string** | Position size, measured in contract units. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MockOptionsOrder.md: -------------------------------------------------------------------------------- 1 | # MockOptionsOrder 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **OptionsName** | **string** | Option name, currently only supports options for BTC and ETH with USDT. | 8 | **Size** | **string** | Initial order quantity, not involved in actual calculation | 9 | **Left** | **string** | Unfilled contract quantity, involved in actual calculation | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MockOptionsPosition.md: -------------------------------------------------------------------------------- 1 | # MockOptionsPosition 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **OptionsName** | **string** | Option name, currently only supports options for BTC and ETH with USDT. | 8 | **Size** | **string** | Position size, measured in contract units. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MockSpotBalance.md: -------------------------------------------------------------------------------- 1 | # MockSpotBalance 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | 8 | **Equity** | **string** | Currency equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports three currencies: BTC, ETH. | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MockSpotOrder.md: -------------------------------------------------------------------------------- 1 | # MockSpotOrder 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CurrencyPairs** | **string** | Currency pair | 8 | **OrderPrice** | **string** | Price | 9 | **Count** | **string** | Initial order quantity for spot trading pairs, not involved in actual calculation. Currently only supports three currencies: BTC, ETH. | [optional] 10 | **Left** | **string** | Unfilled quantity, involved in actual calculation. | 11 | **Type** | **string** | Order type, sell - sell order, buy - buy order. | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MultiChainAddressItem.md: -------------------------------------------------------------------------------- 1 | # MultiChainAddressItem 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Chain** | **string** | Name of the chain | [optional] 8 | **Address** | **string** | Deposit address | [optional] 9 | **PaymentId** | **string** | Notes that some currencies required(e.g., Tag, Memo) when depositing | [optional] 10 | **PaymentName** | **string** | Note type, `Tag` or `Memo` | [optional] 11 | **ObtainFailed** | **int32** | The obtain failed status- 0: address successfully obtained- 1: failed to obtain address | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/MultiCollateralCurrency.md: -------------------------------------------------------------------------------- 1 | # MultiCollateralCurrency 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **LoanCurrencies** | [**[]MultiLoanItem**](MultiLoanItem.md) | List of supported borrowing currencies | [optional] 8 | **CollateralCurrencies** | [**[]MultiCollateralItem**](MultiCollateralItem.md) | List of supported collateral currencies | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MultiCollateralItem.md: -------------------------------------------------------------------------------- 1 | # MultiCollateralItem 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **IndexPrice** | **string** | Currency Index Price | [optional] 9 | **Discount** | **string** | Discount | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MultiCollateralRecordCurrency.md: -------------------------------------------------------------------------------- 1 | # MultiCollateralRecordCurrency 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **IndexPrice** | **string** | Currency Index Price | [optional] 9 | **BeforeAmount** | **string** | Amount before the operation | [optional] 10 | **BeforeAmountUsdt** | **string** | USDT Amount before the operation. | [optional] 11 | **AfterAmount** | **string** | Amount after the operation. | [optional] 12 | **AfterAmountUsdt** | **string** | USDT Amount after the operation. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/MultiLoanItem.md: -------------------------------------------------------------------------------- 1 | # MultiLoanItem 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **Price** | **string** | Latest price of the currency | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/MultiLoanRepayItem.md: -------------------------------------------------------------------------------- 1 | # MultiLoanRepayItem 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Repayment currency | [optional] 8 | **Amount** | **string** | Size | [optional] 9 | **RepaidAll** | **bool** | Repayment method, set to true for full repayment, false for partial repayment. | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/MultiRepayResp.md: -------------------------------------------------------------------------------- 1 | # MultiRepayResp 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **OrderId** | **int64** | Order ID | [optional] 8 | **RepaidCurrencies** | [**[]RepayCurrencyRes**](RepayCurrencyRes.md) | Repay Currency List | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/OpenOrders.md: -------------------------------------------------------------------------------- 1 | # OpenOrders 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CurrencyPair** | **string** | Currency pair | [optional] 8 | **Total** | **int32** | The total number of pending orders for this trading pair on the current page | [optional] 9 | **Orders** | [**[]Order**](Order.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/OptionsAccountBook.md: -------------------------------------------------------------------------------- 1 | # OptionsAccountBook 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Time** | **float64** | Change time | [optional] 8 | **Change** | **string** | Amount changed (USDT) | [optional] 9 | **Balance** | **string** | Account total balance after change (USDT) | [optional] 10 | **Type** | **string** | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional] 11 | **Text** | **string** | custom text | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/OptionsMyTrade.md: -------------------------------------------------------------------------------- 1 | # OptionsMyTrade 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **int64** | Trade ID | [optional] 8 | **CreateTime** | **float64** | Trading time | [optional] 9 | **Contract** | **string** | Options contract name | [optional] 10 | **OrderId** | **int32** | Order ID related | [optional] 11 | **Size** | **int64** | Trading size | [optional] 12 | **Price** | **string** | Trading price (quote currency) | [optional] 13 | **UnderlyingPrice** | **string** | Underlying price (quote currency) | [optional] 14 | **Role** | **string** | Trade role. Available values are `taker` and `maker` | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/OptionsPositionClose.md: -------------------------------------------------------------------------------- 1 | # OptionsPositionClose 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Time** | **float64** | Position close time | [optional] [readonly] 8 | **Contract** | **string** | Options contract name | [optional] [readonly] 9 | **Side** | **string** | Position side, long or short | [optional] [readonly] 10 | **Pnl** | **string** | PNL | [optional] [readonly] 11 | **Text** | **string** | Text of close order | [optional] [readonly] 12 | **SettleSize** | **string** | settlement size | [optional] [readonly] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OptionsPositionCloseOrder.md: -------------------------------------------------------------------------------- 1 | # OptionsPositionCloseOrder 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **int64** | Close order ID | [optional] 8 | **Price** | **string** | Close order price (quote currency) | [optional] 9 | **IsLiq** | **bool** | Is the close order from liquidation | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/OptionsSettlement.md: -------------------------------------------------------------------------------- 1 | # OptionsSettlement 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Time** | **float64** | Last changed time of configuration | [optional] 8 | **Contract** | **string** | Options contract name | [optional] 9 | **Profit** | **string** | Settlement profit per size (quote currency) | [optional] 10 | **Fee** | **string** | Settlement fee per size (quote currency) | [optional] 11 | **StrikePrice** | **string** | Strike price (quote currency) | [optional] 12 | **SettlePrice** | **string** | Settlement price (quote currency) | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/OptionsUnderlying.md: -------------------------------------------------------------------------------- 1 | # OptionsUnderlying 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Name** | **string** | Underlying name | [optional] 8 | **IndexPrice** | **string** | Spot index price (quote currency) | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/OptionsUnderlyingTicker.md: -------------------------------------------------------------------------------- 1 | # OptionsUnderlyingTicker 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **TradePut** | **int64** | Total put options trades amount in last 24h | [optional] 8 | **TradeCall** | **int64** | Total call options trades amount in last 24h | [optional] 9 | **IndexPrice** | **string** | Index price (quote currency) | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/OrderBook.md: -------------------------------------------------------------------------------- 1 | # OrderBook 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **int64** | Order book ID, which is updated whenever the order book is changed. Valid only when `with_id` is set to `true` | [optional] 8 | **Current** | **int64** | The timestamp of the response data being generated (in milliseconds) | [optional] 9 | **Update** | **int64** | The timestamp of when the orderbook last changed (in milliseconds) | [optional] 10 | **Asks** | [**[][]string**](array.md) | Asks order depth | 11 | **Bids** | [**[][]string**](array.md) | Bids order depth | 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/OrderResp.md: -------------------------------------------------------------------------------- 1 | # OrderResp 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **OrderId** | **int64** | Order ID | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/PartnerCommissionHistory.md: -------------------------------------------------------------------------------- 1 | # PartnerCommissionHistory 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Total** | **int64** | Total | [optional] 8 | **List** | [**[]AgencyCommission**](AgencyCommission.md) | List of comission history | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PartnerSub.md: -------------------------------------------------------------------------------- 1 | # PartnerSub 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **UserId** | **int64** | User ID | [optional] 8 | **UserJoinTime** | **int64** | The time when the user joined the system, in seconds Unix timestamp | [optional] 9 | **Type** | **int64** | Type (1-Sub-agent 2-Indirect Customer 3-Direct Customer) | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PartnerSubList.md: -------------------------------------------------------------------------------- 1 | # PartnerSubList 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Total** | **int64** | Total | [optional] 8 | **List** | [**[]PartnerSub**](PartnerSub.md) | Subordinate list | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PartnerTransactionHistory.md: -------------------------------------------------------------------------------- 1 | # PartnerTransactionHistory 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Total** | **int64** | Total | [optional] 8 | **List** | [**[]AgencyTransaction**](AgencyTransaction.md) | List of transaction history | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PatchUniLend.md: -------------------------------------------------------------------------------- 1 | # PatchUniLend 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | [optional] 8 | **MinRate** | **string** | Minimum interest rate | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PlaceDualInvestmentOrder.md: -------------------------------------------------------------------------------- 1 | # PlaceDualInvestmentOrder 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **PlanId** | **string** | Plan ID | 8 | **Amount** | **string** | Subscription amount, mutually exclusive with the copies field | 9 | **Text** | **string** | User defined information. If not empty, must follow the rules below: 1. prefixed with `t-` 2. no longer than 28 bytes without `t-` prefix 3. can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PositionCloseOrder.md: -------------------------------------------------------------------------------- 1 | # PositionCloseOrder 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **int64** | Close order ID | [optional] 8 | **Price** | **string** | Close order price | [optional] 9 | **IsLiq** | **bool** | Is the close order from liquidation | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ProfitLossRange.md: -------------------------------------------------------------------------------- 1 | # ProfitLossRange 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **PricePercentage** | **string** | Percentage change in price | [optional] 8 | **ImpliedVolatilityPercentage** | **string** | Percentage change in implied volatility | [optional] 9 | **ProfitLoss** | **string** | PNL | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RebateUserInfo.md: -------------------------------------------------------------------------------- 1 | # RebateUserInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **InviteUid** | **int64** | My inviter's UID | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RepayCurrencyRes.md: -------------------------------------------------------------------------------- 1 | # RepayCurrencyRes 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Succeeded** | **bool** | Has the repayment been successful | [optional] 8 | **Label** | **string** | Error identifier for unsuccessful operations; empty for successful. | [optional] 9 | **Message** | **string** | Error description in case of operation failure; empty when successful. | [optional] 10 | **Currency** | **string** | Repayment currency | [optional] 11 | **RepaidPrincipal** | **string** | Principal | [optional] 12 | **RepaidInterest** | **string** | Principal | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RepayLoan.md: -------------------------------------------------------------------------------- 1 | # RepayLoan 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **OrderId** | **int64** | Order ID | 8 | **RepayAmount** | **string** | Repayment amount, it is mandatory when making partial repayments | 9 | **RepaidAll** | **bool** | Repayment method, set to `true` for full repayment, and `false` for partial repayment; When set to false for partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/RepayMultiLoan.md: -------------------------------------------------------------------------------- 1 | # RepayMultiLoan 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **OrderId** | **int64** | Order ID | 8 | **RepayItems** | [**[]MultiLoanRepayItem**](MultiLoanRepayItem.md) | Repay Currency Item | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RepayRecordCurrency.md: -------------------------------------------------------------------------------- 1 | # RepayRecordCurrency 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **IndexPrice** | **string** | Currency Index Price | [optional] 9 | **BeforeAmount** | **string** | Amount before the operation | [optional] 10 | **BeforeAmountUsdt** | **string** | USDT Amount before the operation. | [optional] 11 | **AfterAmount** | **string** | Amount after the operation. | [optional] 12 | **AfterAmountUsdt** | **string** | USDT Amount after the operation. | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RepayRecordLeftInterest.md: -------------------------------------------------------------------------------- 1 | # RepayRecordLeftInterest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **IndexPrice** | **string** | Currency Index Price | [optional] 9 | **BeforeAmount** | **string** | Interest amount before repayment | [optional] 10 | **BeforeAmountUsdt** | **string** | Converted value of interest before repayment in USDT | [optional] 11 | **AfterAmount** | **string** | Interest amount after repayment | [optional] 12 | **AfterAmountUsdt** | **string** | Converted value of interest after repayment in USDT | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RepayRecordRepaidCurrency.md: -------------------------------------------------------------------------------- 1 | # RepayRecordRepaidCurrency 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Repayment currency | [optional] 8 | **IndexPrice** | **string** | Currency Index Price | [optional] 9 | **RepaidAmount** | **string** | Repayment amount | [optional] 10 | **RepaidPrincipal** | **string** | Principal | [optional] 11 | **RepaidInterest** | **string** | Interest | [optional] 12 | **RepaidAmountUsdt** | **string** | Value of the repayment amount in USDT | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/RepayRecordTotalInterest.md: -------------------------------------------------------------------------------- 1 | # RepayRecordTotalInterest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **IndexPrice** | **string** | Currency Index Price | [optional] 9 | **Amount** | **string** | Interest Amount | [optional] 10 | **AmountUsdt** | **string** | Interest amount converted to USDT | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/RepayResp.md: -------------------------------------------------------------------------------- 1 | # RepayResp 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **RepaidPrincipal** | **string** | Principal | [optional] 8 | **RepaidInterest** | **string** | Interest | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/RiskUnits.md: -------------------------------------------------------------------------------- 1 | # RiskUnits 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Symbol** | **string** | Risk unit flag | [optional] 8 | **SpotInUse** | **string** | Spot hedging utilization | [optional] 9 | **MaintainMargin** | **string** | Maintenance margin for risk unit | [optional] 10 | **InitialMargin** | **string** | Initial margin for risk unit | [optional] 11 | **Delta** | **string** | Total Delta of risk unit | [optional] 12 | **Gamma** | **string** | Total Gamma of risk unit | [optional] 13 | **Theta** | **string** | Total Theta of risk unit | [optional] 14 | **Vega** | **string** | Total Vega of risk unit | [optional] 15 | 16 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/SavedAddress.md: -------------------------------------------------------------------------------- 1 | # SavedAddress 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **Chain** | **string** | Chain name | [optional] 9 | **Address** | **string** | Address | [optional] 10 | **Name** | **string** | Name | [optional] 11 | **Tag** | **string** | Tag | [optional] 12 | **Verified** | **string** | Whether to pass the verification 0-unverified, 1-verified | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/SmallBalance.md: -------------------------------------------------------------------------------- 1 | # SmallBalance 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **AvailableBalance** | **string** | Available balance | [optional] 9 | **EstimatedAsBtc** | **string** | Estimated as BTC | [optional] 10 | **ConvertibleToGt** | **string** | Estimated conversion to GT | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SmallBalanceHistory.md: -------------------------------------------------------------------------------- 1 | # SmallBalanceHistory 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **string** | Order ID | [optional] [readonly] 8 | **Currency** | **string** | Currency | [optional] [readonly] 9 | **Amount** | **string** | amount | [optional] [readonly] 10 | **GtAmount** | **string** | GT amount | [optional] [readonly] 11 | **CreateTime** | **int64** | Exchange time (in seconds) | [optional] [readonly] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SpotAccount.md: -------------------------------------------------------------------------------- 1 | # SpotAccount 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency detail | [optional] 8 | **Available** | **string** | Available amount | [optional] 9 | **Locked** | **string** | Locked amount, used in trading | [optional] 10 | **UpdateId** | **int64** | Version number | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/SpotCurrencyChain.md: -------------------------------------------------------------------------------- 1 | # SpotCurrencyChain 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Name** | **string** | Chain name | [optional] 8 | **Addr** | **string** | token address | [optional] 9 | **WithdrawDisabled** | **bool** | Whether currency's withdrawal is disabled | [optional] 10 | **WithdrawDelayed** | **bool** | Whether currency's withdrawal is delayed | [optional] 11 | **DepositDisabled** | **bool** | Whether currency's deposit is disabled | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/SpotInsuranceHistory.md: -------------------------------------------------------------------------------- 1 | # SpotInsuranceHistory 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] 8 | **Balance** | **string** | balance | [optional] 9 | **Time** | **int64** | Creation time, timestamp, milliseconds | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SpotPriceTrigger.md: -------------------------------------------------------------------------------- 1 | # SpotPriceTrigger 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Price** | **string** | Trigger price | 8 | **Rule** | **string** | Price trigger condition - >=: triggered when market price larger than or equal to `price` field - <=: triggered when market price less than or equal to `price` field | 9 | **Expiration** | **int32** | How long (in seconds) to wait for the condition to be triggered before cancelling the order. | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/StpGroup.md: -------------------------------------------------------------------------------- 1 | # StpGroup 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **int64** | STP Group ID | [optional] 8 | **Name** | **string** | STP Group name | 9 | **CreatorId** | **int64** | Creator ID | [optional] 10 | **CreateTime** | **int64** | Creation time | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/StpGroupUser.md: -------------------------------------------------------------------------------- 1 | # StpGroupUser 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **UserId** | **int64** | User ID | [optional] 8 | **StpId** | **int64** | STP Group ID | [optional] 9 | **CreateTime** | **int64** | Creation time | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/StructuredBuy.md: -------------------------------------------------------------------------------- 1 | # StructuredBuy 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Pid** | **string** | Plan ID | [optional] 8 | **Amount** | **string** | Purchase Amount | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/StructuredOrderList.md: -------------------------------------------------------------------------------- 1 | # StructuredOrderList 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **int32** | Order ID | [optional] 8 | **Pid** | **string** | Plan ID | [optional] 9 | **LockCoin** | **string** | Locked coin | [optional] 10 | **Amount** | **string** | Locked amount | [optional] 11 | **Status** | **string** | Status: SUCCESS - SUCCESS FAILED - FAILED DONE - DONE | [optional] 12 | **Income** | **string** | Income | [optional] 13 | **CreateTime** | **int32** | Created time | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/SubAccountBalance.md: -------------------------------------------------------------------------------- 1 | # SubAccountBalance 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Uid** | **string** | User ID | [optional] 8 | **Available** | **map[string]string** | Available balances of currencies | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountCrossMarginBalance.md: -------------------------------------------------------------------------------- 1 | # SubAccountCrossMarginBalance 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Uid** | **string** | User ID | [optional] 8 | **Available** | [**SubCrossMarginAccount**](.md) | 账户余额信息 | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountFuturesBalance.md: -------------------------------------------------------------------------------- 1 | # SubAccountFuturesBalance 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Uid** | **string** | User ID | [optional] 8 | **Available** | [**map[string]FuturesAccount**](FuturesAccount.md) | Futures account balances | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountKeyPerms.md: -------------------------------------------------------------------------------- 1 | # SubAccountKeyPerms 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Name** | **string** | Permission function name (no value will be cleared) - wallet: wallet - spot: spot/leverage - futures: perpetual contract - delivery: delivery contract - earn: financial management - custody: custody - options: options - account: account information - loan: loan - margin: leverage - unified: unified account - copy: copy | [optional] 8 | **ReadOnly** | **bool** | read only | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubAccountMarginBalance.md: -------------------------------------------------------------------------------- 1 | # SubAccountMarginBalance 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Uid** | **string** | User ID | [optional] 8 | **Available** | [**[]MarginAccount**](MarginAccount.md) | Margin account balances | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SubUserMode.md: -------------------------------------------------------------------------------- 1 | # SubUserMode 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **UserId** | **int64** | User ID | [optional] 8 | **IsUnified** | **bool** | Is it a unified account? | [optional] 9 | **Mode** | **string** | Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/SystemTime.md: -------------------------------------------------------------------------------- 1 | # SystemTime 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ServerTime** | **int64** | Server current time(ms) | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TotalBalance.md: -------------------------------------------------------------------------------- 1 | # TotalBalance 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Total** | [**AccountBalance**](AccountBalance.md) | | [optional] 8 | **Details** | [**map[string]AccountBalance**](AccountBalance.md) | Total balances in different accounts - cross_margin: cross margin account - spot: spot account - finance: finance account - margin: margin account - quant: quant account - futures: futures account - delivery: delivery account - warrant: warrant account - cbbc: cbbc account | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/TransactionId.md: -------------------------------------------------------------------------------- 1 | # TransactionId 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **TxId** | **int64** | Order id | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Transfer.md: -------------------------------------------------------------------------------- 1 | # Transfer 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Transfer currency. For futures account, `currency` can be set to `POINT` or settle currency | 8 | **From** | **string** | Account to transfer from | 9 | **To** | **string** | Account to transfer to | 10 | **Amount** | **string** | Transfer amount | 11 | **CurrencyPair** | **string** | Margin currency pair. Required if transfer from or to margin account | [optional] 12 | **Settle** | **string** | Futures settle currency. Required if transferring from or to futures account | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TransferOrderStatus.md: -------------------------------------------------------------------------------- 1 | # TransferOrderStatus 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **TxId** | **string** | Order id | [optional] 8 | **Status** | **string** | Transfer status, PENDING - in process, SUCCESS - successful transfer, FAIL - failed transfer, PARTIAL_SUCCESS - Partially successful (this status will appear when transferring between sub-subs) | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/TransferablesResult.md: -------------------------------------------------------------------------------- 1 | # TransferablesResult 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency detail | [optional] 8 | **Amount** | **string** | The maximum amount that can be transferred out | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/TriggerOrderResponse.md: -------------------------------------------------------------------------------- 1 | # TriggerOrderResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **int64** | Auto order ID | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TriggerTime.md: -------------------------------------------------------------------------------- 1 | # TriggerTime 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **TriggerTime** | **int64** | Timestamp of the end of the countdown, in milliseconds | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UidPushWithdrawal.md: -------------------------------------------------------------------------------- 1 | # UidPushWithdrawal 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **ReceiveUid** | **int64** | Recipient UID | 8 | **Currency** | **string** | Currency name | 9 | **Amount** | **string** | Transfer amount | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UidPushWithdrawalResp.md: -------------------------------------------------------------------------------- 1 | # UidPushWithdrawalResp 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Id** | **int64** | Order ID | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UniCurrency.md: -------------------------------------------------------------------------------- 1 | # UniCurrency 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | [optional] [readonly] 8 | **MinLendAmount** | **string** | The minimum lending amount, in the unit of the currency. | [optional] [readonly] 9 | **MaxLendAmount** | **string** | The total maximum lending amount, in USDT | [optional] [readonly] 10 | **MaxRate** | **string** | Maximum rate (Hourly) | [optional] [readonly] 11 | **MinRate** | **string** | Minimum rate (Hourly) | [optional] [readonly] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UniCurrencyInterest.md: -------------------------------------------------------------------------------- 1 | # UniCurrencyInterest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] [readonly] 8 | **InterestStatus** | **string** | Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment | [optional] [readonly] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UniCurrencyPair.md: -------------------------------------------------------------------------------- 1 | # UniCurrencyPair 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CurrencyPair** | **string** | Currency pair | [optional] [readonly] 8 | **BaseMinBorrowAmount** | **string** | Minimum borrow amount of base currency | [optional] [readonly] 9 | **QuoteMinBorrowAmount** | **string** | Minimum borrow amount of quote currency | [optional] [readonly] 10 | **Leverage** | **string** | Position leverage | [optional] [readonly] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UniInterestMode.md: -------------------------------------------------------------------------------- 1 | # UniInterestMode 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | 8 | **Status** | **bool** | Interest toggle settings, true - interest reinvestment, false - regular dividend | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UniInterestRecord.md: -------------------------------------------------------------------------------- 1 | # UniInterestRecord 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Status** | **int32** | Status: 0 - fail, 1 - success | [optional] [readonly] 8 | **Currency** | **string** | Currency | [optional] [readonly] 9 | **ActualRate** | **string** | Actual Rate | [optional] [readonly] 10 | **Interest** | **string** | Interest | [optional] [readonly] 11 | **InterestStatus** | **string** | Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment | [optional] [readonly] 12 | **CreateTime** | **int64** | Created time | [optional] [readonly] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UniLendInterest.md: -------------------------------------------------------------------------------- 1 | # UniLendInterest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] [readonly] 8 | **Interest** | **string** | Interest | [optional] [readonly] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UniLendRecord.md: -------------------------------------------------------------------------------- 1 | # UniLendRecord 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | [optional] [readonly] 8 | **Amount** | **string** | current amount | [optional] [readonly] 9 | **LastWalletAmount** | **string** | Last wallet amount | [optional] [readonly] 10 | **LastLentAmount** | **string** | Last lent amount | [optional] [readonly] 11 | **LastFrozenAmount** | **string** | Last frozen amount | [optional] [readonly] 12 | **Type** | **string** | Record type: lend - lend, redeem - redeem | [optional] [readonly] 13 | **CreateTime** | **int64** | Created time | [optional] [readonly] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/UniLoan.md: -------------------------------------------------------------------------------- 1 | # UniLoan 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | [optional] [readonly] 8 | **CurrencyPair** | **string** | Currency pair | [optional] [readonly] 9 | **Amount** | **string** | amount | [optional] [readonly] 10 | **Type** | **string** | Loan type, platform - platform, margin - margin | [optional] [readonly] 11 | **CreateTime** | **int64** | Created time | [optional] [readonly] 12 | **UpdateTime** | **int64** | Updated time | [optional] [readonly] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UniLoanInterestRecord.md: -------------------------------------------------------------------------------- 1 | # UniLoanInterestRecord 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | [optional] [readonly] 8 | **CurrencyPair** | **string** | Currency pair | [optional] [readonly] 9 | **ActualRate** | **string** | Actual rate | [optional] [readonly] 10 | **Interest** | **string** | Interest | [optional] [readonly] 11 | **Status** | **int32** | Status: 0 - fail, 1 - success | [optional] [readonly] 12 | **Type** | **string** | Type, platform - platform,margin - margin | [optional] [readonly] 13 | **CreateTime** | **int64** | Created time | [optional] [readonly] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/UniLoanRecord.md: -------------------------------------------------------------------------------- 1 | # UniLoanRecord 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Type** | **string** | type: borrow - borrow, repay - repay | [optional] [readonly] 8 | **CurrencyPair** | **string** | Currency pair | [optional] [readonly] 9 | **Currency** | **string** | Currency | [optional] [readonly] 10 | **Amount** | **string** | The amount of lending or repaying | [optional] [readonly] 11 | **CreateTime** | **int64** | Created time | [optional] [readonly] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UnifiedBorrowable.md: -------------------------------------------------------------------------------- 1 | # UnifiedBorrowable 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency detail | [optional] 8 | **Amount** | **string** | Max borrowable amount | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UnifiedBorrowable1.md: -------------------------------------------------------------------------------- 1 | # UnifiedBorrowable1 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency detail | [optional] 8 | **Amount** | **string** | The maximum amount to borrow | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UnifiedCurrency.md: -------------------------------------------------------------------------------- 1 | # UnifiedCurrency 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Name** | **string** | Currency name | [optional] 8 | **Prec** | **string** | Currency precision | [optional] 9 | **MinBorrowAmount** | **string** | The minimum debit limit is the unit of currency | [optional] 10 | **UserMaxBorrowAmount** | **string** | The minimum debit limit is the unit of currency | [optional] 11 | **TotalMaxBorrowAmount** | **string** | The maximum debit limit for the platform is USDT | [optional] 12 | **LoanStatus** | **string** | Does the lending status - `disable` : Loans are prohibited - `enable`: Support lending | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/UnifiedDiscount.md: -------------------------------------------------------------------------------- 1 | # UnifiedDiscount 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | [optional] 8 | **DiscountTiers** | [**[]UnifiedDiscountTiers**](UnifiedDiscountTiers.md) | Tiered discount | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UnifiedDiscountTiers.md: -------------------------------------------------------------------------------- 1 | # UnifiedDiscountTiers 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Tier** | **string** | Tier | [optional] 8 | **Discount** | **string** | Discount | [optional] 9 | **LowerLimit** | **string** | Lower limit | [optional] 10 | **UpperLimit** | **string** | Upper limit,+ indicates positive infinity | [optional] 11 | **Leverage** | **string** | Position leverage | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UnifiedHistoryLoanRate.md: -------------------------------------------------------------------------------- 1 | # UnifiedHistoryLoanRate 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | [optional] 8 | **Tier** | **string** | The VIP level of the floating rate required | [optional] 9 | **TierUpRate** | **string** | VIP level corresponding floating rate | [optional] 10 | **Rates** | [**[]UnifiedHistoryLoanRateRates**](UnifiedHistoryLoanRate_rates.md) | Historical interest rate information, one data per hour, the array size is determined by the page and limit parameters provided by the interface request parameters, sorted from recent to far in time | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UnifiedHistoryLoanRateRates.md: -------------------------------------------------------------------------------- 1 | # UnifiedHistoryLoanRateRates 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Time** | **int64** | The hourly timestamp corresponding to the interest rate, in milliseconds | [optional] 8 | **Rate** | **string** | Historical interest rates for this hour | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UnifiedLeverageSetting.md: -------------------------------------------------------------------------------- 1 | # UnifiedLeverageSetting 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | 8 | **Leverage** | **string** | multiple | 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UnifiedLoan.md: -------------------------------------------------------------------------------- 1 | # UnifiedLoan 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency | 8 | **Type** | **string** | type: borrow - borrow, repay - repay | 9 | **Amount** | **string** | The amount of lending or repaying | 10 | **RepaidAll** | **bool** | Full repayment is solely for repayment operations. When set to 'true,' it overrides the 'amount,' allowing for direct full repayment. | [optional] 11 | **Text** | **string** | User defined custom ID | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UnifiedLoanResult.md: -------------------------------------------------------------------------------- 1 | # UnifiedLoanResult 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **TranId** | **int64** | Transaction id | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UnifiedMarginTiers.md: -------------------------------------------------------------------------------- 1 | # UnifiedMarginTiers 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency name | [optional] 8 | **MarginTiers** | [**[]MarginTiers**](MarginTiers.md) | Margin tiers | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UnifiedModeSet.md: -------------------------------------------------------------------------------- 1 | # UnifiedModeSet 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Mode** | **string** | Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single Currency Margin Model | 8 | **Settings** | [**UnifiedSettings**](UnifiedSettings.md) | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UnifiedRiskUnits.md: -------------------------------------------------------------------------------- 1 | # UnifiedRiskUnits 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **UserId** | **int64** | User ID | [optional] 8 | **SpotHedge** | **bool** | Spot hedging status, true - enabled, false - not enabled. | [optional] 9 | **RiskUnits** | [**[]RiskUnits**](RiskUnits.md) | Risk unit | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UnifiedSettings.md: -------------------------------------------------------------------------------- 1 | # UnifiedSettings 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **UsdtFutures** | **bool** | USDT contract switch. In cross-currency margin mode, it can only be turned on and not off | [optional] 8 | **SpotHedge** | **bool** | Spot hedging switch. | [optional] 9 | **UseFunding** | **bool** | switch, when the mode is cross-currency margin mode, whether to use Uniloan financial funds as margin | [optional] 10 | **Options** | **bool** | Option switch. In cross-currency margin mode, it can only be turned on and not off | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UnifiedTransferable.md: -------------------------------------------------------------------------------- 1 | # UnifiedTransferable 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Currency** | **string** | Currency detail | [optional] 8 | **Amount** | **string** | The maximum amount that can be transferred out | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/UserLtvInfo.md: -------------------------------------------------------------------------------- 1 | # UserLtvInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **CollateralCurrency** | **string** | Collateral | [optional] 8 | **BorrowCurrency** | **string** | Borrowed currency | [optional] 9 | **InitLtv** | **string** | The initial collateralization rate | [optional] 10 | **AlertLtv** | **string** | Warning collateralization ratio | [optional] 11 | **LiquidateLtv** | **string** | The liquidation collateralization rate | [optional] 12 | **MinBorrowAmount** | **string** | Minimum borrowable amount for the loan currency | [optional] 13 | **LeftBorrowableAmount** | **string** | Remaining borrowable amount for the loan currency | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/UserSub.md: -------------------------------------------------------------------------------- 1 | # UserSub 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **Uid** | **int64** | User ID | [optional] 8 | **Belong** | **string** | The system to which the user belongs (partner referral). If empty, it means not belonging to any system. | [optional] 9 | **Type** | **int64** | Type (0-not in the system 1-direct subordinate agent 2-indirect subordinate agent 3-direct direct customer 4-indirect direct customer 5-ordinary user) | [optional] 10 | **RefUid** | **int64** | Inviter user ID | [optional] 11 | 12 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/UserSubRelation.md: -------------------------------------------------------------------------------- 1 | # UserSubRelation 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **List** | [**[]UserSub**](UserSub.md) | Subordinate relationship list | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UserTotalAmount.md: -------------------------------------------------------------------------------- 1 | # UserTotalAmount 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **BorrowAmount** | **string** | Total borrowing amount, calculated in USDT | [optional] 8 | **CollateralAmount** | **string** | Total collateral amount, calculated in USDT | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/gateio/gateapi-go/v6 2 | 3 | go 1.12 4 | 5 | require github.com/antihax/optional v1.0.0 6 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/antihax/optional v1.0.0 h1:xK2lYat7ZLaVVcIuj82J8kIro4V6kDe0AUDFboUCwcg= 2 | github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY= 3 | -------------------------------------------------------------------------------- /model_account_detail_key.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // API Key detail 13 | type AccountDetailKey struct { 14 | // mode: 1 - classic account 2 - portfolio margin account 15 | Mode int32 `json:"mode,omitempty"` 16 | } 17 | -------------------------------------------------------------------------------- /model_account_rate_limit.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type AccountRateLimit struct { 13 | // Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#rate-limit-based-on-fill-ratio)) 14 | Tier string `json:"tier,omitempty"` 15 | // Transaction rate 16 | Ratio string `json:"ratio,omitempty"` 17 | // Total transaction ratio of main account 18 | MainRatio string `json:"main_ratio,omitempty"` 19 | // Update time 20 | UpdatedAt string `json:"updated_at,omitempty"` 21 | } 22 | -------------------------------------------------------------------------------- /model_agency_commission_history.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type AgencyCommissionHistory struct { 13 | // Currency pair 14 | CurrencyPair string `json:"currency_pair,omitempty"` 15 | // Total 16 | Total int64 `json:"total,omitempty"` 17 | // List of comission history 18 | List []AgencyCommission `json:"list,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_agency_transaction_history.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type AgencyTransactionHistory struct { 13 | // Currency pair 14 | CurrencyPair string `json:"currency_pair,omitempty"` 15 | // Total 16 | Total int64 `json:"total,omitempty"` 17 | // List of transaction history 18 | List []AgencyTransaction `json:"list,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_auto_repay_setting.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type AutoRepaySetting struct { 13 | // Auto repayment status. `on` - enabled, `off` - disabled 14 | Status string `json:"status,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /model_borrow_currency_info.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type BorrowCurrencyInfo struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // Currency Index Price 16 | IndexPrice string `json:"index_price,omitempty"` 17 | // outstanding principal 18 | LeftRepayPrincipal string `json:"left_repay_principal,omitempty"` 19 | // outstanding interest 20 | LeftRepayInterest string `json:"left_repay_interest,omitempty"` 21 | // Value of left total repayments amount in USDT 22 | LeftRepayUsdt string `json:"left_repay_usdt,omitempty"` 23 | } 24 | -------------------------------------------------------------------------------- /model_broker_commission.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type BrokerCommission struct { 13 | // Total 14 | Total int64 `json:"total,omitempty"` 15 | // List of comission history 16 | List []BrokerCommission1 `json:"list,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_broker_transaction.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type BrokerTransaction struct { 13 | // Total 14 | Total int64 `json:"total,omitempty"` 15 | // List of transaction history 16 | List []BrokerTransaction1 `json:"list,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_collateral_adjust.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type CollateralAdjust struct { 13 | // Order ID 14 | OrderId int64 `json:"order_id"` 15 | // Operation types: append - for adding collateral, redeem - for withdrawing collateral 16 | Type string `json:"type"` 17 | // Collateral Currency List 18 | Collaterals []CollateralCurrency `json:"collaterals,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_collateral_adjust_res.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Result of multi-collateral adjustment 13 | type CollateralAdjustRes struct { 14 | // Order ID 15 | OrderId int64 `json:"order_id,omitempty"` 16 | // Collateral Currency Information 17 | CollateralCurrencies []CollateralCurrencyRes `json:"collateral_currencies,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_collateral_align.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type CollateralAlign struct { 13 | // Order ID 14 | OrderId int64 `json:"order_id"` 15 | // Collateral 16 | CollateralCurrency string `json:"collateral_currency"` 17 | // Collateral amount 18 | CollateralAmount string `json:"collateral_amount"` 19 | // Operation types: append - for adding collateral, redeem - for withdrawing collateral 20 | Type string `json:"type"` 21 | } 22 | -------------------------------------------------------------------------------- /model_collateral_currency.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type CollateralCurrency struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // Size 16 | Amount string `json:"amount,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_collateral_currency_info.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type CollateralCurrencyInfo struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // Currency Index Price 16 | IndexPrice string `json:"index_price,omitempty"` 17 | // Left Collateral Amount 18 | LeftCollateral string `json:"left_collateral,omitempty"` 19 | // Value of left collateral amount in USDT 20 | LeftCollateralUsdt string `json:"left_collateral_usdt,omitempty"` 21 | } 22 | -------------------------------------------------------------------------------- /model_collateral_current_rate.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Multi-currency pledge current interest rate 13 | type CollateralCurrentRate struct { 14 | // Currency 15 | Currency string `json:"currency,omitempty"` 16 | // Currency current interest rate 17 | CurrentRate string `json:"current_rate,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_collateral_fix_rate.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Multi-collateral fixed interest rate 13 | type CollateralFixRate struct { 14 | // Currency 15 | Currency string `json:"currency,omitempty"` 16 | // Fixed interest rate for a lending period of 7 days 17 | Rate7d string `json:"rate_7d,omitempty"` 18 | // Fixed interest rate for a lending period of 30 days 19 | Rate30d string `json:"rate_30d,omitempty"` 20 | // Update time, timestamp, unit in seconds 21 | UpdateTime int64 `json:"update_time,omitempty"` 22 | } 23 | -------------------------------------------------------------------------------- /model_collateral_loan_currency.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Supported borrowing and collateral currencies 13 | type CollateralLoanCurrency struct { 14 | // Borrowed currency 15 | LoanCurrency string `json:"loan_currency,omitempty"` 16 | // List of supported collateral currencies 17 | CollateralCurrency []string `json:"collateral_currency,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_collateral_ltv.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Collateral Ratio 13 | type CollateralLtv struct { 14 | // The initial collateralization rate 15 | InitLtv string `json:"init_ltv,omitempty"` 16 | // Warning collateralization ratio 17 | AlertLtv string `json:"alert_ltv,omitempty"` 18 | // The liquidation collateralization rate 19 | LiquidateLtv string `json:"liquidate_ltv,omitempty"` 20 | } 21 | -------------------------------------------------------------------------------- /model_convert_small_balance.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Convert Small Balance 13 | type ConvertSmallBalance struct { 14 | // Currency 15 | Currency []string `json:"currency,omitempty"` 16 | // Whether to exchange all 17 | IsAll bool `json:"is_all,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_countdown_cancel_all_futures_task.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Countdown cancel task detail 13 | type CountdownCancelAllFuturesTask struct { 14 | // Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown 15 | Timeout int32 `json:"timeout"` 16 | // Futures contract 17 | Contract string `json:"contract,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_countdown_cancel_all_options_task.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Countdown cancel task detail 13 | type CountdownCancelAllOptionsTask struct { 14 | // Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown 15 | Timeout int32 `json:"timeout"` 16 | // Options contract name 17 | Contract string `json:"contract,omitempty"` 18 | // Underlying 19 | Underlying string `json:"underlying,omitempty"` 20 | } 21 | -------------------------------------------------------------------------------- /model_countdown_cancel_all_spot_task.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Countdown cancel task detail 13 | type CountdownCancelAllSpotTask struct { 14 | // Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown 15 | Timeout int32 `json:"timeout"` 16 | // Currency pair 17 | CurrencyPair string `json:"currency_pair,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_create_collateral_order.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type CreateCollateralOrder struct { 13 | // Collateral amount 14 | CollateralAmount string `json:"collateral_amount"` 15 | // Collateral 16 | CollateralCurrency string `json:"collateral_currency"` 17 | // Borrowing amount 18 | BorrowAmount string `json:"borrow_amount"` 19 | // Borrowed currency 20 | BorrowCurrency string `json:"borrow_currency"` 21 | } 22 | -------------------------------------------------------------------------------- /model_create_uni_lend.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Lend or redeem 13 | type CreateUniLend struct { 14 | // Currency name 15 | Currency string `json:"currency"` 16 | // The amount of currency could be lent 17 | Amount string `json:"amount"` 18 | // type: lend - lend, redeem - redeem 19 | Type string `json:"type"` 20 | // The minimum interest rate. If the value is too high, it might lead to the unsuccessful lending and no profit will be gained for that hour. 21 | MinRate string `json:"min_rate,omitempty"` 22 | } 23 | -------------------------------------------------------------------------------- /model_cross_margin_balance_1.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type CrossMarginBalance1 struct { 13 | // Available amount 14 | Available string `json:"available,omitempty"` 15 | // Locked amount 16 | Freeze string `json:"freeze,omitempty"` 17 | // Borrowed amount 18 | Borrowed string `json:"borrowed,omitempty"` 19 | // Unpaid interests 20 | Interest string `json:"interest,omitempty"` 21 | } 22 | -------------------------------------------------------------------------------- /model_cross_margin_repay_request.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type CrossMarginRepayRequest struct { 13 | // Repayment currency 14 | Currency string `json:"currency"` 15 | // Repayment amount 16 | Amount string `json:"amount"` 17 | } 18 | -------------------------------------------------------------------------------- /model_cross_margin_transferable.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type CrossMarginTransferable struct { 13 | // Currency detail 14 | Currency string `json:"currency,omitempty"` 15 | // Max transferable amount 16 | Amount string `json:"amount,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_debit_fee.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type DebitFee struct { 13 | // Whether GT fee discount is used 14 | Enabled bool `json:"enabled"` 15 | } 16 | -------------------------------------------------------------------------------- /model_deposit_address.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type DepositAddress struct { 13 | // Currency detail 14 | Currency string `json:"currency"` 15 | // Deposit address 16 | Address string `json:"address"` 17 | MultichainAddresses []MultiChainAddressItem `json:"multichain_addresses,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_eth2_rate_list.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type Eth2RateList struct { 13 | // Date and Time Stamp 14 | DateTime int64 `json:"date_time,omitempty"` 15 | // Date 16 | Date string `json:"date,omitempty"` 17 | // percentage 18 | Rate string `json:"rate,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_eth2_swap.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // ETH2 Staking 13 | type Eth2Swap struct { 14 | // 1-Forward Swap(ETH -> ETH2), 2-Reverse Swap(ETH2 -> ETH) 15 | Side string `json:"side"` 16 | // amount 17 | Amount string `json:"amount"` 18 | } 19 | -------------------------------------------------------------------------------- /model_funding_rate_record.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type FundingRateRecord struct { 13 | // Unix timestamp in seconds 14 | T int64 `json:"t,omitempty"` 15 | // Funding rate 16 | R string `json:"r,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_future_cancel_order_result.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Order cancellation result 13 | type FutureCancelOrderResult struct { 14 | // Order ID 15 | Id string `json:"id,omitempty"` 16 | // User ID 17 | UserId int64 `json:"user_id,omitempty"` 18 | // Whether cancellation succeeded 19 | Succeeded bool `json:"succeeded,omitempty"` 20 | // Error message when failed to cancel the order; empty if succeeded 21 | Message string `json:"message,omitempty"` 22 | } 23 | -------------------------------------------------------------------------------- /model_futures_fee.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // The returned result is a map type, where the key represents the market and the value represents the taker and maker fee rates. 13 | type FuturesFee struct { 14 | // Taker fee 15 | TakerFee string `json:"taker_fee,omitempty"` 16 | // maker fee 17 | MakerFee string `json:"maker_fee,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_futures_index_constituents.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type FuturesIndexConstituents struct { 13 | // Index name 14 | Index string `json:"index,omitempty"` 15 | // Constituents 16 | Constituents []IndexConstituent `json:"constituents,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_futures_order_book.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type FuturesOrderBook struct { 13 | // Order Book ID. Increases by 1 on every order book change. Set `with_id=true` to include this field in response 14 | Id int64 `json:"id,omitempty"` 15 | // Response data generation timestamp 16 | Current float64 `json:"current,omitempty"` 17 | // Order book changed timestamp 18 | Update float64 `json:"update,omitempty"` 19 | // Asks order depth 20 | Asks []FuturesOrderBookItem `json:"asks"` 21 | // Bids order depth 22 | Bids []FuturesOrderBookItem `json:"bids"` 23 | } 24 | -------------------------------------------------------------------------------- /model_futures_order_book_item.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type FuturesOrderBookItem struct { 13 | // Price (quote currency) 14 | P string `json:"p,omitempty"` 15 | // Size 16 | S int64 `json:"s,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_futures_premium_index.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // data point in every timestamp 13 | type FuturesPremiumIndex struct { 14 | // Unix timestamp in seconds 15 | T float64 `json:"t,omitempty"` 16 | // Close price 17 | C string `json:"c,omitempty"` 18 | // Highest price 19 | H string `json:"h,omitempty"` 20 | // Lowest price` 21 | L string `json:"l,omitempty"` 22 | // Open price 23 | O string `json:"o,omitempty"` 24 | } 25 | -------------------------------------------------------------------------------- /model_index_constituent.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type IndexConstituent struct { 13 | // Exchange 14 | Exchange string `json:"exchange,omitempty"` 15 | // Symbol list 16 | Symbols []string `json:"symbols,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_inline_object.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type InlineObject struct { 13 | // Full position-by-position model, ISOLATED-by-position, CROSS-full position 14 | Mode string `json:"mode"` 15 | // Contract Market 16 | Contract string `json:"contract"` 17 | } 18 | -------------------------------------------------------------------------------- /model_inline_response_200.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type InlineResponse200 struct { 13 | Time int64 `json:"time,omitempty"` 14 | Value string `json:"value,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /model_inline_response_200_1.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type InlineResponse2001 struct { 13 | Currency string `json:"currency,omitempty"` 14 | // Unconverted percentage 15 | EstRate string `json:"est_rate,omitempty"` 16 | } 17 | -------------------------------------------------------------------------------- /model_insurance_record.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type InsuranceRecord struct { 13 | // Unix timestamp in seconds 14 | T int64 `json:"t,omitempty"` 15 | // Insurance balance 16 | B string `json:"b,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_margin_account_currency.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Account currency details 13 | type MarginAccountCurrency struct { 14 | // Currency name 15 | Currency string `json:"currency,omitempty"` 16 | // Amount suitable for margin trading. 17 | Available string `json:"available,omitempty"` 18 | // Locked amount, used in margin trading 19 | Locked string `json:"locked,omitempty"` 20 | // Borrowed amount 21 | Borrowed string `json:"borrowed,omitempty"` 22 | // Unpaid interests 23 | Interest string `json:"interest,omitempty"` 24 | } 25 | -------------------------------------------------------------------------------- /model_margin_leverage_tier.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Market gradient information 13 | type MarginLeverageTier struct { 14 | // Maximum loan limit 15 | UpperLimit string `json:"upper_limit,omitempty"` 16 | // Maintenance margin rate 17 | Mmr string `json:"mmr,omitempty"` 18 | // Maximum leverage multiple 19 | Leverage string `json:"leverage,omitempty"` 20 | } 21 | -------------------------------------------------------------------------------- /model_margin_market_leverage.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Market leverage settings 13 | type MarginMarketLeverage struct { 14 | // Currency pair 15 | CurrencyPair string `json:"currency_pair,omitempty"` 16 | // Position leverage 17 | Leverage string `json:"leverage"` 18 | } 19 | -------------------------------------------------------------------------------- /model_margin_tiers.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type MarginTiers struct { 13 | // Tier 14 | Tier string `json:"tier,omitempty"` 15 | // Discount 16 | MarginRate string `json:"margin_rate,omitempty"` 17 | // Lower limit 18 | LowerLimit string `json:"lower_limit,omitempty"` 19 | // Upper limit, \"\" indicates greater than (the last tier) 20 | UpperLimit string `json:"upper_limit,omitempty"` 21 | // Position leverage 22 | Leverage string `json:"leverage,omitempty"` 23 | } 24 | -------------------------------------------------------------------------------- /model_margin_transferable.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type MarginTransferable struct { 13 | // Currency detail 14 | Currency string `json:"currency,omitempty"` 15 | // Currency pair 16 | CurrencyPair string `json:"currency_pair,omitempty"` 17 | // Max transferable amount 18 | Amount string `json:"amount,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_max_uni_borrowable.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type MaxUniBorrowable struct { 13 | // Currency 14 | Currency string `json:"currency"` 15 | // Currency pair 16 | CurrencyPair string `json:"currency_pair,omitempty"` 17 | // Maximum borrowable 18 | Borrowable string `json:"borrowable"` 19 | } 20 | -------------------------------------------------------------------------------- /model_mock_futures_order.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Futures order 13 | type MockFuturesOrder struct { 14 | // Futures name, currently only supports perpetual futures for BTC and ETH with USDT. 15 | Contract string `json:"contract"` 16 | // Futures quantity, representing the initial order quantity, not involved in actual settlement. 17 | Size string `json:"size"` 18 | // Unfilled contract quantity, involved in actual calculation 19 | Left string `json:"left"` 20 | } 21 | -------------------------------------------------------------------------------- /model_mock_futures_position.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Futures positions 13 | type MockFuturesPosition struct { 14 | // Futures name, currently only supports perpetual futures for BTC and ETH with USDT. 15 | Contract string `json:"contract"` 16 | // Position size, measured in contract units. 17 | Size string `json:"size"` 18 | } 19 | -------------------------------------------------------------------------------- /model_mock_options_order.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Option orders 13 | type MockOptionsOrder struct { 14 | // Option name, currently only supports options for BTC and ETH with USDT. 15 | OptionsName string `json:"options_name"` 16 | // Initial order quantity, not involved in actual calculation 17 | Size string `json:"size"` 18 | // Unfilled contract quantity, involved in actual calculation 19 | Left string `json:"left"` 20 | } 21 | -------------------------------------------------------------------------------- /model_mock_options_position.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Options positions 13 | type MockOptionsPosition struct { 14 | // Option name, currently only supports options for BTC and ETH with USDT. 15 | OptionsName string `json:"options_name"` 16 | // Position size, measured in contract units. 17 | Size string `json:"size"` 18 | } 19 | -------------------------------------------------------------------------------- /model_mock_spot_balance.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Spot 13 | type MockSpotBalance struct { 14 | // Currency name 15 | Currency string `json:"currency"` 16 | // Currency equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports three currencies: BTC, ETH. 17 | Equity string `json:"equity"` 18 | } 19 | -------------------------------------------------------------------------------- /model_multi_collateral_currency.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Borrowing and collateral currencies supported for Multi-Collateral. 13 | type MultiCollateralCurrency struct { 14 | // List of supported borrowing currencies 15 | LoanCurrencies []MultiLoanItem `json:"loan_currencies,omitempty"` 16 | // List of supported collateral currencies 17 | CollateralCurrencies []MultiCollateralItem `json:"collateral_currencies,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_multi_collateral_item.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type MultiCollateralItem struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // Currency Index Price 16 | IndexPrice string `json:"index_price,omitempty"` 17 | // Discount 18 | Discount string `json:"discount,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_multi_loan_item.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type MultiLoanItem struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // Latest price of the currency 16 | Price string `json:"price,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_multi_loan_repay_item.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type MultiLoanRepayItem struct { 13 | // Repayment currency 14 | Currency string `json:"currency,omitempty"` 15 | // Size 16 | Amount string `json:"amount,omitempty"` 17 | // Repayment method, set to true for full repayment, false for partial repayment. 18 | RepaidAll bool `json:"repaid_all,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_multi_repay_resp.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Repay Multi-Collateral Loan 13 | type MultiRepayResp struct { 14 | // Order ID 15 | OrderId int64 `json:"order_id,omitempty"` 16 | // Repay Currency List 17 | RepaidCurrencies []RepayCurrencyRes `json:"repaid_currencies,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_open_orders.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type OpenOrders struct { 13 | // Currency pair 14 | CurrencyPair string `json:"currency_pair,omitempty"` 15 | // The total number of pending orders for this trading pair on the current page 16 | Total int32 `json:"total,omitempty"` 17 | Orders []Order `json:"orders,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_options_position_close.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type OptionsPositionClose struct { 13 | // Position close time 14 | Time float64 `json:"time,omitempty"` 15 | // Options contract name 16 | Contract string `json:"contract,omitempty"` 17 | // Position side, long or short 18 | Side string `json:"side,omitempty"` 19 | // PNL 20 | Pnl string `json:"pnl,omitempty"` 21 | // Text of close order 22 | Text string `json:"text,omitempty"` 23 | // settlement size 24 | SettleSize string `json:"settle_size,omitempty"` 25 | } 26 | -------------------------------------------------------------------------------- /model_options_position_close_order.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Current close order if any, or `null` 13 | type OptionsPositionCloseOrder struct { 14 | // Close order ID 15 | Id int64 `json:"id,omitempty"` 16 | // Close order price (quote currency) 17 | Price string `json:"price,omitempty"` 18 | // Is the close order from liquidation 19 | IsLiq bool `json:"is_liq,omitempty"` 20 | } 21 | -------------------------------------------------------------------------------- /model_options_underlying.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type OptionsUnderlying struct { 13 | // Underlying name 14 | Name string `json:"name,omitempty"` 15 | // Spot index price (quote currency) 16 | IndexPrice string `json:"index_price,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_options_underlying_ticker.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Options underlying detail 13 | type OptionsUnderlyingTicker struct { 14 | // Total put options trades amount in last 24h 15 | TradePut int64 `json:"trade_put,omitempty"` 16 | // Total call options trades amount in last 24h 17 | TradeCall int64 `json:"trade_call,omitempty"` 18 | // Index price (quote currency) 19 | IndexPrice string `json:"index_price,omitempty"` 20 | } 21 | -------------------------------------------------------------------------------- /model_order_resp.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type OrderResp struct { 13 | // Order ID 14 | OrderId int64 `json:"order_id,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /model_partner_commission_history.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type PartnerCommissionHistory struct { 13 | // Total 14 | Total int64 `json:"total,omitempty"` 15 | // List of comission history 16 | List []AgencyCommission `json:"list,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_partner_sub.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type PartnerSub struct { 13 | // User ID 14 | UserId int64 `json:"user_id,omitempty"` 15 | // The time when the user joined the system, in seconds Unix timestamp 16 | UserJoinTime int64 `json:"user_join_time,omitempty"` 17 | // Type (1-Sub-agent 2-Indirect Customer 3-Direct Customer) 18 | Type int64 `json:"type,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_partner_sub_list.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type PartnerSubList struct { 13 | // Total 14 | Total int64 `json:"total,omitempty"` 15 | // Subordinate list 16 | List []PartnerSub `json:"list,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_partner_transaction_history.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type PartnerTransactionHistory struct { 13 | // Total 14 | Total int64 `json:"total,omitempty"` 15 | // List of transaction history 16 | List []AgencyTransaction `json:"list,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_patch_uni_lend.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type PatchUniLend struct { 13 | // Currency name 14 | Currency string `json:"currency,omitempty"` 15 | // Minimum interest rate 16 | MinRate string `json:"min_rate,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_place_dual_investment_order.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Dual Investment order 13 | type PlaceDualInvestmentOrder struct { 14 | // Plan ID 15 | PlanId string `json:"plan_id"` 16 | // Subscription amount, mutually exclusive with the copies field 17 | Amount string `json:"amount"` 18 | // User defined information. If not empty, must follow the rules below: 1. prefixed with `t-` 2. no longer than 28 bytes without `t-` prefix 3. can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) 19 | Text string `json:"text,omitempty"` 20 | } 21 | -------------------------------------------------------------------------------- /model_position_close_order.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Current close order if any, or `null` 13 | type PositionCloseOrder struct { 14 | // Close order ID 15 | Id int64 `json:"id,omitempty"` 16 | // Close order price 17 | Price string `json:"price,omitempty"` 18 | // Is the close order from liquidation 19 | IsLiq bool `json:"is_liq,omitempty"` 20 | } 21 | -------------------------------------------------------------------------------- /model_profit_loss_range.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Profit and loss range 13 | type ProfitLossRange struct { 14 | // Percentage change in price 15 | PricePercentage string `json:"price_percentage,omitempty"` 16 | // Percentage change in implied volatility 17 | ImpliedVolatilityPercentage string `json:"implied_volatility_percentage,omitempty"` 18 | // PNL 19 | ProfitLoss string `json:"profit_loss,omitempty"` 20 | } 21 | -------------------------------------------------------------------------------- /model_rebate_user_info.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Retrieve user rebate information 13 | type RebateUserInfo struct { 14 | // My inviter's UID 15 | InviteUid int64 `json:"invite_uid,omitempty"` 16 | } 17 | -------------------------------------------------------------------------------- /model_repay_loan.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Repay 13 | type RepayLoan struct { 14 | // Order ID 15 | OrderId int64 `json:"order_id"` 16 | // Repayment amount, it is mandatory when making partial repayments 17 | RepayAmount string `json:"repay_amount"` 18 | // Repayment method, set to `true` for full repayment, and `false` for partial repayment; When set to false for partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. 19 | RepaidAll bool `json:"repaid_all"` 20 | } 21 | -------------------------------------------------------------------------------- /model_repay_multi_loan.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Repay Multi-Collateral Loan 13 | type RepayMultiLoan struct { 14 | // Order ID 15 | OrderId int64 `json:"order_id"` 16 | // Repay Currency Item 17 | RepayItems []MultiLoanRepayItem `json:"repay_items"` 18 | } 19 | -------------------------------------------------------------------------------- /model_repay_record_total_interest.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type RepayRecordTotalInterest struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // Currency Index Price 16 | IndexPrice string `json:"index_price,omitempty"` 17 | // Interest Amount 18 | Amount string `json:"amount,omitempty"` 19 | // Interest amount converted to USDT 20 | AmountUsdt string `json:"amount_usdt,omitempty"` 21 | } 22 | -------------------------------------------------------------------------------- /model_repay_resp.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Repay 13 | type RepayResp struct { 14 | // Principal 15 | RepaidPrincipal string `json:"repaid_principal,omitempty"` 16 | // Interest 17 | RepaidInterest string `json:"repaid_interest,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_saved_address.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SavedAddress struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // Chain name 16 | Chain string `json:"chain,omitempty"` 17 | // Address 18 | Address string `json:"address,omitempty"` 19 | // Name 20 | Name string `json:"name,omitempty"` 21 | // Tag 22 | Tag string `json:"tag,omitempty"` 23 | // Whether to pass the verification 0-unverified, 1-verified 24 | Verified string `json:"verified,omitempty"` 25 | } 26 | -------------------------------------------------------------------------------- /model_small_balance.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Convert Small Balance 13 | type SmallBalance struct { 14 | // Currency 15 | Currency string `json:"currency,omitempty"` 16 | // Available balance 17 | AvailableBalance string `json:"available_balance,omitempty"` 18 | // Estimated as BTC 19 | EstimatedAsBtc string `json:"estimated_as_btc,omitempty"` 20 | // Estimated conversion to GT 21 | ConvertibleToGt string `json:"convertible_to_gt,omitempty"` 22 | } 23 | -------------------------------------------------------------------------------- /model_small_balance_history.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Convert Small Balance 13 | type SmallBalanceHistory struct { 14 | // Order ID 15 | Id string `json:"id,omitempty"` 16 | // Currency 17 | Currency string `json:"currency,omitempty"` 18 | // amount 19 | Amount string `json:"amount,omitempty"` 20 | // GT amount 21 | GtAmount string `json:"gt_amount,omitempty"` 22 | // Exchange time (in seconds) 23 | CreateTime int64 `json:"create_time,omitempty"` 24 | } 25 | -------------------------------------------------------------------------------- /model_spot_account.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SpotAccount struct { 13 | // Currency detail 14 | Currency string `json:"currency,omitempty"` 15 | // Available amount 16 | Available string `json:"available,omitempty"` 17 | // Locked amount, used in trading 18 | Locked string `json:"locked,omitempty"` 19 | // Version number 20 | UpdateId int64 `json:"update_id,omitempty"` 21 | } 22 | -------------------------------------------------------------------------------- /model_spot_currency_chain.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SpotCurrencyChain struct { 13 | // Chain name 14 | Name string `json:"name,omitempty"` 15 | // token address 16 | Addr string `json:"addr,omitempty"` 17 | // Whether currency's withdrawal is disabled 18 | WithdrawDisabled bool `json:"withdraw_disabled,omitempty"` 19 | // Whether currency's withdrawal is delayed 20 | WithdrawDelayed bool `json:"withdraw_delayed,omitempty"` 21 | // Whether currency's deposit is disabled 22 | DepositDisabled bool `json:"deposit_disabled,omitempty"` 23 | } 24 | -------------------------------------------------------------------------------- /model_spot_insurance_history.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SpotInsuranceHistory struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // balance 16 | Balance string `json:"balance,omitempty"` 17 | // Creation time, timestamp, milliseconds 18 | Time int64 `json:"time,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_spot_price_trigger.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SpotPriceTrigger struct { 13 | // Trigger price 14 | Price string `json:"price"` 15 | // Price trigger condition - >=: triggered when market price larger than or equal to `price` field - <=: triggered when market price less than or equal to `price` field 16 | Rule string `json:"rule"` 17 | // How long (in seconds) to wait for the condition to be triggered before cancelling the order. 18 | Expiration int32 `json:"expiration"` 19 | } 20 | -------------------------------------------------------------------------------- /model_stp_group.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type StpGroup struct { 13 | // STP Group ID 14 | Id int64 `json:"id,omitempty"` 15 | // STP Group name 16 | Name string `json:"name"` 17 | // Creator ID 18 | CreatorId int64 `json:"creator_id,omitempty"` 19 | // Creation time 20 | CreateTime int64 `json:"create_time,omitempty"` 21 | } 22 | -------------------------------------------------------------------------------- /model_stp_group_user.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type StpGroupUser struct { 13 | // User ID 14 | UserId int64 `json:"user_id,omitempty"` 15 | // STP Group ID 16 | StpId int64 `json:"stp_id,omitempty"` 17 | // Creation time 18 | CreateTime int64 `json:"create_time,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_structured_buy.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Dual Investment Purchase 13 | type StructuredBuy struct { 14 | // Plan ID 15 | Pid string `json:"pid,omitempty"` 16 | // Purchase Amount 17 | Amount string `json:"amount,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_sub_account_balance.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SubAccountBalance struct { 13 | // User ID 14 | Uid string `json:"uid,omitempty"` 15 | // Available balances of currencies 16 | Available map[string]string `json:"available,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_sub_account_cross_margin_balance.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SubAccountCrossMarginBalance struct { 13 | // User ID 14 | Uid string `json:"uid,omitempty"` 15 | // 账户余额信息 16 | Available SubCrossMarginAccount `json:"available,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_sub_account_futures_balance.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SubAccountFuturesBalance struct { 13 | // User ID 14 | Uid string `json:"uid,omitempty"` 15 | // Futures account balances 16 | Available map[string]FuturesAccount `json:"available,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_sub_account_key_perms.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SubAccountKeyPerms struct { 13 | // Permission function name (no value will be cleared) - wallet: wallet - spot: spot/leverage - futures: perpetual contract - delivery: delivery contract - earn: financial management - custody: custody - options: options - account: account information - loan: loan - margin: leverage - unified: unified account - copy: copy 14 | Name string `json:"name,omitempty"` 15 | // read only 16 | ReadOnly bool `json:"read_only,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_sub_account_margin_balance.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SubAccountMarginBalance struct { 13 | // User ID 14 | Uid string `json:"uid,omitempty"` 15 | // Margin account balances 16 | Available []MarginAccount `json:"available,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_sub_user_mode.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SubUserMode struct { 13 | // User ID 14 | UserId int64 `json:"user_id,omitempty"` 15 | // Is it a unified account? 16 | IsUnified bool `json:"is_unified,omitempty"` 17 | // Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode 18 | Mode string `json:"mode,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_system_time.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type SystemTime struct { 13 | // Server current time(ms) 14 | ServerTime int64 `json:"server_time,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /model_total_balance.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // User's balance in all accounts 13 | type TotalBalance struct { 14 | Total AccountBalance `json:"total,omitempty"` 15 | // Total balances in different accounts - cross_margin: cross margin account - spot: spot account - finance: finance account - margin: margin account - quant: quant account - futures: futures account - delivery: delivery account - warrant: warrant account - cbbc: cbbc account 16 | Details map[string]AccountBalance `json:"details,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_transaction_id.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type TransactionId struct { 13 | // Order id 14 | TxId int64 `json:"tx_id,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /model_transfer_order_status.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type TransferOrderStatus struct { 13 | // Order id 14 | TxId string `json:"tx_id,omitempty"` 15 | // Transfer status, PENDING - in process, SUCCESS - successful transfer, FAIL - failed transfer, PARTIAL_SUCCESS - Partially successful (this status will appear when transferring between sub-subs) 16 | Status string `json:"status,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_transferables_result.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Batch query unified account can be transferred up to a maximum of results 13 | type TransferablesResult struct { 14 | // Currency detail 15 | Currency string `json:"currency,omitempty"` 16 | // The maximum amount that can be transferred out 17 | Amount string `json:"amount,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_trigger_order_response.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type TriggerOrderResponse struct { 13 | // Auto order ID 14 | Id int64 `json:"id,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /model_trigger_time.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type TriggerTime struct { 13 | // Timestamp of the end of the countdown, in milliseconds 14 | TriggerTime int64 `json:"triggerTime,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /model_uid_push_withdrawal.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UidPushWithdrawal struct { 13 | // Recipient UID 14 | ReceiveUid int64 `json:"receive_uid"` 15 | // Currency name 16 | Currency string `json:"currency"` 17 | // Transfer amount 18 | Amount string `json:"amount"` 19 | } 20 | -------------------------------------------------------------------------------- /model_uid_push_withdrawal_resp.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UidPushWithdrawalResp struct { 13 | // Order ID 14 | Id int64 `json:"id,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /model_uni_currency.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Currency detail 13 | type UniCurrency struct { 14 | // Currency name 15 | Currency string `json:"currency,omitempty"` 16 | // The minimum lending amount, in the unit of the currency. 17 | MinLendAmount string `json:"min_lend_amount,omitempty"` 18 | // The total maximum lending amount, in USDT 19 | MaxLendAmount string `json:"max_lend_amount,omitempty"` 20 | // Maximum rate (Hourly) 21 | MaxRate string `json:"max_rate,omitempty"` 22 | // Minimum rate (Hourly) 23 | MinRate string `json:"min_rate,omitempty"` 24 | } 25 | -------------------------------------------------------------------------------- /model_uni_currency_interest.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UniCurrencyInterest struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment 16 | InterestStatus string `json:"interest_status,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_uni_currency_pair.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Currency pair of the loan 13 | type UniCurrencyPair struct { 14 | // Currency pair 15 | CurrencyPair string `json:"currency_pair,omitempty"` 16 | // Minimum borrow amount of base currency 17 | BaseMinBorrowAmount string `json:"base_min_borrow_amount,omitempty"` 18 | // Minimum borrow amount of quote currency 19 | QuoteMinBorrowAmount string `json:"quote_min_borrow_amount,omitempty"` 20 | // Position leverage 21 | Leverage string `json:"leverage,omitempty"` 22 | } 23 | -------------------------------------------------------------------------------- /model_uni_interest_mode.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Lend & Earn interest reinvestment toggle 13 | type UniInterestMode struct { 14 | // Currency 15 | Currency string `json:"currency"` 16 | // Interest toggle settings, true - interest reinvestment, false - regular dividend 17 | Status bool `json:"status"` 18 | } 19 | -------------------------------------------------------------------------------- /model_uni_lend_interest.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UniLendInterest struct { 13 | // Currency 14 | Currency string `json:"currency,omitempty"` 15 | // Interest 16 | Interest string `json:"interest,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_uni_loan.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Loan 13 | type UniLoan struct { 14 | // Currency 15 | Currency string `json:"currency,omitempty"` 16 | // Currency pair 17 | CurrencyPair string `json:"currency_pair,omitempty"` 18 | // amount 19 | Amount string `json:"amount,omitempty"` 20 | // Loan type, platform - platform, margin - margin 21 | Type string `json:"type,omitempty"` 22 | // Created time 23 | CreateTime int64 `json:"create_time,omitempty"` 24 | // Updated time 25 | UpdateTime int64 `json:"update_time,omitempty"` 26 | } 27 | -------------------------------------------------------------------------------- /model_uni_loan_record.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Loan records 13 | type UniLoanRecord struct { 14 | // type: borrow - borrow, repay - repay 15 | Type string `json:"type,omitempty"` 16 | // Currency pair 17 | CurrencyPair string `json:"currency_pair,omitempty"` 18 | // Currency 19 | Currency string `json:"currency,omitempty"` 20 | // The amount of lending or repaying 21 | Amount string `json:"amount,omitempty"` 22 | // Created time 23 | CreateTime int64 `json:"create_time,omitempty"` 24 | } 25 | -------------------------------------------------------------------------------- /model_unified_borrowable.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UnifiedBorrowable struct { 13 | // Currency detail 14 | Currency string `json:"currency,omitempty"` 15 | // Max borrowable amount 16 | Amount string `json:"amount,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_unified_borrowable_1.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Batch query unified account can be borrowed up to a maximum of results 13 | type UnifiedBorrowable1 struct { 14 | // Currency detail 15 | Currency string `json:"currency,omitempty"` 16 | // The maximum amount to borrow 17 | Amount string `json:"amount,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_unified_discount.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Currency discount tiers 13 | type UnifiedDiscount struct { 14 | // Currency name 15 | Currency string `json:"currency,omitempty"` 16 | // Tiered discount 17 | DiscountTiers []UnifiedDiscountTiers `json:"discount_tiers,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_unified_discount_tiers.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UnifiedDiscountTiers struct { 13 | // Tier 14 | Tier string `json:"tier,omitempty"` 15 | // Discount 16 | Discount string `json:"discount,omitempty"` 17 | // Lower limit 18 | LowerLimit string `json:"lower_limit,omitempty"` 19 | // Upper limit,+ indicates positive infinity 20 | UpperLimit string `json:"upper_limit,omitempty"` 21 | // Position leverage 22 | Leverage string `json:"leverage,omitempty"` 23 | } 24 | -------------------------------------------------------------------------------- /model_unified_history_loan_rate_rates.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UnifiedHistoryLoanRateRates struct { 13 | // The hourly timestamp corresponding to the interest rate, in milliseconds 14 | Time int64 `json:"time,omitempty"` 15 | // Historical interest rates for this hour 16 | Rate string `json:"rate,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_unified_leverage_setting.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Loan currency leverage 13 | type UnifiedLeverageSetting struct { 14 | // Currency name 15 | Currency string `json:"currency"` 16 | // multiple 17 | Leverage string `json:"leverage"` 18 | } 19 | -------------------------------------------------------------------------------- /model_unified_loan_result.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Unified account loan and repayment response results 13 | type UnifiedLoanResult struct { 14 | // Transaction id 15 | TranId int64 `json:"tran_id,omitempty"` 16 | } 17 | -------------------------------------------------------------------------------- /model_unified_margin_tiers.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Unified margin tiers 13 | type UnifiedMarginTiers struct { 14 | // Currency name 15 | Currency string `json:"currency,omitempty"` 16 | // Margin tiers 17 | MarginTiers []MarginTiers `json:"margin_tiers,omitempty"` 18 | } 19 | -------------------------------------------------------------------------------- /model_unified_mode_set.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UnifiedModeSet struct { 13 | // Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single Currency Margin Model 14 | Mode string `json:"mode"` 15 | Settings UnifiedSettings `json:"settings,omitempty"` 16 | } 17 | -------------------------------------------------------------------------------- /model_unified_risk_units.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UnifiedRiskUnits struct { 13 | // User ID 14 | UserId int64 `json:"user_id,omitempty"` 15 | // Spot hedging status, true - enabled, false - not enabled. 16 | SpotHedge bool `json:"spot_hedge,omitempty"` 17 | // Risk unit 18 | RiskUnits []RiskUnits `json:"risk_units,omitempty"` 19 | } 20 | -------------------------------------------------------------------------------- /model_unified_transferable.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UnifiedTransferable struct { 13 | // Currency detail 14 | Currency string `json:"currency,omitempty"` 15 | // The maximum amount that can be transferred out 16 | Amount string `json:"amount,omitempty"` 17 | } 18 | -------------------------------------------------------------------------------- /model_user_sub.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UserSub struct { 13 | // User ID 14 | Uid int64 `json:"uid,omitempty"` 15 | // The system to which the user belongs (partner referral). If empty, it means not belonging to any system. 16 | Belong string `json:"belong,omitempty"` 17 | // Type (0-not in the system 1-direct subordinate agent 2-indirect subordinate agent 3-direct direct customer 4-indirect direct customer 5-ordinary user) 18 | Type int64 `json:"type,omitempty"` 19 | // Inviter user ID 20 | RefUid int64 `json:"ref_uid,omitempty"` 21 | } 22 | -------------------------------------------------------------------------------- /model_user_sub_relation.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | type UserSubRelation struct { 13 | // Subordinate relationship list 14 | List []UserSub `json:"list,omitempty"` 15 | } 16 | -------------------------------------------------------------------------------- /model_user_total_amount.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Gate API v4 3 | * 4 | * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. 5 | * 6 | * Contact: support@mail.gate.io 7 | * Generated by: OpenAPI Generator (https://openapi-generator.tech) 8 | */ 9 | 10 | package gateapi 11 | 12 | // Total borrowed amount and pledged collateral amount by the user 13 | type UserTotalAmount struct { 14 | // Total borrowing amount, calculated in USDT 15 | BorrowAmount string `json:"borrow_amount,omitempty"` 16 | // Total collateral amount, calculated in USDT 17 | CollateralAmount string `json:"collateral_amount,omitempty"` 18 | } 19 | --------------------------------------------------------------------------------