Categorygithub.com/edgex-Tech/edgex-golang-sdkopenapi
package
0.0.0-20250123082229-28fe17da2ab0
Repository: https://github.com/edgex-tech/edgex-golang-sdk.git
Documentation: pkg.go.dev
Overview
Dependencies
20
Dependents
9

# README

Go API client for openapi

Contains interface documents such as accounts, assets, transactions, etc.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v1.0.0
  • Package version: 1.0.0
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value openapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value openapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api-docs.edgex.exchange

ClassMethodHTTP requestDescription
DefaultApiCreateApiCredentialGet /api/createApiCredential根据signature派生ApiCredential的验证接口
CMCPublicApiAPIGetContractSpecificationsGet /api/v1/public/cmc/getContractSpecificationsEndpoint B2 (Contract specifications)
CMCPublicApiAPIGetContractsGet /api/v1/public/cmc/getContractsEndpoint B1 (Contracts)
CMCPublicApiAPIGetOrderBookGet /api/v1/public/cmc/getOrderBookEndpoint B3 (Order book)
Class00AppPublicApiAPIGetAppUpdateGet /api/v1/public/app/checkAppUpdate获取APP升级信息
Class00MetaDataPublicApiAPIGetMetaDataGet /api/v1/public/meta/getMetaData获取元信息数据
Class00MetaDataPublicApiAPIGetServerTimeGet /api/v1/public/meta/getServerTime获取服务器时间
Class00StarkExPublicApiAPIReceiveAlternativeTxPost /api/v1/public/starkex/receiveAlternativeTx通知交易拒绝
Class011inchPublicControllerAPIGetAggregateExchangeDataGet /api/v1/public/1inch/getAggregateExchangeData获取币对兑换汇率
Class011inchPublicControllerAPIGetQuotaGet /api/v1/public/1inch/getQuota获取币对兑换汇率
Class01FundingPublicApiAPIGetFundingRatePageGet /api/v1/public/funding/getFundingRatePage根据合约id分页查询资金费率历史
Class01FundingPublicApiAPIGetLatestFundingRateGet /api/v1/public/funding/getLatestFundingRate根据合约id查询最新资金费率
Class01IndexPublicApiAPIForcePushPricePost /api/v1/public/index/forcePushPrice按照某个指定价格作为预言机价格推送(仅测试时使用)
Class01IndexPublicApiAPIGetIndexPriceConfigGet /api/v1/public/index/getIndexPriceConfig根据合约id查询指数价格配置
Class01QuotePublicApiAPIGetAccurateOpenInterestGet /api/v1/public/quote/getAccurateOpenInterest获取精确OpenInterest
Class01QuotePublicApiAPIGetDepthGet /api/v1/public/quote/getDepth查询盘口深度
Class01QuotePublicApiAPIGetExchangeLongShortRatioGet /api/v1/public/quote/getExchangeLongShortRatio获取日交易统计
Class01QuotePublicApiAPIGetKlineGet /api/v1/public/quote/getKline查询K线
Class01QuotePublicApiAPIGetMultiContractKlineGet /api/v1/public/quote/getMultiContractKline查询多合约定量K线
Class01QuotePublicApiAPIGetStatDayTradeGet /api/v1/public/quote/getStatDayTrade获取日交易统计
Class01QuotePublicApiAPIGetTickerGet /api/v1/public/quote/getTicker查询24小时行情
Class01QuotePublicApiAPIGetTicketSummaryGet /api/v1/public/quote/getTicketSummary获取行情汇总
Class02UserPublicApiAPICheckUserExistGet /api/v1/public/user/checkUserExist判断用户是否存在
Class02UserPublicApiAPIGetAppScanSecretGet /api/v1/public/user/getAppScanSecret获取AppScanSecret
Class02UserPublicApiAPIOnboardSitePost /api/v1/public/user/onboardSite用户登录站点
Class02UserPublicApiAPIVerifyEmailPost /api/v1/public/user/verifyEmail验证邮箱
Class03AccountPrivateApiAPIGetAccountAssetGet /api/v1/private/account/getAccountAsset获取账户资产相关数据
Class03AccountPrivateApiAPIGetAccountAssetSnapshotPageGet /api/v1/private/account/getAccountAssetSnapshotPage根据账号id翻页获取历史资产快照
Class03AccountPrivateApiAPIGetAccountByIdGet /api/v1/private/account/getAccountById根据账户id获取账户信息
Class03AccountPrivateApiAPIGetAccountDeleverageLightGet /api/v1/private/account/getAccountDeleverageLight获取账户下所有仓位减仓ADL灯
Class03AccountPrivateApiAPIGetAccountPageGet /api/v1/private/account/getAccountPage根据用户id翻页获取账户信息
Class03AccountPrivateApiAPIGetCollateralByCoinIdGet /api/v1/private/account/getPositionByContractId根据账号id和合约id批量获取仓位
Class03AccountPrivateApiAPIGetCollateralByCoinId1Get /api/v1/private/account/getCollateralByCoinId根据账号id和抵押品coinId批量获取抵押品信息
Class03AccountPrivateApiAPIGetCollateralTransactionByIdGet /api/v1/private/account/getCollateralTransactionById根据账户id和抵押品明细id批量获取成抵押品明细
Class03AccountPrivateApiAPIGetCollateralTransactionPageGet /api/v1/private/account/getCollateralTransactionPage根据账户id翻页获取抵押品明细
Class03AccountPrivateApiAPIGetPositionTermPageGet /api/v1/private/account/getPositionTermPage根据账号id翻页获取持仓term信息
Class03AccountPrivateApiAPIGetPositionTransactionByIdGet /api/v1/private/account/getPositionTransactionById根据账户id和仓位流水id批量获取仓位流水
Class03AccountPrivateApiAPIGetPositionTransactionPageGet /api/v1/private/account/getPositionTransactionPage翻页获取仓位流水
Class03AccountPrivateApiAPIRegisterAccountPost /api/v1/private/account/registerAccount注册账户
Class03AccountPrivateApiAPIUpdateLeverageSettingPost /api/v1/private/account/updateLeverageSetting更新账户交易杠杆设置
Class04OrderPrivateApiAPICancelAllOrderPost /api/v1/private/order/cancelAllOrder取消账户下所有委托单
Class04OrderPrivateApiAPICancelOrderByClientOrderIdPost /api/v1/private/order/cancelOrderByClientOrderId根据clientId取消委托单
Class04OrderPrivateApiAPICancelOrderByIdPost /api/v1/private/order/cancelOrderById根据委托单id取消委托单
Class04OrderPrivateApiAPICreateOrderPost /api/v1/private/order/createOrder创建委托单
Class04OrderPrivateApiAPIGetActiveOrderPageGet /api/v1/private/order/getActiveOrderPage分页获取账户下活动的委托单
Class04OrderPrivateApiAPIGetHistoryOrderByClientOrderIdGet /api/v1/private/order/getHistoryOrderByClientOrderId根据账户id和委托单id批量获取委托单
Class04OrderPrivateApiAPIGetHistoryOrderByIdGet /api/v1/private/order/getHistoryOrderById根据账户id和委托单id批量获取委托单
Class04OrderPrivateApiAPIGetHistoryOrderFillTransactionByIdGet /api/v1/private/order/getHistoryOrderFillTransactionById根据账户id和委托成交明细id批量获取委托成交明细
Class04OrderPrivateApiAPIGetHistoryOrderFillTransactionPageGet /api/v1/private/order/getHistoryOrderFillTransactionPage根据账户id和委托单ids批量获取成交单
Class04OrderPrivateApiAPIGetHistoryOrderPageGet /api/v1/private/order/getHistoryOrderPage根据账户id翻页获取委托单
Class04OrderPrivateApiAPIGetMaxCreateOrderSizePost /api/v1/private/order/getMaxCreateOrderSize获取最大下单数量
Class04OrderPrivateApiAPIGetOrderByClientOrderIdGet /api/v1/private/order/getOrderByClientOrderId根据客户id批量获取委托单
Class04OrderPrivateApiAPIGetOrderByIdGet /api/v1/private/order/getOrderById根据账户id和委托单id批量获取委托单
Class05DepositPrivateApiAPICreateDepositPost /api/v1/private/deposit/createDeposit创建充值单
Class05DepositPrivateApiAPIGetActiveDepositGet /api/v1/private/deposit/getActiveDeposit翻页获取充值单
Class05DepositPrivateApiAPIGetDepositByClientDepositIdGet /api/v1/private/deposit/getDepositByClientDepositId根据账户id和充值单clientId批量获取充值单
Class05DepositPrivateApiAPIGetDepositByIdGet /api/v1/private/deposit/getDepositById根据充值单id批量获取充值单
Class05DepositPrivateApiAPIRequestRelayerSignAndBroadcastPost /api/v1/private/deposit/requestRelayerSignAndBroadcast创建 Relayer 充值单
Class06WithdrawPrivateApiAPICreateWithdrawPost /api/v1/private/withdraw/createWithdraw创建提现单
Class06WithdrawPrivateApiAPIGetActiveWithdrawGet /api/v1/private/withdraw/getActiveWithdraw翻页获取提现单
Class06WithdrawPrivateApiAPIGetWithdrawAvailableAmountGet /api/v1/private/withdraw/getWithdrawAvailableAmount翻页获取提现单
Class06WithdrawPrivateApiAPIGetWithdrawByClientWithdrawIdGet /api/v1/private/withdraw/getWithdrawByClientWithdrawId根据充值单id批量获取提现单
Class06WithdrawPrivateApiAPIGetWithdrawByIdGet /api/v1/private/withdraw/getWithdrawById根据充值单id批量获取提现单
Class07TransferPrivateApiAPICreateTransferOutPost /api/v1/private/transfer/createTransferOut创建委托单
Class07TransferPrivateApiAPIGetActiveTransferInGet /api/v1/private/transfer/getActiveTransferIn翻页获取转入单
Class07TransferPrivateApiAPIGetActiveTransferOutGet /api/v1/private/transfer/getActiveTransferOut翻页获取转出单
Class07TransferPrivateApiAPIGetTransferInByIdGet /api/v1/private/transfer/getTransferInById根据充值单id批量获取转入单
Class07TransferPrivateApiAPIGetTransferOutByIdGet /api/v1/private/transfer/getTransferOutById根据充值单id批量获取转出单
Class07TransferPrivateApiAPIGetWithdrawAvailableAmount1Get /api/v1/private/transfer/getTransferOutAvailableAmount翻页获取提现单
Class08UserPrivateApiAPICheckUserNicknameExistGet /api/v1/private/user/checkUserNicknameExist检查用户昵称是否存在
Class08UserPrivateApiAPIClaimFaucetCoinGet /api/v1/private/user/claimFaucetCoin领取水龙头体验代币
Class08UserPrivateApiAPICreateAppScanSecretPost /api/v1/private/user/createAppScanSecret创建AppScanSecret
Class08UserPrivateApiAPICreatePushConfigPost /api/v1/private/user/createPushConfig添加push配置
Class08UserPrivateApiAPIGetFaucetCoinClaimPageGet /api/v1/private/user/getFaucetCoinClaimPage分页获取水龙头领取记录
Class08UserPrivateApiAPIGetSiteMessagePageGet /api/v1/private/user/getSiteMessagePage分页获取站内信
Class08UserPrivateApiAPIGetUserByIdGet /api/v1/private/user/getUser根据id获取用户信息
Class08UserPrivateApiAPIGetUserInfoGet /api/v1/private/user/getUserInfo根据id获取用户信息和用户设置设置
Class08UserPrivateApiAPIGetUserPreferenceGet /api/v1/private/user/getUserPreference根据id获取用户设置
Class08UserPrivateApiAPIReadSiteMessagePost /api/v1/private/user/readSiteMessage标识阅读站内信消息
Class08UserPrivateApiAPISendEmailVerificationPost /api/v1/private/user/sendEmailVerification(重新)发送邮箱验证
Class08UserPrivateApiAPIUpdateUserPost /api/v1/private/user/updateUser更新用户信息
Class08UserPrivateApiAPIUpdateUserPreferencePost /api/v1/private/user/updateUserPreference更新用户设置
Class09AssetsPrivateApiAPICreateCrossWithdrawPost /api/v1/private/assets/createCrossWithdraw创建快速提现单
Class09AssetsPrivateApiAPICreateFastWithdrawPost /api/v1/private/assets/createFastWithdraw创建快速提现单
Class09AssetsPrivateApiAPICreateNormalWithdrawPost /api/v1/private/assets/createNormalWithdraw创建普通提现单
Class09AssetsPrivateApiAPIGetAllOrdersPageGet /api/v1/private/assets/getAllOrdersPage聚合查询所有充提币订单记录
Class09AssetsPrivateApiAPIGetCoinRateGet /api/v1/private/assets/getCoinRate聚合查询所有充提币订单记录
Class09AssetsPrivateApiAPIGetCrossWithdrawByIdGet /api/v1/private/assets/getCrossWithdrawById根据账户id和提现单id批量获取跨链提现单
Class09AssetsPrivateApiAPIGetCrossWithdrawSignInfoGet /api/v1/private/assets/getCrossWithdrawSignInfo查询跨链提现签名需要的信息
Class09AssetsPrivateApiAPIGetFastWithdrawByIdGet /api/v1/private/assets/getFastWithdrawById根据账户id和提现单id批量获取快速提现单
Class09AssetsPrivateApiAPIGetFastWithdrawSignInfoGet /api/v1/private/assets/getFastWithdrawSignInfo查询快速提现签名需要的信息
Class09AssetsPrivateApiAPIGetNormalWithdrawByIdGet /api/v1/private/assets/getNormalWithdrawById根据账户id和提现单id批量获取普通提现单
Class09AssetsPrivateApiAPIGetNormalWithdrawableAmountGet /api/v1/private/assets/getNormalWithdrawableAmount查询用户普通提现可提金额

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author