# Gate API v4 v4.70.0

    下方有示例代码,请求和返回示例。 点击上方的语言 tab 来切换各语言的代码示例。

    欢迎使用 Gate.io API

    APIv4 接口提供了现货、杠杆、合约交易相关的操作,包括公共接口查询市场行情,以及需要认证的私有接口, 实现基于 API 的自动交易。

    # 访问链接

    REST API BaseURL:

    • 实盘交易: https://api.gateio.ws/api/v4
    • 合约模拟交易: https://fx-api-testnet.gateio.ws/api/v4
    • 合约实盘交易备选入口(只适用合约 API):https://fx-api.gateio.ws/api/v4

    # SDK

    可用 SDK:

    部分 SDK 除了各接口的示例文档以外,还额外提供了调用 SDK 的示例应用程序。 示例应用程序提供了一个相对更加丰富的 SDK 使用示例,可以完整构建运行, 具体使用方式参考各 SDK 的示例程序说明

    # 关于APIv4 Key升级

    2020 年 4 月

    APIv4 最开始合约的 Key 与现货的是分开管理的。不过从现在开始我们对 APIv4 的 Key 进行了升级改造。 用户现在可以创建多个 Key,而且可以为每个 Key 配置不同的操作权限。比如你可以创建一个 Key 同时拥有现货的读写和合约的读写权限,这样的话只需要一个 Key 就可以同时操作现货和合约交易。

    用户原有的 Key 会无缝迁移到新的管理方案,原先的 Key 在新的管理模式下,对应一个 Key 只配置了现货的权限,另一个 Key 只配置了合约的权限,用户可以使用新的管理模式对迁移后的 Key 重新配置权限。

    # 与 APIv2 的区别

    APIv4 是一套全新的 HTTP REST API ,独立于 APIv2 。APIv4 提供了完整的交易功能,增强了 API 的认证鉴权。另外 APIv4 基于 OpenAPI 标准 (opens new window) 书写,SDK 和文档通过同一套 API 标准生成,确保文档和程序的完整一致。

    APIv4 与 APIv2 在使用上有如下区别:

    1. 两者的 API Key 是独立的。 APIv2 在个人账户的 APIKeys 入口申请。而 APIv4 在个人账户的 APIv4Keys 页面申请。
    2. APIv2 在交易操作上只支持现货交易,APIv4 支持现货、杠杆和合约的完整交易操作

    如何选择:

    1. 如果需要杠杆或合约交易,选择 APIv4
    2. 如果只需要现货交易或者钱包操作,则根据个人当前状况自行选择

    # 市商申请

    为进一步提高平台盘口深度和交易流动性,我们将通过公开透明的方式招募机构做市商,根据为平台流动性做出的贡献情况,为专业机构做市商提供专业的做市商手续费率方案。

    1. 提供 Gateio UID
    2. 提供他所交易量截图或VIP等级等
    3. 简述做市方法及规模

    提供以上内容提交至 [email protected] ,我们将在3个工作日内受理。

    TIP

    VIP11及以上需在个人中心开启GT抵扣,才可享有专业市商费率。

    # 技术支持

    使用过程中如有问题或者建议,您可以选择以下任意方式联系我们:

    • 提交工单反馈
    • 在线工单反馈
    • 将您的联系方式与问题发送至 [email protected] ,我们将为您分配技术专员为您服务

    如您遇到API错误,建议您整理以下内容,方便我们为您快速分析问题:

    1. 问题描述
    2. Gateio UID
    3. 请求的地址与参数
    4. 错误代码
    5. 返回结果

    DANGER

    即使是提交问题,也切勿将API key信息提交给客服及他人,否则会有严重的资产风险。如果已经不小心泄漏,请将已有API删除并重新生成。

    # Changelog

    v4.70.0

    2024-04-08

    • GET /futures/{settle}/positions接口,返回值增加 pnl_pnlpnl_fundpnl_fee字段
    • GET /futures/{settle}/position_close接口,返回值增加 pnl_pnlpnl_fundpnl_fee字段

    v4.69.0

    2024-03-25

    • POST /delivery/{settle}/price_orders接口,返回值增加 text 字段

    v4.68.0

    2024-03-18

    • 新增 GET /unified/currency_discount_tiers 接口,查询统一账户梯度式discount
    • GET /unified/loans接口,新增 type 查询字段,返回值增加 type 字段
    • GET /unified/interest_records接口,新增 type 查询字段,返回值增加 type 字段

    v4.67.0

    2024-03-11

    • POST /spot/orders,POST /spot/batch_orders接口,返回值增加 filled_amount 字段
    • 限频规则中,钱包提现接口限速描述,由10r/10s更正为1r/3s(并无修改原本限流行为)

    v4.66.1

    2024-02-19

    • 新增 GET /wallet/small_balance 接口,获取可兑换的小额币种清单
    • 新增 GET /wallet/small_balance_history 接口,获取可兑换的小额币种历史纪录
    • 新增 GET /unified/estimate_rate 接口,查询统一账户的预估利率

    v4.65.0

    2024-01-29

    • GET /spot/batch_fee 接口,返回值增加 debit_fee 字段
    • DELETE /account/stp_groups/{stp_id}/users 接口,新增 user_id 请求字段
    • 现货API下单增加异步支持模式,ACK,RESULT,FULL,详情请见SPOT API

    v4.64.0

    2024-01-22

    • GET /loan/multi_collateral/orders 接口,新增 order_type 查询字段
    • GET /loan/multi_collateral/orders 接口,返回值增加 order_type,fixed_type,fixed_rate,expire_time,auto_renew,auto_repay 字段
    • GET /loan/multi_collateral/repay 接口,返回值增加before_ltv,after_ltv 字段
    • 新增 GET /loan/multi_collateral/fixed_rate 接口,查询币种7日固定利率和30日固定利率
    • GET /wallet/total_balance 接口,返回值增加unrealised_pnl,borrowed 字段

    v4.63.0

    2024-01-15

    • GET /wallet/currency_chains 接口,返回值增加 decimal 字段
    • 新增 GET /futures/{settle}/risk_limit_tiers 接口,查询风险限额等级

    v4.62.0

    2024-01-02

    • 新增 POST /futures/{settle}/batch_cancel_orders 接口,用户可批量撤销订单
    • 新增多币质押API (/loan/multi_collateral/**)

    v4.61.0

    2023-12-18

    • GET /rebate/broker/commission_historyGET /rebate/broker/commission_history 接口,新增经纪商获取返佣记录

    v4.60.0

    2023-12-01

    • 新的 Unified API 已经上线, 旧的 /portfoli/* 接口已被弃用 (2023-12-31 移除)
    • 新增理财产品 API (/earn/**)
    • GET /futures/{settle}/account_book 接口,返回值增加 trade_id 字段

    v4.59.0

    2023-11-22

    • GET /futures/{settle}/contracts 接口,返回值增加 funding_cap_ratio 字段
    • GET /delivery/{settle}/account_book 接口,返回值增加 contract 字段
    • GET /wallet/withdraw_status 接口,返回值增加 withdraw_percent_on_chains 字段
    • GET /portfolio/accounts 接口,返回值增加 leverage 字段

    v4.58.0

    2023-11-03

    • GET /margin/cross/currencies 接口,返回值增加 loanable 字段
    • GET /futures/{settle}/orders/{order_id} 接口, 返回值新增 biz_info 字段
    • GET /account/detail 接口, 返回值新增 tier 字段
    • GET /spot/currency_pairs 接口, 返回值新增 max_base_amountmax_quote_amount 字段

    v4.57.0

    2023-10-20

    • 新增进出网关时间记录,详情参考网关入出站时间
    • POST /spot/orders 接口,新增支持保证金帐户类型
    • GET /spot/trades 接口,返回值新增 sequence_id 字段
    • GET /spot/account_book 接口,返回值新增 text 字段
    • GET /spot/my_trades 接口,返回值新增 text 字段
    • 新增 POST /spot/amend_batch_orders 接口,用户可以批量修改订单
    • 新增 PUT /earn/uni/interest_reinvest 接口,用户可以设置利息复投开关
    • GET /portfolio/spot/ordersGET /portfolio/spot/ordersGET /portfolio/spot/orders/{order_id}DELETE /portfolio/spot/orders/{order_id} and PATCH /portfolio/spot/orders/{order_id} 这些接口将被弃用, 我们预计在十月底移除这些接口的支持, 用户可以转用 /spot/orders 相关接口来替代

    v4.56.0

    2023-09-25

    • GET /margin/cross/repaymentsGET /portfolio/loan_records 接口,新增 repayment_type 字段
    • GET /futures/{settle}/positions 接口, 请求参数新增 holding 字段
    • GET /futures/{settle}/my_trades_timerange 接口, 请求参数新增 role 字段
    • GET /futures/{settle}/position_close 接口, 请求参数新增 side and pnl 字段

    v4.55.0

    2023-09-12

    • 新增 POST /portfolio/account_mode 接口,新增模式切换

    v4.54.0

    2023-08-28

    • GET /wallet/currency_chains 接口,新增 contract_address 字段
    • GET /portfolio/spot/currency_pairsGET /portfolio/spot/currency_pairs/{currency_pair},新增查询保证金现货市场列表

    v4.53.0

    2023-08-14

    • DELETE /account/stp_groups/{stp_id}/users,新增删除 STP Group 用户接口

    v4.52.0

    2023-08-07

    • 新增抵押借币相关 API

    v4.51.0

    2023-07-29

    v4.50.0

    2023-07-14

    • 新增保证金账户体系相关的API,目前服务只对白名单用户开放,有兴趣的用户可以聯繫機構部門
    • 新增 GET /flash_swap/currency_pairs 接口,查询支持闪兑的所有交易对列表

    v4.49.0

    2023-07-03

    • 新增新版限频规则 ,新版预计于 2023-07-10 (utc+8) 开始生效
    • GET /futures/{settle}/orders接口,调整请求字段 contract 改为非必填

    v4.48.0

    2023-06-16

    • GET /wallet/sub_account_transfers接口,新增 client_order_id 请求字段

    v4.47.0

    2023-05-23

    • GET /margin/uni/estimate_rateGET /margin/cross/estimate_rate,新增全仓和逐仓借贷利率查询接口
    • GET /futures/{settle}/orders_timerange,新增查询合约历史订单列表(时间区间)接口
    • GET /options/positions/{contract}接口,新增 underlyingunderlying_pricemark_ivdeltagammavegatheta 等字段
    • 新增 STP Group 管理 API 接口

    v4.46.0

    2023-05-08

    • GET /spot/account_book,新增查询现货账户变动历史接口
    • GET /futures/{settle}/fee,新增查询合约市场交易费率接口
    • GET /futures/{settle}/trades接口,新增 is_internal 字段

    v4.45.0

    2023-04-21

    • 逐仓借贷迁移到余币宝,详细资讯可参考逐仓迁移说明
    • GET /margin/cross/interest_records 接口,新增全仓账户扣息记录
    • GET /margin/cross/account_book 接口,新增 futures_infutures_out 两种帐户变更类型
    • POST /futures/{settle}/batch_orders 接口,新增 STP 功能

    v4.44.0

    2023-04-07

    • 新增 ORDER_BOOK_NOT_FOUNDFAILED_RETRIEVE_ASSETS 错误信息

    v4.43.0

    2023-03-27

    • 现货下单接口,新增 Self-Trade Prevention 功能,详细资讯可参考STP介绍
    • GET /account/detail,新增查询 API Key 的 IP 白名单接口
    • PATCH /spot/orders/{order_id} 接口,新增 amend_text 字段
    • GET /futures/{settle}/tickers 接口,新增 lowest_askhighest_bid 字段

    v4.42.0

    2023-03-13

    • 新增余币宝接口
    • 合约下单接口,新增 Self-Trade Prevention 功能,详细资讯可参考STP介绍
    • POST /wallet/sub_account_transfers 接口,新增 交割合约账户 类型支持
    • PUT /futures/{settle}/orders/{order_id} 接口,新增 amend_text 字段

    v4.41.0

    2023-03-03

    • GET /margin/cross/accounts 接口,新增 negative_liab, futures_pos_liab, equity, total_freeze, total_liab, portfolio_margin_total_liab, portfolio_margin_total_equity 字段

    v4.40.0

    2023-02-24

    • GET /futures/{settle}/candlesticks 接口,新增 sum 字段
    • GET /futures/{settle}/auto_deleverages 接口,新增查询ADL自动减仓订单信息

    v4.39.0

    2023-02-09

    • GET /spot/batch_fee 接口,新增批量查询账户费率接口
    • GET /futures/{settle}/contracts 接口,新增 enable_bonusenable_credit 字段

    v4.38.0

    2023-02-04

    • GET /futures/{settle}/my_trades_timerange 接口,新增时间范围查询合約成交记录接口
    • POST /withdrawals 接口,新增 withdraw_order_id 字段

    v4.37.0

    2023-01-20

    • 新增查询反佣相关接口

    v4.36.0

    2022-12-23

    • POST /spot/ordersPOST /spot/batch_orders 接口,下单的时候 iceberg 字段不再支持全部订单隐藏

    v4.35.0

    2022-12-09

    • GET /spot/orders 接口, 新增订单平均价格字段
    • PATCH /spot/orders/{order_id} 接口, 新增订单修改单
    • GET /margin/cross/accounts 接口, 新增 portfolio_margin_total 字段
    • POST /spot/batch_orders 接口, 新增现货市价单类型

    v4.34.0

    2022-11-25

    • POST /spot/orders 接口, 现货下单增加市价单

    v4.33.0

    2022-11-11

    • K 线图接口 GET /futures/{settle}/premium_index
    • 创建子帐号的时候可以指定密码与 Eamil

    v4.32.0

    2022-10-28

    • 优化期权API文档

    v4.31.0

    2022-10-14

    • POST /wallet/sub_account_to_sub_account 子帐号划转接口,新增合约与全仓杠杆划转

    v4.30.0

    2022-09-23

    • 新增管理子帐号 API Key 接口
    • 新增子帐号冻结与解冻接口
    • POST /wallet/sub_account_to_sub_account 接口,新增子帐号与子帐号划转

    v4.29.0

    2022-09-09

    • 新增创建、查询子帐号功能
    • GET /wallet/fee 接口,新增 settle 查询字段
    • 期权订单新增 refr 字段
    • 创建 API Key 数量上限调整至 20

    v4.28.0

    2022-08-12

    • GET /futures/{settle}/trades 接口,新增 offset 查询字段
    • 新增现货与合约的定时取消订单接口

    v4.27.0

    2022-07-29

    • GET /delivery/{settle}/tickers 接口,新增 basis_ratebasis_value 两个字段
    • 新增 X-Client-Request-Id 请求 ID header,可以用来追踪请求
    • 新增合约批量下单接口,POST /futures/{settle}/batch_orders
    • 新增合约交易下单FOK订单类型

    v4.26.0

    2022-07-15

    • 现货自动单支持统一帐户
    • 新增 GET /wallet/saved_address 接口,获取提币白名单地址
    • POST /wallet/transfers 接口,支援操作单号返回
    • 新增 GET /wallet/sub_account_cross_margin_balances 接口,查询子账号全仓杠杆账户余额信息
    • GET /margin/currency_pairs 接口、新增 status 字段

    v4.25.1

    2022-07-06

    • 新增 GET /spot/time 获取服务器当前时间接口
    • 获取交易对 ticker 信息 GET /spot/tickers,新增 change_utc0, change_utc8 字段
    • 新增 GET /options/my_settlements 查询期权个人结算记录接口

    v4.25.0

    2022-06-24

    • 支持统一帐户 API
    • 全仓账户增加多个返回字段,详细请查看接口描述
    • 全仓币种增加返回字段 status,判断全仓币种是否禁用 0-禁用 1-启用
    • 现货交易增加接口POST /spot/cross_liquidate_orders,处理全仓币种禁用时平仓买入下单
    • 获取合约账号接口新增 bonus 理财金字段和 history 累计统计数据字段
    • 合约个人成交记录新增 text 订单的自定义信息,fee 成交手续费,point_fee成交点卡手续费等字段
    • 订正撤销单个自动单名称
    • POST /wallet/sub_account_transfers 支持划转到全仓杠杆账户

    v4.24.0

    2022-05-20

    • 新增 /flash_swap 闪兑 API ,支持直接通过 API 方式进行闪兑操作,接口组关联现货权限
    • 钱包新增 GET /wallet/sub_account_margin_balances , GET /wallet/sub_account_futures_balances 接口,方便主账号查询子账号的逐仓杠杆账户和永续合约账户的余额信息
    • 永续合约新增 API GET /futures/{settle}/index_constituents/{index} 查询指数来源信息
    • 修复合约自动订单 FuturesPriceTriggeredOrder 缺少 order_type 等字段的定义

    v4.23.4

    2022-04-25

    • 永续合约新增订单修改接口 PUT /futures/{settle}/orders/{order_id}
    • 现货 K 线查询支持 30d 粒度

    v4.23.3

    2022-04-01

    1. 现货 K 线增加基础货币成交量返回
    2. 现货币种信息返回增加该币所在链的信息
    3. 钱包接口 GET /wallet/currency_chains 增加币种的充提状态返回
    4. 永续合约双仓模式下增加缺失的全仓杠杆 cross_leverage_limit 参数
    5. 永续、交割合约查询 K 线新增多个时间粒度的支持

    v4.23.2

    2022-01-21

    1. 提现充值历史增加 fee 字段返回
    2. 现货 Currency 币种模型增加固定费率

    v4.23.1

    2021-12-23

    1. 现货下单 time_in_force 增加新类型 FOK
    2. 新增错误代码 FOK_NOT_FILL

    v4.23.0

    2021-12-09

    1. 新增期权 API
    2. 新增详细的限速规则说明
    3. 新增 GET /wallet/currency_chains 查询币种支持的链
    4. 提现充值历史增加新的 status 可选值

    v4.22.4

    2021-11-01

    1. SpotPriceTriggeredOrder 字段 ctimeftime 更正为 int64

    v4.22.3

    2021-10-27

    1. GET /spot/trades 支持指定 fromto 按时间范围筛选的查询

    v4.22.2

    2021-09-29

    1. 提现充值记录新增 status 字段的可选值
    2. 合约下单新增 auto_size 只写字段用于双向持仓模式的平仓操作

    v4.22.1

    2021-09-07

    1. 新增钱包接口 GET /wallet/total_balance 获取用户总资产
    2. 逐仓杠杆账户返回增加lockedrisk 字段
    3. 逐仓和全仓杠杆借入支持输入自定义 text

    v4.22.0

    2021-08-13

    1. 交割合约支持 BTC 结算
    2. 现货 API GET /spot/ordersGET /spot/my_trades 支持按时间范围筛选
    3. 逐仓和全仓支持查询用户最大借入额度

    v4.21.6

    2021-08-12

    1. 修复 GET /wallet/deposit_address 地址链字段错误名称

    v4.21.5

    2021-06-30

    • 针对已结束的单子, GET /spot/orders, GET /spot/orders/{order_id} 以及 GET /spot/my_trades 接口可以不用指定 currency_pair 参数
    • GET /wallet/withdraw_status 返回增加多链的固定提现手续费返回
    • 新增 GET /margin/transferable and GET /margin/cross/transferable API 查询逐仓和全仓账户允许的最大转出额度
    • 合约平仓历史 API 新增 fromto 的时间范围查询参数

    v4.21.4

    2021-06-23

    • 新增全仓杠杆账户变动历史查询 GET /margin/cross/account_book
    • 逐仓账户历史 GET /margin/account_book 返回增加毫秒时间戳

    v4.21.3

    2021-06-17

    • 现货、合约深度增加时间戳返回

    v4.21.2

    2021-06-07

    • 合约 API 新增对全仓杠杆调整的支持
    • 新增 /margin/cross 全仓杠杆 API
    • 新增现货下单对全仓杠杆账户的支持
    • 逐仓杠杆账户查询返回新增账户未还利息
    • 现货订单信息新增 create_time_msupdate_time_ms 毫秒时间返回
    • 新增取消提现接口 DELETE /withdrawals/{withdrawal_id}

    v4.20.1

    2021-04-14

    • 更新文档部分链接

    v4.20.0

    2021-03-25

    • 增加现货自动订单接口组 /spot/price_orders

    v4.19.6

    2021-03-22

    • 现货交易对查询增加开盘时间返回

    v4.19.5

    2021-03-18

    • 指定订单 ID 的现货、永续合约操作支持使用用户自定义 ID(只在订单创建后的 30 分钟内有效)。

    v4.19.4

    2021-03-10

    • /wallet/sub_account_transfers 接口支持转账到子账户的合约账户

    v4.19.3

    2021-03-04

    • 新增杠杆借贷自动还款设置和查询接口 /margin/auto_repay
    • /wallet/deposit_address 接口新增 multichain_address 字段,返回某些币种的多充值地址
    • 优化部分文档内容

    v4.19.2

    2021-03-01

    • 新增 /wallet/fee 接口用于查询交易费率,原有 /spot/fee 接口废弃
    • 提现操作增加 chain 字段
    • 合约深度查询 /futures/{settle}/order_book 增加 with_id 字段的说明,返回内容增加深度 ID 的说明
    • 合约个人平仓历史查询 /futures/{settle}/position_close 增加 offset 参数,用于翻页获取历史平仓记录
    • 增加合约价值的计算方法说明,具体参考 Contract 模型的描述
    • 修复合约统计数据字段类型错误

    v4.18.4

    2021-01-22

    • 现货 Trade 模型新增 create_time_ms 字段
    • ETF 交易对 Ticker 增加净值等相关信息返回

    v4.18.1

    2021-01-07

    • 现货下单新增冰山委托支持
    • 修复 /futures/{settle}/contract_stats 返回数据的错误字段类型

    v4.18.0

    2020-12-21

    • 现货新增 /spot/currencies/spot/currencies/{currency} 查询币种信息
    • 合约 ContractStat 返回新增 top_lsr_accounttop_lsr_size 等多个字段

    v4.17.1

    2020-12-16

    • /spot/order_book 接口 limit 字段最大值增加到 100

    v4.17.0

    2020-12-15

    • 新增子账号余额查询接口 /wallet/sub_account_balances

    v4.16.1

    2020-12-10

    • 修复 Position 模型定义里的错误字段名称 dual_mode 。正确应该是 mode

    v4.16.0

    2020-12-09

    现货

    • POST /spot/batch_orders 每个交易对可以创建的 order 数量提高到 10 个
    • 现货 GET /spot/trades 新增 reverse 参数支持时间逆序查询历史记录

    合约

    • 永续合约新增双仓支持 API ,/futures/{settle}/dual_mode 接口设置是否开启双仓。 双仓相关的仓位操作参照 /futures/{settle}/dual_comp/positions 接口组
    • 永续合约账户返回新增 in_dual_mode ,仓位返回新增 dual_mode
    • 永续合约新增 /futures/{settle}/liq_orders 支持查询市场强平记录

    v4.15.5

    2020-11-04

    • 新增 API /futures/{settle}/contract_stats 获取合约统计信息
    • 新增 API /margin/{currency_pair} 获取单个杠杆交易对详情

    v4.15.4

    2020-09-01

    • GET /spot/fee 接口返回新增 point_type 字段
    • 新增 API GET /wallet/withdraw_status
    • 新增了 C# SDK 入口

    v4.15.2

    2020-08-12

    • 新增 GET /spot/fee 获取个人现货交易费率

    v4.15.1

    2020-08-04

    • 新增获取现货市场所有当前委托 GET /spot/open_orders
    • 新增杠杆账户余额变更历史 GET /margin/account_book

    v4.14.1

    2020-07-08

    • 订单里的 text 字段最大允许长度提高到了 28 个字节(不包括前缀)

    v4.14.0

    2020-07-06

    • 交割合约引擎 API /delivery 上线

    v4.13.1

    2020-06-28

    • 新增 GET /wallet/sub_account_transfers 接口查询主子账号划转历史

    v4.13.0

    2020-05-20

    • 增加了对提现操作的支持,详情关注 POST /withdrawals 接口和“认证”一节
    • 账户划转 POST /wallet/transfers 支持现货到合约了。
    • 钱包接口新增了提现充值历史记录查询
    • 合约订单和个人成交列表支持传入 offset 参数
    • 合约 Contract 模型添加新字段 in_delisting

    v4.12.0

    2020-04-08

    • 升级 APIv4 的 Key ,不再按功能独立 Key,每个 Key 都可以独立配置多个功能的权限, 详细说明参考 “关于 APIv4 Key 升级” 一节
    • 新增接口 POST /wallet/sub_account_transfers 支持主子账号余额划转
    • GET /spot/candlesticks 增加请求参数 fromto ,方便获取历史数据

    v4.11.2

    2020-03-29

    • Order 模型增加字段 filled_total 替换命名容易引起误解的 fill_price
    • 添加新的错误码标识 POC_FILL_IMMEDIATELY

    v4.11.1

    2020-03-23

    • 个人成交记录 GET /spot/my_trades 返回增加 role 交易角色信息
    • 修复查询币币理财账户 GET /margin/funding_accounts 缺少未使用过理财的币种的问题

    v4.11.0

    2020-03-20

    • 现货下单支持 GT 抵扣费率折扣
    • 现货下单 Time in force 支持传入 poc

    v4.10.1

    2020-02-24

    • 现货交易对新增字段 trade_status

    v4.10.0

    2020-02-17

    • 杠杆下单支持传入 auto_borrow 字段(只写),在余额不足时由系统自动借入不足部分
    • 增加指定订单 ID 的批量撤单接口 POST /spot/cancel_batch_orders
    • 补充“错误处理”和“与 APIv2 的区别”文档

    v4.9.1

    2020-01-07

    • OrderBatchOrder 新增订单最近修改时间、成交费率的返回
    • GET /spot/my_trades 增加成交费率返回

    v4.9.0

    2019-12-17

    • GET /futures/{settle}/trades 不再支持 last_id 参数,改用 fromto 来获取历史成交

    v4.8.2

    2019-12-02

    • 新增 /spot/batch_orders 支持现货和杠杆的批量下单操作
    • 杠杆还款产生的手续费率支持用户等级折扣
    • Loan 模型里增加了 fee_rate 字段标识杠杆借出单的手续费率,orig_id 标识续借单的原始借出单 ID

    v4.8.1

    2019-11-27

    • 修复 GET /futures/{settle}/positions 文档和代码示例缺少 settle 字段的说明和使用

    v4.8.0

    2019-11-07

    • 合约 API 支持以 USDT 结算
    • 原有的以 /futures 为前缀的所有接口前缀统一调整为 /futures/{settle} ,以支持基于多种结算货币的合约操作。
    • /futures/{settle}/accounts 返回的账户信息里 currency 增加 USDT 的返回
    • /futures/{setttle}/tickers 返回的交易量信息新增 volume_24h_base, volume_24h_quotevolume_24h_settle 字段,取代原有 volume_24h_btcvolume_24h_usd 的使用。 后两个字段为了兼容依然保留,但是新的操作不推荐继续使用。

    /futures 替换成 /futures/usdt 就可以使用 USDT 结算的合约操作, 例如 GET /futures/usdt/accounts 能够获取 USDT 的合约账户,而 GET /futures/btc/accounts 则是用来获取 BTC 的合约账户。

    为了保持兼容, 原有的 GET /futures/xxx 的 API 都会默认为 BTC GET /futures/btc/xxx 。如 GET /futures/accounts 会被服务默认按 GET /futures/btc/accounts 请求来处理

    v4.7.3

    2019-07-18

    • 现货、合约下单增加 text ,支持用户自定义信息

    v4.6.3

    2019-06-11

    • 合约账户和仓位信息里增加点卡相关信息

    v4.7.2

    2019-05-29

    • 理财借出 Loanrate 字段调整为非必选

    v4.7.1

    2019-04-17

    • 新增 wallet v4 API ,目前仅支持现货与杠杆账户转账操作
    • GET /margin/loans 接口支持按 rate 排序,支持可选 currency_pair 输入
    • 修复各种文档问题

    v4.6.2

    2019-04-24

    • 修复合约价格单文档覆盖了普通合约单接口 GET /futures/orders/{order_id}DELETE /futures/orders/{order_id} 的文档

    v4.6.1

    2019-04-02

    • 合约 Ticker 返回新增字段 high_24hlow_24hfunding_rate_indicative

    v4.6.0

    2019-03-21

    只影响 SDK

    • 修改合约相关的下单函数名,防止在 Go SDK 中与现货下单冲突
    • 修复验签时没有对请求参数做 decode 的问题

    v4.5.2

    2019-03-14

    • /spot/order_book 的参数 currency_pair 应为必选
    • 优化代码示例

    v4.5.1

    2019-03-11

    • 修复缺少 URL 参数的说明

    v4.5.0

    为了避免引起版本混乱,APIv4 此后的版本统一以 4 作为大版本号开头(包括文档和 SDK)

    2019-03-05

    • 新增现货 v4 API,在原有 API 基础之上提供更多功能
    • 新增杠杆 v4 API,提供杠杆借贷功能;杠杆交易API 复用现货 v4 交易API
    • 提供合约止盈止损自动单 API 支持,详情见 /futures/price_orders 一组接口
    • 实盘交易统一 APIv4 统一 Base URL 到 https://api.gateio.ws/api/v4

    v1.3.0

    2019-02-13

    重要更新

    • base URLs 域名更新为 fx-api.gateio.wsfx-api-testnet.gateio.ws 原有 *.gateio.io 已废弃

    v1.2.1

    2019-02-13

    • 合约 Ticker 接口返回增加 volumn_24h_usdvolume_24h_btc

    v1.2.0

    2019-01-17

    • 新增 GET /futures/contracts/{contract} 查询单个合约
    • 新增 GET /futures/positions/{contract} 查询单个合约的仓位
    • 新增 GET /futures/account_book 查询用户合约账户历史
    • Contract 模型新增 config_change_time 字段
    • 修复各种文档问题

    v1.1.0

    2019-01-08

    • Contract, Position, FuturesOrder 模型增加更多参数
    • 新增 API GET /futures/position_close 获取平仓记录
    • API GET /futures/my_trades 增加可选参数 order_id 支持
    • DELETE /futures/ordersDELETE /futures/orders/{order_id} 返回状态码从 204 改为 200, 并在请求成功后返回撤销的订单列表
    • DELETE /futures/orders/{order_id} 对无效订单不忽略错误,改为返回 404
    • POST /futures/orders 支持 POC 和冰山委托

    v1.0.0

    2018-12-30

    • 初次发布

    # General

    # 匹配机制

    # 匹配优先级

    Gate.io 订单匹配遵循 价格优先 > 时间优先 的原则

    假设订单簿情况如下:

    订单 下单时间 Ask/卖价
    A 10:00 100
    B 10:00 102
    C 10:01 100

    如果 10:02 分 的现价买单 102,最终成交顺序为: A、C、B

    # 订单生命周期

    发送到匹配引擎的有效订单会立即被接受,并跟已有挂单进行匹配,然后将匹配结果返回给客户端。

    匹配结果若是完全执行,则订单结束。若结果是不执行或部分执行,TimeInForce 为 IOC 的订单会立即结束; 其他情况的订单,则被挂在相应价格订单队尾,等待被匹配或者被撤销。

    # 数据中心

    Gate.io 数据中心位于 AWS 日本东京 (ap-northeast-1) 地区。

    # 接口概览

    接口分类 分类链接 概述
    host + /api/v4/spot/* 现货交易 包含币种状态、行情信息、下单、成交记录等功能
    host + /api/v4/margin/* 杠杆交易 杠杆账户管理、借贷、还款等
    host + /api/v4/futures/* 永续合约交易 永续合约账户管理、行情信息、下单、成交记录等功能
    host + /api/v4/delivery/* 交割合约交易 交割合约账户管理、行情信息、下单、成交记录等功能
    host + /api/v4/options/* 期权交易 期权账户管理、行情信息、下单、成交记录等功能
    host + /api/v4/wallet/* 钱包管理 充提记录、查询余额、资金划转等
    host + /api/v4/withdrawals/* 提现 数字货币提现

    # 逐仓迁移说明

    平台于 2023 年 4 月 13 日 14:00(UTC+8)到 2023 年 4 月 23 日 14:00(UTC+8)期间陆续对币币理财市场中未被借贷的资产进行系统自动迁移,迁移至余币宝市场,同时也会对已经被借贷出去的资产进行取消自动放贷处理,迁移完成后您可到余币宝市场中,查看您的理财详情。在此期间将暂停通过币币理财借出资金,您也可以手动将资产从币币理财转到余币宝市场,提前获得理财收益。
    自动迁移后老版本的借贷接口将被弃用,新版借贷使用/margin/uni接口组,详细的接口迁移可以参考下表

    逐仓杠杆账户相关接口:

    接口名称 路径 接口是否下线 新路径
    杠杆账户列表 GET /margin/accounts -
    查询杠杆账户变动历史 GET /margin/account_book -
    理财账户列表 GET /margin/funding_accounts -
    修改用户自动还款设置 POST /margin/auto_repay -
    查询用户自动还款设置 GET /margin/auto_repay -
    逐仓杠杆允许的最大转出 GET /margin/transferable -

    逐仓杠杆借贷相关接口(迁移至/margin/uni接口组):

    接口名称 路径 接口是否下线 新路径
    查询支持杠杆交易的所有交易对 GET /margin/currency_pairs GET /margin/uni/currency_pairs
    查询单个杠杆交易对 GET /margin/currency_pairs/{currency_pair} GET /margin/uni/currency_pairs/{currency_pair}
    借入或借出 POST /margin/loans POST /margin/uni/loans
    查询借贷订单详情 GET /margin/loans/{loan_id} -
    查询借贷订单列表 GET /margin/loans GET /margin/uni/loans
    归还借贷 POST /margin/loans/{loan_id}/repayment POST /margin/uni/loans
    查询借贷归还记录 GET /margin/loans/{loan_id}/repayment GET /margin/uni/loan_records
    逐仓杠杆用户最多可借入 GET /margin/borrowable GET /margin/uni/borrowable
    查询扣息记录 - - GET /margin/uni/interest_records

    理财相关接口(迁移至/earn/uni接口组):

    接口名称 路径 接口是否下线 新路径
    查询支持杠杆交易的所有交易对 GET /margin/currency_pairs GET /earn/uni/currencies
    查询单个杠杆交易对 GET /margin/currency_pairs/{currency_pair} GET /earn/uni/currencies/{currency}
    借入或借出 POST /margin/loans POST /earn/uni/lends
    查询借贷订单列表 GET /margin/loans GET /earn/uni/lends
    借出市场的深度 GET /margin/funding_book -
    合并多个借贷订单 POST /margin/merged_loans -
    修改借贷订单 PATCH /margin/loans/{loan_id} PATCH /earn/uni/lends
    撤销借出贷款订单 DELETE /margin/loans/{loan_id} POST /earn/uni/lends
    查看某个借贷订单的借出记录 GET /margin/loan_records GET /earn/uni/lend_records
    查看单个借出记录 GET /margin/loan_records/{loan_record_id} -
    修改单个借出记录 PATCH /margin/loan_records/{loan_record_id} -
    查询用户派息记录 - - GET /earn/uni/interest_records

    # API

    # HTTP 通用格式

    • 所有读操作都是 GET 方法,只接受请求参数,不读取任何请求体。
    • DELETE 方法移除指定资源(如委托),但因为 DELETE 方法也不读取任何请求体, 并不是所有移除操作都是用 DELETE 方法。复杂的移除操作通过 POST 方法配合请求体来实现。
    • 更新操作使用 POST, PUTPATCH 方法,不同的请求有不同的参数传递方式, 但是他们要么是通过请求体,要么是请求参数,不会二者混用。
    • 所有操作成功时都会返回 HTTP 状态码 2xx401 说明认证有问题。其他 4xx 状态码说明请求无效。 如果是 5xx 错误,则是服务端处理请求时遇上了未知的严重错误,碰到的话请第一时间反馈。

    # 时间

    所有时间字段,如果没有额外说明,格式都是级的 Unix 时间戳,但是返回的格式可能不同 int64, number 或者 string ),示例值如:

    • 1596531048
    • "1596531048"
    • 1596531048.285
    • "1596531048.285"

    最佳方式是按有小数点的 number 去解析 (string 需要实现转换)。 如果不需要高精度, 再强转成整数(或长整形)。上面的 SDK 会对不同格式的时间字段按照相应格式做好反序列化处理。

    # 网关入出站时间

    每次请求API响应头(response header)中都会包含如下字段:

    • X-In-Time: API网关接收请求时的时间戳,格式:Unix的时间戳,单位微秒

    • X-Out-Time: API网关返回响应时的时间戳,格式:Unix的时间戳,单位微秒

    例如:

    X-In-Time: 1695715091540163
    X-Out-Time: 1695715091551905
    

    # 分页

    分页的实现有如下两种方式:

    • page, limit 方式
    • limit, offset 方式

    这两种方式里,limit 字段都是用来限制单次请求里列表返回的最大数量。没有特殊说明的情况下, 它的默认值是 100 ,最大允许 1000

    page 方式类似于网页的翻页,从 1 开始计数。遍历完整列表的方法是使用同一个 limit,每次请求将 page 加 1,直到返回的列表长度小于 limit

    offset 方式类似于数据库检索,遍历完整列表的方式是每次累加 limitoffset 上, 直到返回的列表长度小于 limit

    举例说明,如果订单总数是 201 个。使用 page-limit 方式,请求参数可以按照如下发送:

    1. page=1&limit=100
    2. page=2&limit=100
    3. page=3&limit=100

    如果使用 limit-offset 方法,则是:

    1. limit=100&offset=0
    2. limit=100&offset=100
    3. limit=100&offset=200

    有一些请求可能会返回额外的分页元数据信息。这些元数据信息都存储在返回头部。以 GET /futures/{settle}/orders 为例,这个请求会在返回头部追加如下分页元数据信息:

    • X-Pagination-Limit: 请求指定的 limit 参数
    • X-Pagination-Offset: 请求指定的 offset 参数
    • X-Pagination-Total: 满足条件的所有条目总数

    # 限频规则

    市场 入口 限速 依据 包含
    公共接口 公共接口 单个接口 200r/10s IP 深度、K线、交易对信息等
    钱包 私有接口 提现接口(POST /withdrawals) 1r/3s
    交易账户互转接口 (POST /wallet/transfers) 80r/10s
    主子账号互转 (POST /wallet/sub_account_transfers) 80r/10s
    子账号与子帐号互转 (POST /wallet/sub_account_to_sub_account) 80r/10s
    查询个人账户总额 (GET /wallet/total_balance) 80r/10s
    查询子账号余额信息 (GET /wallet/sub_account_balances) 80r/10s
    查询子账号逐仓杠杆账户余额信息 (GET /wallet/sub_account_margin_balances) 80r/10s
    查询子账号永续合约账户余额信息 (GET /wallet/sub_account_futures_balances) 80r/10s
    查询子账号全仓杠杆账户余额信息 (GET /wallet/sub_account_cross_margin_balances) 80r/10s
    钱包其他单个接口 200r/10s
    UID 提现
    个人账户余额查询
    子账户余额查询
    现货 私有接口 现货批量/单个下单/单个修改接口一共订单数 10r/s (uid+市场)
    现货批量/单个撤单接口一共 200r/s
    现货其他单个接口 200r/10s
    UID 现货下单、撤单
    成交历史、费率查询等
    永续合约 私有接口 合约批量/单个下单/修改单个订单接口一共 100r/s
    合约批量/单个撤单接口一共 200r/s
    永续合约其他单个接口 200r/10s
    UID 合约下单、撤单
    成交历史、费率查询等
    交割合约 私有接口 单个下单接口 500r/10s
    单个撤单接口 500r/10s
    交割其他单个接口 200r/10s
    UID 下单、撤单
    期权合约 私有接口 单个下单接口 200r/s
    单个撤单接口 200r/s
    期权其他单个接口 200r/10s
    UID 下单、撤单
    子账户 私有接口 单个子账户相关接口 80r/10s UID 创建普通子账户
    查询子账户列表
    禁用、启用子账户APIKEY
    保证金 私有接口 借入或还款 15/10s UID 借入或还款(POST /unified/loans)
    其他私有接口 私有接口 单个接口 150r/10s UID 理财、抵押借币等

    限速是每个子账号或主账号单独计算的

    WebSocket:

    • 发送消息频率:无限制
    • 每个 IP 最大连接数: ≤ 300

    # 返回格式

    所有的接口返回都是 JSON 格式,需要用户自行转换提取数据。 所有操作成功时都会返回 HTTP 状态码 2xx 。401 说明认证有问题。其他 4xx 状态码说明请求无效。 如果是 5xx 错误,则是服务端处理请求时遇上了未知的严重错误,碰到的话请第一时间反馈。

    返回状态

    状态码 说明
    200/201 请求执行成功
    202 请求已被服务端接受,但是仍在处理中
    204 请求成功,服务端没有提供返回体
    400 无效请求
    401 认证失败
    404 未找到
    429 请求过于频繁
    5xx 服务器错误

    # 数据类型

    类型 说明
    string 字符串类型,以双引号表示,涉及金额和价格也会使用字符串标识
    integer 32位整数,主要涉及到状态码、大小、次数等
    integer(int64) 64位整数,主要涉及到ID和高精度时间戳
    number 浮点数,部分时间或统计数据会以浮点形式返回
    object 对象,包含一个子对象{}
    array 数组,包含多组内容
    boolean true 为真,false 为假

    # 统一帐户(旧)

    TIP

    统一账户旧版已不再维护,新版统一账户请查询统一账户

    我们从 4.25.0 版本之后开始引入对统一账户的支持 。统一账户是Gate.io新⼀代的交易系统,主要功能在于打破经典账户 (Classic Account) 内各个账户之间的资金隔离,实现多产品业务线之间的多币种保证金共享,用户无需各类交易之间进行资金划转,不同交易产品之间仓位盈亏可以互相抵消,有效提升用户的资金利用率。统一帐户(旧)更详细介绍可以查看 帮助中心

    用户在使用统一账户(旧) API 功能之前需要先在官网 API 管理页面创建统一账号(旧)的 API Key , 目前统一账户(旧)只支持现货全仓杠杆和永续合约交易。

    如果创建 API Key 的权限选项无法选择,首先确保现货全仓账户已经开通并且有初始资金。

    # 资金划转

    经典帐户与统一帐户是两个不同的帐户,如果想实现多产品业务线之间的多币种保证金共享则必须使用统一帐户。

    统一账户(旧)的资金来源于经典账户,由于涉及到经典账户的资金变动,资金的转入转出操作都只能使用经典账户的 API Key 来执行。

    统一账户(旧)基于原有经典账户的全仓杠杆账户升级,因此经典账户只需要将自己的现货资金划转到现货全仓杠杆账户,即可为统一账户(旧)充值。 同理资金的转出操作也必须由经典账户从全仓杠杆账户划转到自己的现货账户。

    统一账户(旧)的 API Key 只能在自己的多个账户之间划转, 由于保证金共享,统一账户(旧)也无需将全仓账户的资金划转到合约账户 (我们也限制了向合约账户的转入功能)。 但是如果合约账户有资金需要提取,必须由统一账户(旧)划转到自己的现货全仓杠杆账户,才可以交给经典账户执行资金转出动作。

    # 现货交易

    统一账户(旧)的现货交易与经典账户几乎完全一致,除了在订单操作中需要指定 account 的地方必须要指定 cross_margin , 比如想挂 BTC_USDT 交易对的买单,下单请求会类似于

    POST /spot/orders
    
    {
      "currency_pair": "BTC_USDT",
      "account": "cross_margin",
      "side": "buy",
      ...
    }
    

    其他订单相关限制请直接参考各接口说明。

    TIP

    需要特别说明的是,统一账户(旧)升级自经典账户的现货全仓杠杆账户,经典账户的 API Key 原先就支持操作现货全仓杠杆账户, 为了不影响经典账户已有的操作,我们依然保留了经典账户的这个功能。所以不管是经典账户还是统一账户(旧)的 API Key 都可以操作同一个现货全仓杠杆账户(注意合约账户是分开的)

    # 永续合约交易

    统一账户(旧)永续合约的 API 操作与经典账户完全相同,不过当前只支持 USD 结算

    TIP

    需要留意一下在合约交易的部份,并没有像现货交易在使用经典帐户 API Key 的时候有做对全仓杠杆帐户的兼容性处理,所以当使用经典帐户 API Key 进行合约交易的时候,资产是保留在 经典帐户-合约 下面,而使用统一帐户 API Key 进行合约交易的时候,资产是保留在 统一帐户-合约 下面,这两个是不同的合约帐号。另外在 经典帐户-现货 下的资金, 是无法与 经典帐户-合约 共享保证金的。

    # 请求ID

    允许在请求里设置一个 X-Client-Request-Id 的 header,API在响应时也会携带这个header。 可以使用这个字段来定位API响应的是对应的哪个请求,方便用户来设置请求 id 做跟踪。

    # Self-Trade Prevention(STP)

    # 名词解释

    Self-Trade Prevention: 自成交保护机制,后文中都简称为STP

    CN: Cancel new,取消新订单,保留老订单

    CO: Cancel old,取消⽼订单,保留新订单

    CB: Cancel both,新旧订单都取消

    # 成交策略

    目前支持三种自成交保护策略,分别是CNCOCB

    我们实现了STP用户组来提供给用户,被添加到同一个组内的多个用户账户ID,自成交或彼此成交会受到限制,限制策略取决于用户账户以taker 角色下单时指定的stp_act参数。

    当用户的账户ID添加到指定STP用户组后,下单时可以自定义stp_act参数,系统会按照用户传入的策略进行STP用户组 内撮合成交的限制;如果下单时没有指定stp_act策略,成交时默认按照CN策略执行。

    当下单用户的账户ID没有进入任何STP用户组,同时下单又指定了stp_act参数,此时系统会报错,无法下单。用户需要去掉stp_act 参数,此时用户成交不受任何自成交策略限制。

    # 接口参数调整

    以合约下单为例,有如下调整:

    POST /futures/{settle}/orders
    

    新增请求参数

    名称 位置 类型 必选 描述
    stp_act body string stp策略,包括:
    - cn 取消新订单,保留旧订单
    - co 取消老订单,保留新订单
    - cb 取消老订单和新订单

    新增返回参数(查询订单列表接口同理)

    名称 类型 必选 限制 描述
    stp_act string none STP策略,包括:
    - cn 取消新订单,保留旧订单
    - co 取消老订单,保留新订单
    - cb 取消老订单和新订单
    stp_id integer(int64) 只读 用户所在STP用户组的id,是引擎判断用户之间订单是否可以成交的依据。如果账户没有进入STP用户组stp_id不返回。
    finish_as string 只读 结束方式:
    - stp: 订单发生自成交限制而被撤销

    # 使用场景

    组织A下有多个账户,其中几个账户id分别为101,102,103

    为了防止组织内部账户下单发生自成交,管理员创建了一个STP用户组,用户组id为100,将账户101102加入到该STP用户组 中,此时组内成员为[101,102]

    T1: STP策略版本上线。

    T2: 组织A账户101下做空单后,市场订单深度没有与之匹配的订单可以撮合成交,此时下单角色是maker,订单状态是open 。返回参数会增加如下信息返回

    {
    	"status":"open",
    	"stp_act":"cn",
    	"stp_id":100
    }
    

    T3: 组织A账户101/102下做多单后,市场深度匹配到101账户下的做空订单可以撮合成交,当前角色是taker ,系统判断到两个订单的stp_id均为100,此时会限制成交,限制策略以taker为准。

    • 如果选择了cntaker下的订单会被取消,订单会结束,返回关键参数为:
    {
    	"status":"finished",
    	"stp_act":"cn",
    	"stp_id":100,
    	"finish_as":"stp"
    }
    
    • 如果选择了cotaker下的订单会被保留,订单状态为open,系统默认会取消maker的订单(maker可以通过查询订单列表,订单状态会跟上一种情况一致。)

    • 如果选择了cbtaker下的订单会被取消,订单会结束。系统默认会取消maker的订单(maker 可以通过查询订单列表)。两者的订单结束原因都为stp

    {
    	"status":"finished",
    	"stp_act":"cb",
    	"stp_id":100,
    	"finish_as":"stp"
    }
    

    T3': 组织A账户103下做多单后,市场深度匹配到101账户下的做空订单可以撮合成交,由于103用户没有被添加到组里,stp_id 为0,系统判断两边的stp_id不一致,可以成交。订单信息为:

    {
    	"status":"finished",
    	"stp_id":0,
    	"finish_as":"filled"
    }
    

    # 统一账户

    # 说明

    用户开通统一账户后,可以使用现货账户中的资产作为交易的保证金, 账户内的各币种资产将会根据其流动性,定义相应的调整系数,再统一折算为USD,来统一计算账户的资产及持仓价值。

    统一账户最大可借贷额度是用户对于当前交易市场的最大借贷额度。平台将根据用户的可用保证金数量以及平台风控规则等限制,计算用户当前的最大借贷额度。统一账户产生自动借款后,平台即时对所借数字资产开始计息。

    目前统一账户支持开通多币种保证金模式,后续将推出组合保证金模式,可根据自身需求进行账户模式切换,敬请期待。

    相关的接口请查看统一账户文挡,开通统一账户后可进行调用。更详细介绍可以查看 帮助中心

    # API接入流程

    • 创建新 API KEY 或者更新已有 API KEY 权限,勾选 unified 权限
    • 使用经典账户 API KEY 调用 POST /api/v4/unified/account_mode 接口,或者 WEB 页面升级新版统一账户
    • 使用 /api/v4/spot/** 接口进行现货相关操作(下单、修改订单、查询订单等), account 类型增加 unified 选项
    • 使用 /api/v4/futures/** 接口进行永续合约相关操作(下单、修改订单、查询订单等)
    • 使用 /api/v4/unified/** 接口进行统一账户相关操作(账户查询、借贷查询)

    # 现货交易

    统一账户的现货交易与经典账户一致,在订单操作中指定 account=unified,或者指定account=spot系统检测账户为统一账户时会自动处理为统一账户订单, 比如想挂 BTC_USDT 交易对的买单,下单请求会类似于

    POST /spot/orders
    
    {
      "currency_pair": "BTC_USDT",
      "account": "unified",
      "side": "buy",
      ...
    }
    

    其他订单相关限制请直接参考各接口说明。

    # 永续合约交易

    统一账户永续合约的 API 操作与经典账户完全相同,当前只支持 USDT 结算

    # 保证金公式

    名称 全仓保证金
    账户权益 账户权益= ∑(币种权益 x 币种指数价格)
    总保证金余额 总保证金余额 = ∑(正币种权益 x 币种指数价格 x 币种保证金系数) + ∑(负币种权益 x 币种指数价格)-挂单损失
    总起始保证金率 总起始保证金率=总保证金余额/总起始保证金
    总维持保证金率 总维持保证金率=总保证金余额/总维持保证金
    总起始保证金 总起始保证金=负债*现货起始保证金率
    总维持保证金 总维持保证金=负债*现货维持保证金率
    币种权益 币种权益=币种余额-现货已借
    可用余额 可用余额=本金+已借
    占用 占用=现货挂单占用

    # 资产流水类型

    # 通用

    • unknown : 未知
    • login : 登陆
    • withdraw : 提现
    • ch_pass : 修改密码
    • ch_fund_pass : 修改资金密码
    • login_failed : 登录失败
    • axs_account : 访问账号
    • req_pass_ch : 修改密码请求
    • req_fund_pass_ch : 修改资金密码请求
    • fund_pass_ent : 输入交易密码
    • bank_card_add : 绑定银行卡
    • frw : 提现人脸验证

    # 订单

    • new_order : 下单
    • cancel_order : 取消订单
    • order_fill : 成交
    • order_rej : 订单退回
    • order_fee : 成交手续费
    • system_fee : 系统成交手续费

    # 充提

    • withdraw : 提现
    • deposit : 充值
    • deposit_rej : 充值退回
    • withdraw_rej : 提现退回
    • cancel_withdraw : 取消提现
    • withdraw_gatecode : 充值码提现
    • withdraw_fireblock : Fireblock提现
    • withdraw_copper : Copper提现
    • startup_withdraw : Startup项目提现
    • deposit_gatecode : 充值码充值
    • deposit_fireblock : Fireblock充值
    • deposit_copper : Copper充值
    • buy_cl : 法币入金 Legend
    • buy_cc : 法币入金 Cabital
    • deposit_finmo : Finmo充值

    # Startup

    • startup_prtcp : 参加Startup
    • startup_refund : 退回Startup
    • startup_sale : Startup认购
    • startup_sale_rb : Startup认购退回

    # 返佣

    • referral_rebate : 推荐奖励
    • sec_rebate_out : 二级返佣系统账户转出
    • sec_rebate_in : 用户获得二级返佣
    • ab_rebate : API Broker返佣上级收入
    • eb_rebate : Exchange Broker返佣上级收入
    • u_rebate : 普通邀请返佣用户收入
    • ads_rebate : 代理商直接上级返佣收入
    • au_rebate : 代理商返佣用户收入
    • pis_rebate : 合伙人间接上级返佣收入
    • pds_rebate : 合伙人直接上级返佣收入
    • pu_rebate : 合伙人用户返佣收入

    # 兑换

    • eth_swap : ETH分叉兑换
    • dust_swap_dctd : 小额资产兑换
    • dust_swap_gt_add : 小额资产GT增加
    • dust_swap_fee : 小额币种手续费扣除
    • cv_buy : 闪兑买入
    • cv_sell : 闪兑卖出

    # C2C

    • c2c_mop : C2C商家下单
    • c2c_moc : C2C取消商家单
    • c2c_rop : C2C用户下单
    • c2c_roc : C2C取消用户单
    • c2c_om : C2C成交
    • c2c_or : C2C退回
    • c2c_fee : C2C手续费

    # 奖励

    • deposit_bonus : 充值奖励
    • trading_rewards : 交易奖励
    • purchase_bonus : 买入奖励
    • airdrop : 空投奖励
    • award : 限时奖励
    • mining_rewards : 挖矿奖励

    # 账户出入金

    • margin_in : 逐仓杠杆转入
    • margin_out : 逐仓杠杆转出
    • spot_settle_out: 现货同币种结算转出
    • spot_settle_in: 现货同币种结算转入
    • lending_in : 理财转入
    • lending_out : 理财转出
    • cross_in : 统一账户转入
    • cross_out : 统一账户转出
    • perp_in : 永续合约转入
    • perp_out : 永续合约转出
    • perp_settle_in: 永续合约多币种结算转入
    • perp_settle_out: 永续合约多币种结算转出
    • delivery_in : 交割合约转入
    • delivery_out : 交割合约转出
    • ai_in : 定投转入
    • ai_out : 定投转出
    • e_options_in : 短时期权转入
    • e_options_out : 短时期权转出
    • options_in : 期权转入
    • options_out : 期权转出
    • cbbc_in : 牛熊证转入
    • cbbc_out : 牛熊证转出
    • warrant_in : 窝轮转入
    • warrant_out : 窝轮转出
    • subaccount_trf : 子账户资金划转
    • quant_in : 量化交易转入
    • quant_out : 量化交易转出
    • pay_in : 支付账户转入
    • pay_out : 支付账户转出
    • fct_in : 合约跟单交易转入
    • fct_out : 合约跟单交易转出

    # 点卡

    • points_purchase : 购买点卡
    • points_expiration : 限时点卡
    • points_trf : 点卡转让
    • points_trf_rej : 点卡转让退回

    # 金融

    • lending_lent : 理财借出
    • collected : 收款
    • interest_in : 利息收入
    • lending_fee : 理财手续费抵扣
    • hodl_int : PoS利息收益
    • redeem : 赎回
    • lend : 借出
    • dual_purchased : 双币理财申购
    • dual_settled : 双币理财结算
    • liq_add : 流动性添加
    • liq_rm : 流动性赎回
    • liq_rebalanced : 流动性调仓
    • slot_int_in : 插槽解锁利息收益
    • str_int_in : 结构性理财利息收益

    # 借贷

    • borrow : 借款
    • repay : 还款
    • margin_borrow : 逐仓杠杆借入
    • margin_repay : 逐仓杠杆还款
    • margin_interest_out : 逐仓杠杆扣息
    • cl_borrow : 抵押借入
    • cl_repay : 抵押还款
    • cl_dctd : 抵押扣除
    • cl_rtd : 抵押退还
    • cross_borrow : 统一账户借入
    • cross_repay : 统一账户还款
    • interest_out : 利息

    # 币圈

    • donation : 捐款
    • rp_sent : 发送红包
    • rp_rcvd : 收取红包
    • rp_rej : 红包退回
    • ls_offered : 直播打赏
    • ls_rcvd : 直播被打赏
    • pt_offered : 币圈打赏
    • pt_rcvd : 币圈被打赏
    • subs_deduct : 订阅扣费
    • subs_in : 订阅费入账
    • subs_refund : 订阅费退回
    • subs_in_rcvd : 订阅费用退回入账

    # PUSH交易

    • push_dctd : push扣除
    • push_rcvd_dctd : push接收扣除
    • push_canceled : push撤单
    • push_rej : push拒绝
    • push_sent : push转让
    • push_rcvd : push接收

    # 量化跟单

    • quant_return : 量化交易退回
    • quant_cmn_in : 量化复制分红转入
    • quant_cmn_out : 量化复制分红转出
    • quant_cmn_rtd : 量化复制分红退回
    • fct_refund : 合约跟单交易资金退回
    • fct_rcvd : 合约带单分红转入
    • fct_fee : 合约跟单分红转出
    • fct_fee_refund : 合约跟单分红资金退回

    # NFT

    • nft_mp : 拍卖支付保证金
    • nft_bm : 拍卖购买
    • nft_om : 拍卖出售
    • ntf_mr : 拍卖保证金退回
    • nft_amr : 拍卖流拍获得保证金
    • nft_ocb : 订单取消退回
    • nft_fb : 一口价购买
    • nft_fs : 一口价出售
    • nft_ob : 报价购买
    • nft_os : 报价出售
    • nft_cr : 取消报价退款
    • nft_ir : 报价失效退款
    • nft_wf : 提现服务费
    • nft_wfr : 提现手续费退回
    • ntf_mf : 多副本创作服务费
    • ntf_mfr : 多副本创作服务费退回
    • ntf_royalty : 用户版税收入
    • nft_cd : 订单取消扣款
    • nft_crd : 交易撤销版税扣款
    • nft_cf : 众筹差额扣款
    • nft_cfr : 众筹差额退款
    • nft_ammf : 流动性池充值冻结
    • nft_ammw : 流动性池提现
    • nft_ammdf : 流动性池手续费
    • nft_ammd : 流动性池交易成功打款

    # 异常处理

    APIv4 对于所有的异常请求,会设置状态码为非 2xx ,同时返回一个 JSON 格式的返回体来描述具体的错误信息。

    返回体的格式通常如下所示:

    {
      "label": "INVALID_PARAM_VALUE",
      "message": "Invalid parameter `text` with value: abc"
    }
    
    • label 用于标识某种错误的类型,格式 string ,它的值是一个固定的列表(见下方)。程序处理可以使用 label 字段的内容来设定和捕获异常
    • message (或 detail) 表示详细的错误信息,方便 API 对接时,理解具体是因为什么样的参数设置导致请求出现了异常。 该字段内容不建议用于异常的捕获或识别。

    以 Python requests (opens new window) 为例,异常的处理流程可以参考如下所示:

    以下示例的异常捕获流程只涉及到业务相关的异常,网络连接超时等其他非业务相关的异常还需要自行处理。

    import requests
    
    r = requests.get("https://api.gateio.ws/api/v4/futures/btc/contracts/BTC_USD")
    try:
        r.raise_for_status()
    except requests.HTTPError:
        # 捕获非 2xx 错误,尝试解析 body 里返回的错误消息,并根据不同 label 做不同的异常处理
        if r.json()['label'] == 'xxx':
            print(r.json())
    

    Python SDK (opens new window) 为示例:

    import json
    from gate_api import FuturesApi
    from gate_api.rest import ApiException
    
    api = FuturesApi()
    try:
        api.get_futures_contract(settle='btc', contract="BTC_USD")
    except ApiException as e:  # ApiException 封装了异常的各种信息,详情可参看类定义
        detail = json.loads(e.value.body)
        if detail['label'] == 'xxx':
            print(detail)
    

    # 异常 label 列表

    • 请求参数或格式问题
    label 含义
    INVALID_PARAM_VALUE 参数输入值无效
    INVALID_PROTOCOL 参数输入值无效
    INVALID_ARGUMENT 参数无效
    INVALID_REQUEST_BODY 无效请求体
    MISSING_REQUIRED_PARAM 缺少必选参数
    BAD_REQUEST 无效请求
    INVALID_CONTENT_TYPE 无效的 Content-Type 头部格式
    NOT_ACCEPTABLE Accept 头部无法满足
    METHOD_NOT_ALLOWED 请求方法不接受
    NOT_FOUND 资源 URL 不存在
    • 认证相关
    label 含义
    INVALID_CREDENTIALS 认证接口缺少用户认证信息
    INVALID_KEY 无效的 API Key
    IP_FORBIDDEN 请求 IP 不在白名单
    READ_ONLY 请求账户只读,不可执行写操作
    INVALID_SIGNATURE 无效签名
    MISSING_REQUIRED_HEADER 缺少必要的认证头部
    REQUEST_EXPIRED 客户端时间与服务端时间相差过大
    ACCOUNT_LOCKED 账户被锁定
    FORBIDDEN 账户无权执行该操作
    API_WITHDRAW_DISABLED API提现操作临时禁用
    INVALID_WITHDRAW_ID 无效的提现ID
    INVALID_WITHDRAW_CANCEL_STATUS 当前提现状态无法取消
    • 钱包相关
    label 含义
    SUB_ACCOUNT_NOT_FOUND 子账户不存在
    SUB_ACCOUNT_LOCKED 子账号被冻结
    MARGIN_BALANCE_EXCEPTION 杠杆账户异常
    MARGIN_TRANSFER_FAILED 杠杆资金划转失败
    TOO_MUCH_FUTURES_AVAILABLE 合约账户总资产达到上限
    FUTURES_BALANCE_NOT_ENOUGH 合约账户余额不足
    ACCOUNT_EXCEPTION 账户异常
    SUB_ACCOUNT_TRANSFER_FAILED 子账户资金划转失败
    ADDRESS_NOT_USED 指定的钱包地址未在网页执行过划转
    TOO_FAST 提现频率过快
    WITHDRAWAL_OVER_LIMIT 超出提现额度
    DUPLICATE_REQUEST 重复请求
    ORDER_EXISTS 订单已存在
    INVALID_CLIENT_ORDER_ID 无效的client_order_id
    • 现货和杠杆相关
    label 含义
    INVALID_PRECISION 无效的精度
    INVALID_CURRENCY 无效的币种信息
    INVALID_CURRENCY_PAIR 无效的交易对
    POC_FILL_IMMEDIATELY 被动委托会立即成交
    ORDER_NOT_FOUND 订单不存在
    ORDER_CLOSED 订单已结束
    ORDER_CANCELLED 订单已撤销
    QUANTITY_NOT_ENOUGH 数量不足
    BALANCE_NOT_ENOUGH 余额不足
    MARGIN_NOT_SUPPORTED 该交易对不支持杠杆交易
    MARGIN_BALANCE_NOT_ENOUGH 杠杆账户余额不足
    AMOUNT_TOO_LITTLE 数额小于最低值
    AMOUNT_TOO_MUCH 数额过大
    REPEATED_CREATION 重复创建
    LOAN_NOT_FOUND 借贷订单不存在
    LOAN_RECORD_NOT_FOUND 借贷记录不存在
    NO_MATCHED_LOAN 没有借贷记录能满足借入需求
    NOT_MERGEABLE 借贷单不可合并
    NO_CHANGE 修改的参数与当前状态无区别
    REPAY_TOO_MUCH 还款数额超出借款数额
    TOO_MANY_CURRENCY_PAIRS 批量下单指定了过多交易对
    TOO_MANY_ORDERS 批量下单的单个交易对下单数过多
    MIXED_ACCOUNT_TYPE 批量下单中使用了多个账户类型
    AUTO_BORROW_TOO_MUCH 自动借入超出最多可借
    TRADE_RESTRICTED 高负债率导致交易操作被限制
    FOK_NOT_FILL FOK 订单无法全部成交
    INITIAL_MARGIN_TOO_LOW 用户总初始保证金率太低
    NO_MERGEABLE_ORDERS 找不到能够合并的借贷订单
    ORDER_BOOK_NOT_FOUND 市场深度不足
    FAILED_RETRIEVE_ASSETS 获取账户资产失败
    • 合约相关
    label 含义
    USER_NOT_FOUND 用户无合约账户
    CONTRACT_NO_COUNTER 没有匹配的对手单
    CONTRACT_NOT_FOUND 合约未找到
    NOT_FOUND 请求路径不存在
    RISK_LIMIT_EXCEEDED 委托超出风险限额
    INSUFFICIENT_AVAILABLE 余额不足
    LIQUIDATE_IMMEDIATELY 操作可能导致爆仓
    LEVERAGE_TOO_HIGH 杠杆倍数设置过高
    LEVERAGE_TOO_LOW 杠杆倍数设置过低
    ORDER_NOT_FOUND 委托不存在
    ORDER_NOT_OWNED 委托不存在
    ORDER_FINISHED 委托已结束
    TOO_MANY_ORDERS 过多未完成的委托
    POSITION_CROSS_MARGIN 全仓不支持更新保证金
    POSITION_IN_LIQUIDATION 仓位在强制平仓中
    POSITION_IN_CLOSE 仓位正在平仓中
    POSITION_EMPTY 仓位为空
    REMOVE_TOO_MUCH 保证金超过可调范围
    RISK_LIMIT_NOT_MULTIPLE 风险限额未按照步长调整
    RISK_LIMIT_TOO_HIGH 超出最大风险限额
    RISK_LIMIT_TOO_lOW 风险限额设置过低
    PRICE_TOO_DEVIATED 下单价与标记价格相差过大
    SIZE_TOO_LARGE 下单数量超过上限
    SIZE_TOO_SMALL 下单数量不足下限
    PRICE_OVER_LIQUIDATION 增加仓位时价格不能超过平仓价
    PRICE_OVER_BANKRUPT 减少仓位时价格不能超过破产价
    ORDER_POC_IMMEDIATE 被动委托会立即成交
    INCREASE_POSITION 只减仓委托会增加仓位
    CONTRACT_IN_DELISTING 当前合约市场处于下线过渡期,只允许创建只减仓委托或者平仓委托
    POSITION_NOT_FOUND 仓位不存在
    POSITION_DUAL_MODE 双向持仓模式不允许此操作
    ORDER_PENDING 有委托存在则不允许此操作
    POSITION_HOLDING 有持仓则不允许此操作
    REDUCE_EXCEEDED 双向持仓模式下,减仓单超过仓位大小
    NO_CHANGE 没有改变发生
    AMEND_WITH_STOP 有止盈止损单时不能修改委托
    ORDER_FOK FOK 订单无法全部成交
    • 抵押借币相关
    label 含义
    COL_NOT_ENOUGH 质押物余额不足
    COL_TOO_MUCH 超过质押币种质押额度
    INIT_LTV_TOO_HIGH 初始质押率过高
    REDEEMED_LTV_TOO_HIGH 提取后质押率过高
    BORROWABLE_NOT_ENOUGH 剩余可借余额不足
    ORDER_TOO_MANY_TOTAL 超过平台每天下单数量
    ORDER_TOO_MANY_DAILY 超过单一用户每天下单数量
    ORDER_TOO_MANY_USER 超过单一用户总下单数量
    ORDER_NOT_EXIST 订单不存在
    ORDER_FINISHED 订单已结束
    ORDER_NO_PAY 订单待还金额为0
    ORDER_EXIST 订单已存在
    ORDER_HISTORY_EXIST 订单历史记录已存在
    ORDER_REPAYING 订单已在还款中
    ORDER_LIQUIDATING 订单已在平仓中
    BORROW_TOO_LITTLE 小于币种最小可借
    BORROW_TOO_LARGE 借款金额超过最大剩余可借
    REPAY_AMOUNT_INVALID 还款金额无效
    REPAY_GREATER_THAN_AVAILABLE 还款数额大于剩余可用
    POOL_BALANCE_NOT_ENOUGH 资金池余额不足
    CURRENCY_SETTLING 币种结算中,不允许还款
    RISK_REJECT 风控检查中,请稍后再试
    LOAN_FAILED 放款失败,可以再次发起借款
    • 现货保证金相关
    label 含义
    USER_LIAB 用户存在负债
    USER_PENDING_ORDERS 用户存在挂单
    MODE_SET 保证金模式已设置
    • 理财相关
    label 含义
    ERR_BALANCE_NOT_ENOUGH 余额不足
    ERR_PRODUCT_SELL_OUT 项目售罄
    ERR_PRODUCT_BUY 项目未开始
    ERR_CREATE_ORDER 下单失败
    ERR_QUOTA_LOWER_LIMIT 不满足最小下单金额
    ERR_QUOTA_SUPERIOR_LIMIT 已达最大下单额度
    ERR_ORDER_NUMBER_LIMIT 已达最大下单数量
    ERR_PRODUCT_CLOSE 项目已结束
    COPIES_NOT_ENOUGH 可申购仓位不足
    COPIES_TOO_SMALL 投资份额不足
    COPIES_TOO_BIG 投资份额超过最大购买限制
    TOTAL_AMOUNT_24 24小时内质押与赎回总量超限
    TOTAL_BUYCOUNT_24 24小时内质押与赎回次数超限
    REDEEM_24_LIMIT 质押后24小时内不能赎回
    • 服务异常
    label 含义
    INTERNAL 内部错误
    SERVER_ERROR 内部错误
    TOO_BUSY 服务当前忙

    # 认证

    # 生成 API key

    在调用私有API接口前,需要生成账户的API key来验证身份。 您可以在网页端登录成功后,在【账户管理】-> 【APIv4 Keys】中生成, 或点击 这里 生成 API keys

    每个账户最多可以创建 20 个 API key,每个 Key 的权限配置都是相互独立的。 建议给每个 Key 设置能够标明用途的备注名

    Key 访问密钥
    Secret Key 签名认证加密所使用的密钥

    除此之外,还可以配置 IP 白名单,只允许服务端接收来自 IP 白名单里的客户端请求。每个 Key 最多可配置 20 个 IP 地址,IP 地址按照 IPv4 配置, 不支持 IP 地址段。若不设置 IP 白名单,服务端不会验证客户端 IP 来源。

    TIP

    注:如果发现 Key 的名字是 spot 或者 futures ,该 Key 很有可能是迁移之后系统的默认命名, 详情参考 “关于 APIv4 Key 升级” 一节。

    创建的 Key 还可以更新和删除,不过需要注意的是 Key 的更新和删除,最多需要 5 分钟才能生效。

    另外模拟合约与实盘合约属于两套不同的环境,实盘合约的 API Key 不可用于模拟合约。 如果需要使用模拟合约做 API 接口联调测试,需要在个人账户 APIv4Keys 页面的模拟合约入口单独申请。 模拟合约与实盘合约的接口请求方式完全相同,区别只是在 API 的 Base URL 和使用的 API Key

    # APIv4 权限

    创建 Key 的时候,可以为该 Key 配置是否开启现货杠杆、合约、钱包或者提现的权限, 开启的权限可以配置读写或者只读。

    产品 权限
    现货/杠杆 只读查询订单 读写查询订单&下单
    永续合约 只读查询订单 读写查询订单&下单
    交割合约 只读查询订单 读写查询订单&下单
    钱包 只读查询充提划转记录 读写 查询账户记录&资金划转
    提现 只读查询提现记录 读写 查询提现记录&提现

    所有请求方法为 GET 的都是读操作,其他的则是写请求。每个权限组可以设置为禁用、只读或读写。

    值得注意的一点是,尽管提现操作组只有一个 API (即 POST /withdrawals ),考虑到一般使用情况, 还是将其从钱包操作里独立成一个权限组,而包括了提现记录的账户转出流水记录查询(即 GET /wallet/withdrawals )还是保留在钱包 API 权限组了。

    # APIv4 验签请求接口发送要求

    1. 在官网个人中心申请 APIv4 Key ,并确保该 Key 拥有对应操作的读写权限。
    2. 在发送请求头部传入 KEY ,即 APIv4 密钥对的 Key
    3. 在发送请求头部传入 Timestamp ,即请求发送的时间,格式是秒级精度的 Unix 时间戳。 同时该时间不能与当前时间差距超过 60 秒。
    4. 在发送请求头部传入 SIGN ,即将请求生成签名字符串并用 APIv4 Secret 加密后生成的签名。 签名字符串生成方法参看下节,加密算法为 HexEncode(HMAC_SHA512(secret, signature_string)) , 即通过 HMAC-SHA512 加密算法,将 APIv4 Secret 作为加密密钥,签名字符串作为加密消息, 生成加密结果的 16 进制输出。
    5. 确保发送请求的客户端 IP 地址在所使用的密钥的 IP 地址白名单里。

    # APIv4 签名字符串生成方式

    APIv4 中签名字符串按照如下方式拼接生成:

    Request Method + "\n" + Request URL + "\n" + Query String + "\n" + HexEncode(SHA512(Request Payload)) + "\n" + Timestamp

    # Request Method

    请求方法,全大写, 如 POST, GET

    # Request URL

    请求 URL,不包括服务地址和端口,如 /api/v4/futures/orders

    # Query String

    没有使用 URL 编码的请求参数,请求参数在参与计算签名时的顺序一定要保证和实际请求里的顺序一致。 如 status=finished&limit=50

    如果没有请求参数,使用空字符串 ("")

    # HexEncode(SHA512(Request Payload))

    将请求体字符串使用 SHA512 哈希之后的结果。如果没有请求体,使用空字符串的哈希结果,即 cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e

    # Timestamp

    设置在请求头部 Timestamp 里的值

    示例

    注:示例中所有的换行都是为了方便显示人为添加的,实际只有示例中的一个 \n 保留

    假设使用的 Key 为 key ,Secret 为 secret

    1. 查询所有合约订单
    	GET /api/v4/futures/orders?contract=BTC_USD&status=finished&limit=50 HTTP/1.1
    

    签名字符串:

    	GET\n
    	/api/v4/futures/orders\n
    	contract=BTC_USD&status=finished&limit=50\n
    	cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e\n
    	1541993715
    

    说明

    • /api/v4/futures/orders: 请求 URL
    • contract=BTC_USD&status=finished&limit=50: 请求参数,与实际请求的顺序完全一致
    • 请求体为空,使用空字符串的哈希输出
    • 1541993715: Unix 时间戳

    签名结果

    55f84ea195d6fe57ce62464daaa7c3c02fa9d1dde954e4c898289c9a2407a3d6fb3faf24deff16790d726b66ac9f74526668b13bd01029199cc4fcc522418b8a

    1. 创建合约委托
    	POST /api/v4/futures/orders HTTP/1.1
    
    	{"contract":"BTC_USD","type":"limit","size":100,"price":6800,"time_in_force":"gtc"}
    

    签名字符串:

    	POST\n
    	/api/v4/futures/orders\n
    	\n
    	ad3c169203dc3026558f01b4df307641fa1fa361f086b2306658886d5708767b1854797c68d9e62fef2f991645aa82673622ebf417e091d0bd22bafe5d956cca\n
    	1541993715
    

    说明

    • 请求参数为空,使用空字符串
    • 使用 JSON 序列化之后的字符串的哈希输出

    签名结果

    eae42da914a590ddf727473aff25fc87d50b64783941061f47a3fdb92742541fc4c2c14017581b4199a1418d54471c269c03a38d788d802e2c306c37636389f0

    # coding: utf-8
    
    # Python 示例验签代码
    
    """
    本示例仅作为演示签名计算方式使用,推荐使用各语言的 SDK ,因为已经集成了验签规则
    """
    
    # coding: utf-8
    import time
    import hashlib
    import hmac
    import requests
    import json
    
    def gen_sign(method, url, query_string=None, payload_string=None):
        key = ''        # api_key
        secret = ''     # api_secret
    
        t = time.time()
        m = hashlib.sha512()
        m.update((payload_string or "").encode('utf-8'))
        hashed_payload = m.hexdigest()
        s = '%s\n%s\n%s\n%s\n%s' % (method, url, query_string or "", hashed_payload, t)
        sign = hmac.new(secret.encode('utf-8'), s.encode('utf-8'), hashlib.sha512).hexdigest()
        return {'KEY': key, 'Timestamp': str(t), 'SIGN': sign}
    
    if __name__ == "__main__":
        host = "https://api.gateio.ws"
        prefix = "/api/v4"
        common_headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
        url = '/futures/orders'
        body = {"contract": "BTC_USD", "size": 100, "price": "30", "tif": "gtc"}
        request_content = json.dumps(body)
        sign_headers = gen_sign('POST', prefix + url, "", request_content)
        sign_headers.update(common_headers)
        print('signature headers: %s' % sign_headers)
        res = requests.post(host + prefix + url, headers=sign_headers, data=request_content)
        print(res.status_code)
        print(res.content)
    

    # 常见问题

    • POST /wallet/transfers 的操作记录怎么查询?

      通过 POST /wallet/transfers 执行的转账操作,按不同的账户类型,查询入口分在不同的服务地址,包括:

      • GET /margin/account_book 查询杠杆账户的转入转入历史
      • GET /futures/{settle}/account_book?type=dnw 查询永续合约账户的转入转出历史
      • GET /delivery/{settle}/account_book?type=dnw 查询交割合约账户的转入转出历史
    • 杠杆下单怎么操作?

      杠杆下单复用了现货下单接口,只需要在 POST /spot/ordersPOST /spot/batch_orders 时将请求体里的 account 参数设置为 margin 即可

    • 合约操作返回 USER_NOT_FOUND

      原因是因为合约账户没有开户,只需要执行一笔账户划转操作即可。注意不同结算币种有不同的合约账户

    • 合约提示 CONTRACT_NOT_FOUND

      不同结算币种的合约也是不同的,请确认指定的合约名称是否在对应结算币种支持的合约列表中。即

      GET /futures/{settle}/contractsGET /delivery/{settle}/contracts

    • 主子账号的区别

      • 子账号 API Key 不能操作主子账户互转API, 即 POST /wallet/sub_account_transfers
      • 子账号 API Key 不能使用API进行提现,即 POST /withdrawals
      • 如果创建子账号时没有开启对应业务的权限,即时子账号 API key 开启了权限,请求也一样会被拒绝
    • 上面没有我的问题

      联系客服咨询具体问题。如果有使用到某一个语言的 SDK ,也可以在相应 SDK 的 github 项目中提交 issue

      提交问题的时候,建议至少包含以下信息,可以更快速定位问题:

      • 用户 ID
      • 原始的请求 URL、请求参数和请求体内容
        • 使用的 API Key 是实盘还是模拟的,具体的 Key 是什么(不需要提供 Secret)
        • 编程语言,最好提供一段发送请求的代码片段
        • 是否使用了 SDK ,如果使用了 SDK ,具体是调用哪个方法

    # Withdrawal

    提现接口

    # 提现,如果对方的链上地址也是Gate的话, 则不收取手续费

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/withdrawals'
    query_param = ''
    body='{"withdraw_order_id":"order_123456","currency":"USDT","address":"1HkxtBAMrA3tP5ENnYY2CZortjZvFDH5Cs","amount":"222.61","memo":"","chain":"TRX"}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/withdrawals"
    query_param=""
    body_param='{"withdraw_order_id":"order_123456","currency":"USDT","address":"1HkxtBAMrA3tP5ENnYY2CZortjZvFDH5Cs","amount":"222.61","memo":"","chain":"TRX"}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /withdrawals

    提现,如果对方的链上地址也是Gate的话, 则不收取手续费

    请求体示例

    {
      "withdraw_order_id": "order_123456",
      "currency": "USDT",
      "address": "1HkxtBAMrA3tP5ENnYY2CZortjZvFDH5Cs",
      "amount": "222.61",
      "memo": "",
      "chain": "TRX"
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » withdraw_order_id body string 用户端订单编号,最长32个,输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.)
    » amount body string 币的数量
    » currency body string 币种名称
    » address body string 提现地址。提现操作必填
    » memo body string 转账memo等备注信息
    » chain body string 提现的链名称

    返回示例

    202 返回

    {
      "id": "210496",
      "timestamp": "1542000000",
      "withdraw_order_id": "order_123456",
      "currency": "USDT",
      "address": "1HkxtBAMrA3tP5ENnYY2CZortjZvFDH5Cs",
      "txid": "128988928203223323290",
      "amount": "222.61",
      "memo": "",
      "status": "DONE",
      "chain": "TRX"
    }
    

    返回

    状态码 含义 描述 格式
    202 Accepted (opens new window) 提现请求已受理,处理结果查看该提现记录状态 Inline

    返回格式

    状态码 202

    名称 类型 描述
    » id string 交易记录 ID
    » txid string 区块转账哈希记录
    » withdraw_order_id string 用户端订单编号,最长32个,输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.)
    » timestamp string 操作时间
    » amount string 币的数量
    » currency string 币种名称
    » address string 提现地址。提现操作必填
    » memo string 转账memo等备注信息
    » status string 交易状态

    - DONE: 完成
    - CANCEL: 已取消
    - REQUEST: 请求中
    - MANUAL: 待人工审核
    - BCODE: 充值码操作
    - EXTPEND: 已经发送等待确认
    - FAIL: 链上失败等待确认
    - INVALID: 无效订单
    - VERIFY: 验证中
    - PROCES: 处理中
    - PEND: 处理中
    - DMOVE: 待人工审核
    - SPLITPEND: cny提现大于5w,自动分单
    » chain string 提现的链名称

    # 枚举值列表

    属性
    status DONE
    status CANCEL
    status REQUEST
    status MANUAL
    status BCODE
    status EXTPEND
    status FAIL
    status INVALID
    status VERIFY
    status PROCES
    status PEND
    status DMOVE
    status SPLITPEND

    WARNING

    该请求需要 API key 和 secret 认证

    # 取消指定 ID 的提现操作

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/withdrawals/210496'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('DELETE', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('DELETE', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="DELETE"
    url="/withdrawals/210496"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    DELETE /withdrawals/{withdrawal_id}

    取消指定 ID 的提现操作

    参数

    名称 位置 类型 必选 描述
    withdrawal_id URL string

    返回示例

    202 返回

    {
      "id": "210496",
      "timestamp": "1542000000",
      "withdraw_order_id": "order_123456",
      "currency": "USDT",
      "address": "1HkxtBAMrA3tP5ENnYY2CZortjZvFDH5Cs",
      "txid": "128988928203223323290",
      "amount": "222.61",
      "memo": "",
      "status": "DONE",
      "chain": "TRX"
    }
    

    返回

    状态码 含义 描述 格式
    202 Accepted (opens new window) 取消请求已受理,处理结果查看该提现记录状态 Inline

    返回格式

    状态码 202

    名称 类型 描述
    » id string 交易记录 ID
    » txid string 区块转账哈希记录
    » withdraw_order_id string 用户端订单编号,最长32个,输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.)
    » timestamp string 操作时间
    » amount string 币的数量
    » currency string 币种名称
    » address string 提现地址。提现操作必填
    » memo string 转账memo等备注信息
    » status string 交易状态

    - DONE: 完成
    - CANCEL: 已取消
    - REQUEST: 请求中
    - MANUAL: 待人工审核
    - BCODE: 充值码操作
    - EXTPEND: 已经发送等待确认
    - FAIL: 链上失败等待确认
    - INVALID: 无效订单
    - VERIFY: 验证中
    - PROCES: 处理中
    - PEND: 处理中
    - DMOVE: 待人工审核
    - SPLITPEND: cny提现大于5w,自动分单
    » chain string 提现的链名称

    # 枚举值列表

    属性
    status DONE
    status CANCEL
    status REQUEST
    status MANUAL
    status BCODE
    status EXTPEND
    status FAIL
    status INVALID
    status VERIFY
    status PROCES
    status PEND
    status DMOVE
    status SPLITPEND

    WARNING

    该请求需要 API key 和 secret 认证

    # Wallet

    钱包接口

    # 查询币种支持的链

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/currency_chains'
    query_param = 'currency=GT'
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/wallet/currency_chains?currency=GT \
      -H 'Accept: application/json'
    
    

    GET /wallet/currency_chains

    查询币种支持的链

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 币种名称

    返回示例

    200 返回

    [
      {
        "chain": "ETH",
        "name_cn": "以太坊ERC20",
        "name_en": "ETH/ERC20",
        "is_disabled": 0,
        "is_deposit_disabled": 0,
        "is_withdraw_disabled": 0
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » chain string 链名称
    » name_cn string 链的中文名称
    » name_en string 链的英文名称
    » contract_address string 币种智能合约地址,如果没有地址则为空字串
    » is_disabled integer(int32) 是否禁用,0 表示未禁用
    » is_deposit_disabled integer(int32) 充值是否禁用,0 表示未禁用
    » is_withdraw_disabled integer(int32) 提现是否禁用,0 表示未禁用
    » decimal string 提币精度

    # 获取币种充值地址

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/deposit_address'
    query_param = 'currency=USDT'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/deposit_address"
    query_param="currency=USDT"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/deposit_address

    获取币种充值地址

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 币种名称

    返回示例

    200 返回

    {
      "currency": "USDT",
      "address": "LPXtk1kWHioP62SzfqwKbYE3Z7Wt2ujYEc",
      "multichain_addresses": [
        {
          "chain": "TRX",
          "address": "LPXtk1kWHioP62SzfqwKbYE3Z7Wt2ujYEc",
          "payment_id": "",
          "payment_name": "",
          "obtain_failed": 0
        }
      ]
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 地址获取成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » currency string 币种信息
    » address string 充值地址
    » multichain_addresses array
    »» MultiChainAddressItem object
    »»» chain string 链的名称
    »»» address string 充值地址
    »»» payment_id string 部分币种充值时必须填写的备注
    »»» payment_name string 备注类型, TagMemo
    »»» obtain_failed integer 地址是否获取成功,0 表示成功,1 表示失败,可能需要重新获取

    WARNING

    该请求需要 API key 和 secret 认证

    # 获取提现记录

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/withdrawals'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/withdrawals"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/withdrawals

    获取提现记录

    记录查询时间范围不允许超过 30 天

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定查询币种,不指定返回全部币种
    from 请求参数 integer(int64) 查询记录的起始时间,不指定则默认从当前时间开始向前推 7 天
    to 请求参数 integer(int64) 查询记录的结束时间,不指定则默认为当前时间
    limit 请求参数 integer 列表返回的最大数量
    offset 请求参数 integer 列表返回的偏移量,从 0 开始

    返回示例

    200 返回

    [
      {
        "id": "210496",
        "timestamp": "1542000000",
        "withdraw_order_id": "order_123456",
        "currency": "USDT",
        "address": "1HkxtBAMrA3tP5ENnYY2CZortjZvFDH5Cs",
        "txid": "128988928203223323290",
        "amount": "222.61",
        "fee": "0.01",
        "memo": "",
        "status": "DONE",
        "chain": "TRX"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » id string 交易记录 ID
    » txid string 区块转账哈希记录
    » withdraw_order_id string 用户端订单编号,最长32个,输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.)
    » timestamp string 操作时间
    » amount string 币的数量
    » fee string 手续费
    » currency string 币种名称
    » address string 提现地址。提现操作必填
    » memo string 转账memo等备注信息
    » status string 交易状态

    - DONE: 完成
    - CANCEL: 已取消
    - REQUEST: 请求中
    - MANUAL: 待人工审核
    - BCODE: 充值码操作
    - EXTPEND: 已经发送等待确认
    - FAIL: 链上失败等待确认
    - INVALID: 无效订单
    - VERIFY: 验证中
    - PROCES: 处理中
    - PEND: 处理中
    - DMOVE: 待人工审核
    - SPLITPEND: cny提现大于5w,自动分单
    » chain string 提现的链名称

    # 枚举值列表

    属性
    status DONE
    status CANCEL
    status REQUEST
    status MANUAL
    status BCODE
    status EXTPEND
    status FAIL
    status INVALID
    status VERIFY
    status PROCES
    status PEND
    status DMOVE
    status SPLITPEND

    WARNING

    该请求需要 API key 和 secret 认证

    # 获取充值记录

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/deposits'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/deposits"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/deposits

    获取充值记录

    记录查询时间范围不允许超过 30 天

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定查询币种,不指定返回全部币种
    from 请求参数 integer(int64) 查询记录的起始时间,不指定则默认从当前时间开始向前推 7 天
    to 请求参数 integer(int64) 查询记录的结束时间,不指定则默认为当前时间
    undefined undefined undefined
    offset 请求参数 integer 列表返回的偏移量,从 0 开始

    返回示例

    200 返回

    [
      {
        "id": "210496",
        "timestamp": "1542000000",
        "withdraw_order_id": "order_123456",
        "currency": "USDT",
        "address": "1HkxtBAMrA3tP5ENnYY2CZortjZvFDH5Cs",
        "txid": "128988928203223323290",
        "amount": "222.61",
        "memo": "",
        "status": "DONE",
        "chain": "TRX"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    None array
    » id string 交易记录 ID
    » txid string 区块转账哈希记录
    » withdraw_order_id string 用户端订单编号,最长32个,输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.)
    » timestamp string 操作时间
    » amount string 币的数量
    » currency string 币种名称
    » address string 提现地址。提现操作必填
    » memo string 转账memo等备注信息
    » status string 交易状态

    - DONE: 完成
    - CANCEL: 已取消
    - REQUEST: 请求中
    - MANUAL: 待人工审核
    - BCODE: 充值码操作
    - EXTPEND: 已经发送等待确认
    - FAIL: 链上失败等待确认
    - INVALID: 无效订单
    - VERIFY: 验证中
    - PROCES: 处理中
    - PEND: 处理中
    - DMOVE: 待人工审核
    - SPLITPEND: cny提现大于5w,自动分单
    » chain string 提现的链名称

    # 枚举值列表

    属性
    status DONE
    status CANCEL
    status REQUEST
    status MANUAL
    status BCODE
    status EXTPEND
    status FAIL
    status INVALID
    status VERIFY
    status PROCES
    status PEND
    status DMOVE
    status SPLITPEND

    WARNING

    该请求需要 API key 和 secret 认证

    # 交易账户互转

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/transfers'
    query_param = ''
    body='{"currency":"BTC","from":"spot","to":"margin","amount":"1","currency_pair":"BTC_USDT"}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/wallet/transfers"
    query_param=""
    body_param='{"currency":"BTC","from":"spot","to":"margin","amount":"1","currency_pair":"BTC_USDT"}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /wallet/transfers

    交易账户互转

    个人交易账户之间的余额互转,目前支持以下互转操作:

    1. 现货账户 - 杠杆账户
    2. 现货账户 - 永续合约账户
    3. 现货账户 - 交割合约账户
    4. 现货账户 - 全仓杠杆账户
    5. 现货账户 - 期权账户

    请求体示例

    {
      "currency": "BTC",
      "from": "spot",
      "to": "margin",
      "amount": "1",
      "currency_pair": "BTC_USDT"
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » currency body string 转账货币名称。关联合约账户时,currency 可以设置的值为POINT(即点卡) 和支持的结算货币(如 BTC, USDT)
    » from body string 转出账户
    » to body string 转入账户
    » amount body string 转账额度
    » currency_pair body string 杠杆交易对。转入或转出杠杆账户时必填
    » settle body string 合约结算币种。 转入转出合约账户时必填

    # 枚举值列表

    参数
    » from spot
    » from margin
    » from futures
    » from delivery
    » from cross_margin
    » from options
    » to spot
    » to margin
    » to futures
    » to delivery
    » to cross_margin
    » to options

    返回示例

    200 返回

    {
      "tx_id": 59636381286
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 转账操作成功 Inline

    返回格式

    状态码 200

    TransactionID

    名称 类型 描述
    » tx_id integer(int64) 操作单号

    WARNING

    该请求需要 API key 和 secret 认证

    # 主子账号互转

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/sub_account_transfers'
    query_param = ''
    body='{"client_order_id":"da3ce7a088c8b0372b741419c7829033","currency":"BTC","sub_account":"10002","direction":"to","amount":"1","sub_account_type":"spot"}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/wallet/sub_account_transfers"
    query_param=""
    body_param='{"client_order_id":"da3ce7a088c8b0372b741419c7829033","currency":"BTC","sub_account":"10002","direction":"to","amount":"1","sub_account_type":"spot"}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /wallet/sub_account_transfers

    主子账号互转

    支持转入转出到子账号的现货或合约账户,注意不管操作子账号的哪个账户,主账号的账户只使用现货账户

    请求体示例

    {
      "client_order_id": "da3ce7a088c8b0372b741419c7829033",
      "currency": "BTC",
      "sub_account": "10002",
      "direction": "to",
      "amount": "1",
      "sub_account_type": "spot"
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » currency body string 转账货币名称
    » sub_account body string 子账号用户 ID
    » direction body string 资金流向,to - 转入子账号, from - 转出子账号
    » amount body string 转账额度
    » client_order_id body string 客户自定义ID,防止重复划转,字母(区分大小写)、数字、连字符'-'和下划线'_'的组合,可以是纯字母、纯数字且长度要在1-64位之间
    » sub_account_type body string 操作的子账号交易账户, spot - 现货账户, futures - 永续合约账户, cross_margin - 全仓杠杆账户, delivery - 交割合约账户

    返回

    状态码 含义 描述 格式
    204 No Content (opens new window) 转账操作成功

    WARNING

    该请求需要 API key 和 secret 认证

    # 主子账号划转记录

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/sub_account_transfers'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/sub_account_transfers"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/sub_account_transfers

    主子账号划转记录

    记录查询时间范围不允许超过 30 天

    注:只能查询到 2020-04-10 之后的记录

    参数

    名称 位置 类型 必选 描述
    sub_uid 请求参数 string 子账号用户 ID,可查多笔中间用,隔开,不指定则返回所有子账号的记录
    from 请求参数 integer(int64) 查询记录的起始时间,不指定则默认从当前时间开始向前推 7 天
    to 请求参数 integer(int64) 查询记录的结束时间,不指定则默认为当前时间
    limit 请求参数 integer 列表返回的最大数量
    offset 请求参数 integer 列表返回的偏移量,从 0 开始

    返回示例

    200 返回

    [
      {
        "uid": "10001",
        "timest": "1592809000",
        "source": "web",
        "client_order_id": "da3ce7a088c8b0372b741419c7829033",
        "currency": "BTC",
        "sub_account": "10002",
        "direction": "to",
        "amount": "1",
        "sub_account_type": "spot"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表获取成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    None array
    » currency string 转账货币名称
    » sub_account string 子账号用户 ID
    » direction string 资金流向,to - 转入子账号, from - 转出子账号
    » amount string 转账额度
    » uid string 主账号用户 ID
    » client_order_id string 客户自定义ID,防止重复划转,字母(区分大小写)、数字、连字符'-'和下划线'_'的组合,可以是纯字母、纯数字且长度要在1-64位之间
    » timest string 转账时间戳
    » source string 转账操作来源
    » sub_account_type string 操作的子账号交易账户, spot - 现货账户, futures - 永续合约账户, cross_margin - 全仓杠杆账户, delivery - 交割合约账户

    WARNING

    该请求需要 API key 和 secret 认证

    # 子账号与子帐号互转

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/sub_account_to_sub_account'
    query_param = ''
    body='{"currency":"usdt","sub_account_from":"10001","sub_account_from_type":"spot","sub_account_to":"10002","sub_account_to_type":"spot","amount":"1"}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/wallet/sub_account_to_sub_account"
    query_param=""
    body_param='{"currency":"usdt","sub_account_from":"10001","sub_account_from_type":"spot","sub_account_to":"10002","sub_account_to_type":"spot","amount":"1"}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /wallet/sub_account_to_sub_account

    子账号与子帐号互转

    支持同一个主账户下的两个子账户之间进行余额互转,可以使用主账户API Key或者转出子账户API Key进行操作

    请求体示例

    {
      "currency": "usdt",
      "sub_account_from": "10001",
      "sub_account_from_type": "spot",
      "sub_account_to": "10002",
      "sub_account_to_type": "spot",
      "amount": "1"
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » currency body string 转账货币名称
    » sub_account_type body string 转出的子账号交易账户 (已弃用, 改用 sub_account_from_typesub_account_to_type)
    » sub_account_from body string 转出子账号用户 ID
    » sub_account_from_type body string 转出的子账号交易账户, spot - 现货账户, futures - 永续合约账户, delivery - 交割合约账户, cross_margin - 全仓杠杆账户
    » sub_account_to body string 转入子账号用户 ID
    » sub_account_to_type body string 转入的子账号交易账户, spot - 现货账户, futures - 永续合约账户, delivery - 交割合约账户, cross_margin - 全仓杠杆账户
    » amount body string 转账额度

    返回

    状态码 含义 描述 格式
    204 No Content (opens new window) 转账操作成功

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询提现状态

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/withdraw_status'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/withdraw_status"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/withdraw_status

    查询提现状态

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定币种名称查询

    返回示例

    200 返回

    [
      {
        "currency": "GT",
        "name": "GateToken",
        "name_cn": "GateToken",
        "deposit": "0",
        "withdraw_percent": "0%",
        "withdraw_fix": "0.01",
        "withdraw_day_limit": "20000",
        "withdraw_day_limit_remain": "20000",
        "withdraw_amount_mini": "0.11",
        "withdraw_eachtime_limit": "20000",
        "withdraw_fix_on_chains": {
          "BTC": "20",
          "ETH": "15",
          "TRX": "0",
          "EOS": "2.5"
        },
        "withdraw_percent_on_chains": {
          "ETH": "0%",
          "GTEVM": "0%"
        }
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表获取成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » currency string 币种
    » name string 币种名称
    » name_cn string 币种中文名称
    » deposit string 充值手续费
    » withdraw_percent string 提现手续费率百分比
    » withdraw_fix string 固定提现手续费用
    » withdraw_day_limit string 日提现额度
    » withdraw_amount_mini string 最少提现额度
    » withdraw_day_limit_remain string 剩余日提现额度
    » withdraw_eachtime_limit string 单次最多提现额度
    » withdraw_fix_on_chains object 多链的固定提现手续费用
    »» additionalProperties string
    » withdraw_percent_on_chains object 多链的百分比提现手续费用
    »» additionalProperties string

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询子账号余额信息

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/sub_account_balances'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/sub_account_balances"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/sub_account_balances

    查询子账号余额信息

    参数

    名称 位置 类型 必选 描述
    sub_uid 请求参数 string 子账号用户 ID,可查多笔中间用,隔开,不指定则返回所有子账号的记录

    返回示例

    200 返回

    [
      {
        "uid": "10003",
        "available": {
          "BTC": "0.1",
          "GT": "2000",
          "USDT": "10"
        }
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表获取成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » uid string 用户 ID
    » available object 币种可用余额
    »» additionalProperties string

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询子账号逐仓杠杆账户余额信息

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/sub_account_margin_balances'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/sub_account_margin_balances"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/sub_account_margin_balances

    查询子账号逐仓杠杆账户余额信息

    参数

    名称 位置 类型 必选 描述
    sub_uid 请求参数 string 子账号用户 ID,可查多笔中间用,隔开,不指定则返回所有子账号的记录

    返回示例

    200 返回

    [
      {
        "uid": "10000",
        "available": [
          {
            "locked": false,
            "currency_pair": "BTC_USDT",
            "risk": "9999.99",
            "base": {
              "available": "0.1",
              "borrowed": "0",
              "interest": "0",
              "currency": "BTC",
              "locked": "0"
            },
            "quote": {
              "available": "0",
              "borrowed": "0",
              "interest": "0",
              "currency": "USDT",
              "locked": "0"
            }
          }
        ]
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表获取成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » uid string 用户 ID
    » available array 账户余额信息
    »» None object 某交易对的杠杆账户信息,base 对应交易货币的账户信息,quote 对应计价货币的账户信息
    »»» currency_pair string 交易对
    »»» locked boolean 账户是否被锁定
    »»» risk string 杠杆账户当前风险率
    »»» base object 货币账户信息
    »»»» currency string 货币名称
    »»»» available string 可用于杠杆交易的额度,available = 保证金 + borrowed
    »»»» locked string 冻结资金,如已经放在杠杆市场里挂单交易的数额
    »»»» borrowed string 借入资金
    »»»» interest string 未还利息
    »»» quote object 货币账户信息
    »»»» currency string 货币名称
    »»»» available string 可用于杠杆交易的额度,available = 保证金 + borrowed
    »»»» locked string 冻结资金,如已经放在杠杆市场里挂单交易的数额
    »»»» borrowed string 借入资金
    »»»» interest string 未还利息

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询子账号永续合约账户余额信息

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/sub_account_futures_balances'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/sub_account_futures_balances"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/sub_account_futures_balances

    查询子账号永续合约账户余额信息

    参数

    名称 位置 类型 必选 描述
    sub_uid 请求参数 string 子账号用户 ID,可查多笔中间用,隔开,不指定则返回所有子账号的记录
    settle 请求参数 string 指定查询某个结算币种的余额

    返回示例

    200 返回

    [
      {
        "uid": "10003",
        "available": {
          "BTC": "0.1",
          "GT": "2000",
          "USDT": "10"
        }
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表获取成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » uid string 用户 ID
    » available object 各结算账户信息
    »» additionalProperties object
    »»» total string 钱包余额是用户累计充值提现和盈亏结算(包括已实现盈亏, 资金费用,手续费及推荐返佣)之后的余额, 不包含未实现盈亏. total = SUM(history_dnw, history_pnl, history_fee, history_refr, history_fund)
    »»» unrealised_pnl string 未实现盈亏
    »»» position_margin string 头寸保证金
    »»» order_margin string 未完成订单的保证金
    »»» available string 可用的转出或交易的额度,统一账户下包含授信额度的可用额度(有包含体验金,体验金无法转出,所以要转出,转出金额需要扣除体验金)
    »»» point string 点卡数额
    »»» currency string 结算币种
    »»» in_dual_mode boolean 是否为双向持仓模式
    »»» enable_credit boolean 是否开启统一账户模式
    »»» position_initial_margin string 头寸占用的起始保证金,适用于统一账户模式
    »»» maintenance_margin string 头寸占用的维持保证金,适用于统一账户模式
    »»» bonus string 体验金
    »»» history object 累计统计数据
    »»»» dnw string 累计转入转出
    »»»» pnl string 累计交易盈亏
    »»»» fee string 累计手续费
    »»»» refr string 累计获取的推荐人返佣
    »»»» fund string 累计资金费用
    »»»» point_dnw string 累计点卡转入转出
    »»»» point_fee string 累计点卡抵扣手续费
    »»»» point_refr string 累计获取的点卡推荐人返佣
    »»»» bonus_dnw string 累计体验金转入转出
    »»»» bonus_offset string 累计体验金抵扣

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询子账号全仓杠杆账户余额信息

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/sub_account_cross_margin_balances'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/sub_account_cross_margin_balances"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/sub_account_cross_margin_balances

    查询子账号全仓杠杆账户余额信息

    参数

    名称 位置 类型 必选 描述
    sub_uid 请求参数 string 子账号用户 ID,可查多笔中间用,隔开,不指定则返回所有子账号的记录

    返回示例

    200 返回

    [
      {
        "uid": "100000",
        "available": {
          "user_id": 100003,
          "locked": false,
          "total": "20.000000",
          "borrowed": "0.000000",
          "interest": "0",
          "borrowed_net": "0",
          "net": "20",
          "leverage": "3",
          "risk": "9999.99",
          "total_initial_margin": "0.00",
          "total_margin_balance": "20.00",
          "total_maintenance_margin": "0.00",
          "total_initial_margin_rate": "9999.9900",
          "total_maintenance_margin_rate": "9999.9900",
          "total_available_margin": "20.00",
          "balances": {
            "USDT": {
              "available": "20.000000",
              "freeze": "0.000000",
              "borrowed": "0.000000",
              "interest": "0.000000"
            }
          }
        }
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表获取成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » uid string 用户 ID
    » available object
    »» user_id integer(int64) 全仓帐户用户ID,如果 0 代表这个子帐号尚未开通全仓帐户
    »» locked boolean 账户是否被锁定
    »» balances object
    »»» CrossMarginBalance object
    »»»» available string 可用额度
    »»»» freeze string 被锁定的额度
    »»»» borrowed string 借入额度
    »»»» interest string 未还利息
    »»» total string 折算成 USDT 的账户总资产,即所有币种(不包括点卡)的 (available+freeze)*price*discount 之和
    »»» borrowed string 折算成 USDT 的账户总借入数量,即所有币种(不包括点卡)的 borrowed*price*discount 之和
    »»» borrowed_net string 折算成 USDT 的账户总借入数量 * 放大系数
    »»» net string 折算成 USDT 的净资产
    »»» leverage string 杠杆倍数
    »»» interest string 折算成 USDT 的账户未接利息的总和,即所有币种(不包括点卡)的 interest*price*discount 之和
    »»» risk string 风险率,风险率小于 110% 会被爆仓,计算方式 total / (borrowed+interest)
    »»» total_initial_margin string 总初始保证金
    »»» total_margin_balance string 总保证金余额
    »»» total_maintenance_margin string 总维持保证金
    »»» total_initial_margin_rate string 总初始保证金率
    »»» total_maintenance_margin_rate string 总维持保证金率
    »»» total_available_margin string 可用的保证金额度

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询提币地址白名单

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/saved_address'
    query_param = 'currency=USDT'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/saved_address"
    query_param="currency=USDT"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/saved_address

    查询提币地址白名单

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 币种
    chain 请求参数 string 链名称
    limit 请求参数 string 列表返回的最大数量, 最多 100

    # 详细描述

    chain: 链名称

    limit: 列表返回的最大数量, 最多 100

    返回示例

    200 返回

    [
      {
        "currency": "usdt",
        "chain": "TRX",
        "address": "TWYirLzw2RARB2jfeFcfRPmeuU3rC7rakT",
        "name": "gate",
        "tag": "",
        "verified": "1"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表获取成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » currency string 币种
    » chain string 链名称
    » address string 地址
    » name string 名称
    » tag string 标签
    » verified string 是否通过验证 0-未验证, 1-已验正

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询个人交易费率

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/fee'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/fee"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/fee

    查询个人交易费率

    参数

    名称 位置 类型 必选 描述
    currency_pair 请求参数 string 指定交易对获取更准确的费率设置。
    settle 请求参数 string 指定合约的结算币种获取更准确的费率设置。

    # 详细描述

    currency_pair: 指定交易对获取更准确的费率设置。

    该字段可选,通常情况下所有交易对的费率设置是一样的。

    settle: 指定合约的结算币种获取更准确的费率设置。

    该字段可选,通常情况下所有结算币种的费率设置是一样的。

    # 枚举值列表

    参数
    settle BTC
    settle USDT
    settle USD

    返回示例

    200 返回

    {
      "user_id": 10001,
      "taker_fee": "0.002",
      "maker_fee": "0.002",
      "futures_taker_fee": "-0.00025",
      "futures_maker_fee": "0.00075",
      "gt_discount": false,
      "gt_taker_fee": "0",
      "gt_maker_fee": "0",
      "loan_fee": "0.18",
      "point_type": "1",
      "delivery_taker_fee": "0.00016",
      "delivery_maker_fee": "-0.00015",
      "debit_fee": 3
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » user_id integer(int64) 用户 ID
    » taker_fee string taker 费率
    » maker_fee string maker 费率
    » gt_discount boolean 是否开启 GT 抵扣折扣
    » gt_taker_fee string GT 抵扣 taker 费率,未开启 GT 抵扣则为 0
    » gt_maker_fee string GT 抵扣 maker 费率,未开启 GT 抵扣则为 0
    » loan_fee string 杠杆理财的费率
    » point_type string 点卡类型,0 - 初版点卡,1 - 202009 启用的新点卡
    » futures_taker_fee string 合约 taker 费率
    » futures_maker_fee string 合约 maker 费率
    » delivery_taker_fee string 交割合约 taker 费率
    » delivery_maker_fee string 交割合约 maker 费率
    » debit_fee integer 费率抵扣类型 , 1 - GT抵扣 , 2 - 点卡抵扣 , 3 - VIP费率

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询个人账户总额

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/total_balance'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/total_balance"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/total_balance

    查询个人账户总额

    该查询接口返回的是各账户里所有币按照传入币种折算之后的总估值,折算价以及相关各账户的余额信息最长会有1分钟的缓存, 不推荐在即时计算时使用该接口的数据。

    即时计算可根据账户类型查询对应的余额接口,如:

    • GET /spot/accounts 查询现货账户
    • GET /margin/accounts 查询杠杆账户
    • GET /futures/{settle}/accounts 查询合约账户

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 用于统计换算的目标货币类型,可接受BTC,CNY,USD,USDT四个值。USDT是默认值

    # 详细描述

    currency: 用于统计换算的目标货币类型,可接受BTC,CNY,USD,USDT四个值。USDT是默认值

    返回示例

    200 返回

    {
      "details": {
        "cross_margin": {
          "amount": "0",
          "currency": "USDT"
        },
        "spot": {
          "currency": "USDT",
          "amount": "42264489969935775.5160259954878034182418"
        },
        "finance": {
          "amount": "662714381.70310327810191647181",
          "currency": "USDT"
        },
        "margin": {
          "amount": "1259175.664137668554329559",
          "currency": "USDT",
          "borrowed": "0.00"
        },
        "quant": {
          "amount": "591702859674467879.6488202650892478553852",
          "currency": "USDT"
        },
        "futures": {
          "amount": "2384175.5606114082065",
          "currency": "USDT",
          "unrealised_pnl": "0.00"
        },
        "delivery": {
          "currency": "USDT",
          "amount": "1519804.9756702",
          "unrealised_pnl": "0.00"
        },
        "warrant": {
          "amount": "0",
          "currency": "USDT"
        },
        "cbbc": {
          "currency": "USDT",
          "amount": "0"
        }
      },
      "total": {
        "currency": "USDT",
        "amount": "633967350312281193.068368815439797304437",
        "unrealised_pnl": "0.00",
        "borrowed": "0.00"
      }
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 请求有效且成功返回 Inline

    返回格式

    状态码 200

    用户总资产信息

    名称 类型 描述
    » total object 换算成目标币种的账户总额
    »» amount string 账户总额数字
    »» currency string 币种
    »» unrealised_pnl string 未实现盈亏总和,这个字段只会在futures,options,delivery,total 账户中出现
    »» borrowed string 杠杆借贷总和,这个字段只会在margin,cross_margin账户中出现
    » details object 各账户总额

    - cross_margin: 全仓杠杆账户
    - spot: 现货账户
    - finance: 金融账户
    - margin: 杠杆账户
    - quant: 量化账户
    - futures: 永续合约账户
    - delivery: 交割合约账户
    - warrant: warrant 账户
    - cbbc: 牛熊证账户
    »» additionalProperties object 换算成目标币种的账户总额
    »»» amount string 账户总额数字
    »»» currency string 币种
    »»» unrealised_pnl string 未实现盈亏总和,这个字段只会在futures,options,delivery,total 账户中出现
    »»» borrowed string 杠杆借贷总和,这个字段只会在margin,cross_margin账户中出现

    # 枚举值列表

    属性
    currency BTC
    currency CNY
    currency USD
    currency USDT
    currency BTC
    currency CNY
    currency USD
    currency USDT

    WARNING

    该请求需要 API key 和 secret 认证

    # 获取可兑换的小额币种清单

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/small_balance'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/small_balance"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/small_balance

    获取可兑换的小额币种清单

    返回示例

    200 返回

    [
      {
        "currency": "FLOKI",
        "available_balance": "182.29400000",
        "estimated_as_btc": "0.00000012",
        "convertible_to_gt": "0.001080"
      },
      {
        "currency": "MBLK",
        "available_balance": "0.91723337",
        "estimated_as_btc": "0.00000102",
        "convertible_to_gt": "0.009188"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 成功 Inline

    返回格式

    状态码 200

    小额兑换币种

    名称 类型 描述
    » currency string 币种
    » available_balance string 可转换金额
    » estimated_as_btc string 预计用 BTC 计价金额
    » convertible_to_gt string 预计可转换成多少 GT

    WARNING

    该请求需要 API key 和 secret 认证

    # 兑换的小额币种

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/small_balance'
    query_param = ''
    body='{"currency":["FLOKI","MBLK"]}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/wallet/small_balance"
    query_param=""
    body_param='{"currency":["FLOKI","MBLK"]}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /wallet/small_balance

    兑换的小额币种

    请求体示例

    {
      "currency": [
        "FLOKI",
        "MBLK"
      ]
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » currency body array 需要被兑换的币种

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 成功

    WARNING

    该请求需要 API key 和 secret 认证

    # 获取可兑换的小额币种历史纪录

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/wallet/small_balance_history'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/wallet/small_balance_history"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /wallet/small_balance_history

    获取可兑换的小额币种历史纪录

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 兑换的币种
    page 请求参数 integer(int32) 列表页数
    limit 请求参数 integer(int32) 列表返回的最大数量。默认为100,最小1,最大100。

    返回示例

    200 返回

    [
      {
        "id": "28583810",
        "create_time": 1706670777,
        "currency": "FLOKI",
        "amount": "182.29400000",
        "gt_amount": "0.001079"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 成功 Inline

    返回格式

    状态码 200

    小额兑换币种

    名称 类型 描述
    » id string 订单ID
    » currency string 兑换币种
    » amount string 兑换数量
    » gt_amount string 被兑换到的 GT 数量
    » create_time integer(int64) 兑换时间(秒)

    WARNING

    该请求需要 API key 和 secret 认证

    # SubAccount

    子账户管理

    # 创建新的子账户

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts'
    query_param = ''
    body='{"remark":"remark","login_name":"sub_account_for_trades"}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/sub_accounts"
    query_param=""
    body_param='{"remark":"remark","login_name":"sub_account_for_trades"}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /sub_accounts

    创建新的子账户

    请求体示例

    {
      "remark": "remark",
      "login_name": "sub_account_for_trades"
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » remark body string 备注
    » login_name body string 子账户登陆名:仅支持字母、数字、下划线,不可包含其他非法字符。
    » password body string 子账户密码
    » email body string 子账户邮箱

    # 详细描述

    » password: 子账户密码 不传默认跟随主账户

    » email: 子账户邮箱 不传默认跟随主账户

    返回示例

    201 返回

    {
      "remark": "remark",
      "login_name": "sub_account_for_trades",
      "user_id": 10001,
      "state": 1,
      "create_time": 168888888
    }
    

    返回

    状态码 含义 描述 格式
    201 Created (opens new window) 创建成功 Inline

    返回格式

    状态码 201

    名称 类型 描述
    » remark string 备注
    » login_name string 子账户登陆名:仅支持字母、数字、下划线,不可包含其他非法字符。
    » password string 子账户密码
    不传默认跟随主账户
    » email string 子账户邮箱
    不传默认跟随主账户
    » state integer(int32) 子账户状态 1正常,2冻结
    » type integer(int32) 子账号类型 1-普通子账号 3-全仓杠杆子账户
    » user_id integer(int64) 子账户 user_id
    » create_time integer(int64) 创建时间戳

    WARNING

    该请求需要 API key 和 secret 认证

    # 获取子账户列表

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/sub_accounts"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /sub_accounts

    获取子账户列表

    参数

    名称 位置 类型 必选 描述
    type 请求参数 string 输入 0 则列出所有类型子账户(目前支持全仓杠杆子账户和普通子账户)输入1查询普通子账户,如果不传默认只查询普通子账户。

    返回示例

    200 返回

    [
      {
        "remark": "remark",
        "login_name": "sub_account_for_trades",
        "user_id": 10001,
        "state": 1,
        "create_time": 168888888
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    None array
    » remark string 备注
    » login_name string 子账户登陆名:仅支持字母、数字、下划线,不可包含其他非法字符。
    » password string 子账户密码
    不传默认跟随主账户
    » email string 子账户邮箱
    不传默认跟随主账户
    » state integer(int32) 子账户状态 1正常,2冻结
    » type integer(int32) 子账号类型 1-普通子账号 3-全仓杠杆子账户
    » user_id integer(int64) 子账户 user_id
    » create_time integer(int64) 创建时间戳

    WARNING

    该请求需要 API key 和 secret 认证

    # 获取子账户

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts/0'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/sub_accounts/0"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /sub_accounts/{user_id}

    获取子账户

    参数

    名称 位置 类型 必选 描述
    user_id URL integer(int64) 子账户 UserID

    返回示例

    200 返回

    {
      "remark": "remark",
      "login_name": "sub_account_for_trades",
      "user_id": 10001,
      "state": 1,
      "create_time": 168888888
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 获取成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » remark string 备注
    » login_name string 子账户登陆名:仅支持字母、数字、下划线,不可包含其他非法字符。
    » password string 子账户密码
    不传默认跟随主账户
    » email string 子账户邮箱
    不传默认跟随主账户
    » state integer(int32) 子账户状态 1正常,2冻结
    » type integer(int32) 子账号类型 1-普通子账号 3-全仓杠杆子账户
    » user_id integer(int64) 子账户 user_id
    » create_time integer(int64) 创建时间戳

    WARNING

    该请求需要 API key 和 secret 认证

    # 创建新的子账户 API 密钥对

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts/0/keys'
    query_param = ''
    body='{"mode":1,"name":"spot","perms":[{"read_only":false,"name":"options"},{"read_only":false,"name":"spot"},{"read_only":false,"name":"delivery"},{"read_only":false,"name":"wallet"},{"read_only":false,"name":"futures"}],"ip_whitelist":["127.0.0.1","127.0.0.2"]}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/sub_accounts/0/keys"
    query_param=""
    body_param='{"mode":1,"name":"spot","perms":[{"read_only":false,"name":"options"},{"read_only":false,"name":"spot"},{"read_only":false,"name":"delivery"},{"read_only":false,"name":"wallet"},{"read_only":false,"name":"futures"}],"ip_whitelist":["127.0.0.1","127.0.0.2"]}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /sub_accounts/{user_id}/keys

    创建新的子账户 API 密钥对

    请求体示例

    {
      "mode": 1,
      "name": "spot",
      "perms": [
        {
          "read_only": false,
          "name": "options"
        },
        {
          "read_only": false,
          "name": "spot"
        },
        {
          "read_only": false,
          "name": "delivery"
        },
        {
          "read_only": false,
          "name": "wallet"
        },
        {
          "read_only": false,
          "name": "futures"
        }
      ],
      "ip_whitelist": [
        "127.0.0.1",
        "127.0.0.2"
      ]
    }
    

    参数

    名称 位置 类型 必选 描述
    user_id URL integer(int64) 子账户 UserID
    body body SubAccountKey
    » mode body integer(int32) 模式 1 - 经典帐户 2 - 统一账户
    » name body string API Key名称
    » perms body array
    »» name body string 权限功能名称(不传值即为清空)
    »» read_only body boolean 该功能是否只读
    » ip_whitelist body array IP白名单列表(不传值即为清空)

    # 详细描述

    »» name: 权限功能名称(不传值即为清空)

    • wallet: 钱包
    • spot: 现货/杠杆
    • futures: 永续合约
    • delivery: 交割合约
    • earn: 理财
    • options: 期权
    • account: 账户信息
    • unified: 统一账户
    • loan: 借贷

    # 枚举值列表

    参数
    »» name wallet
    »» name spot
    »» name futures
    »» name delivery
    »» name earn
    »» name options
    »» name account
    »» name unified
    »» name loan

    返回示例

    200 返回

    {
      "state": 1,
      "name": "spot",
      "user_id": 100000,
      "perms": [
        {
          "name": "options",
          "read_only": false
        },
        {
          "name": "spot",
          "read_only": false
        },
        {
          "name": "delivery",
          "read_only": false
        },
        {
          "name": "wallet",
          "read_only": false
        },
        {
          "name": "futures",
          "read_only": false
        }
      ],
      "ip_whitelist": [
        "127.0.0.1",
        "127.0.0.2"
      ],
      "mode": 1,
      "secret": "cddcc6e5e78060e013860bdbe5e737830b96821c027664586fb38b411808f4fd",
      "key": "eb8815bf99d7bb5f8ad6497bdc4774a8",
      "created_at": 1663683330,
      "updated_at": 1663683330
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 创建成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » user_id string 用户ID
    » mode integer(int32) 模式 1 - 经典帐户 2 - 统一账户
    » name string API Key名称
    » perms array
    »» name string 权限功能名称(不传值即为清空)
    - wallet: 钱包
    - spot: 现货/杠杆
    - futures: 永续合约
    - delivery: 交割合约
    - earn: 理财
    - options: 期权
    - account: 账户信息
    - unified: 统一账户
    - loan: 借贷
    »» read_only boolean 该功能是否只读
    » ip_whitelist array IP白名单列表(不传值即为清空)
    » key string API Key
    » state integer(int32) 状态 1 - 正常 2 - 冻结 3 - 锁定
    » created_at string 创建时间
    » updated_at string 最近更新时间

    # 枚举值列表

    属性
    name wallet
    name spot
    name futures
    name delivery
    name earn
    name options
    name account
    name unified
    name loan

    WARNING

    该请求需要 API key 和 secret 认证

    # 获取子账户所有密钥对

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts/0/keys'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/sub_accounts/0/keys"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /sub_accounts/{user_id}/keys

    获取子账户所有密钥对

    参数

    名称 位置 类型 必选 描述
    user_id URL integer 子账户 UserID

    返回示例

    200 返回

    [
      {
        "state": 1,
        "name": "spot",
        "user_id": 1000000,
        "perms": [
          {
            "name": "futures",
            "read_only": false
          },
          {
            "name": "wallet",
            "read_only": false
          },
          {
            "name": "delivery",
            "read_only": false
          },
          {
            "name": "options",
            "read_only": false
          },
          {
            "name": "spot",
            "read_only": false
          }
        ],
        "mode": 1,
        "ip_whitelist": [
          "127.0.0.1",
          "127.0.0.2"
        ],
        "key": "75c3264105b74693d8cb5c7f1a8e2420",
        "created_at": 1663642892,
        "update_at": 1663642892
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [SubAccountKey]

    WARNING

    该请求需要 API key 和 secret 认证

    # 修改子账户 API 密钥对

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts/0/keys/string'
    query_param = ''
    body='{"mode":1,"name":"spot","perms":[{"read_only":false,"name":"options"},{"read_only":false,"name":"spot"},{"read_only":false,"name":"delivery"},{"read_only":false,"name":"wallet"},{"read_only":false,"name":"futures"}],"ip_whitelist":["127.0.0.1","127.0.0.2"]}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('PUT', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('PUT', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="PUT"
    url="/sub_accounts/0/keys/string"
    query_param=""
    body_param='{"mode":1,"name":"spot","perms":[{"read_only":false,"name":"options"},{"read_only":false,"name":"spot"},{"read_only":false,"name":"delivery"},{"read_only":false,"name":"wallet"},{"read_only":false,"name":"futures"}],"ip_whitelist":["127.0.0.1","127.0.0.2"]}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    PUT /sub_accounts/{user_id}/keys/{key}

    修改子账户 API 密钥对

    请求体示例

    {
      "mode": 1,
      "name": "spot",
      "perms": [
        {
          "read_only": false,
          "name": "options"
        },
        {
          "read_only": false,
          "name": "spot"
        },
        {
          "read_only": false,
          "name": "delivery"
        },
        {
          "read_only": false,
          "name": "wallet"
        },
        {
          "read_only": false,
          "name": "futures"
        }
      ],
      "ip_whitelist": [
        "127.0.0.1",
        "127.0.0.2"
      ]
    }
    

    参数

    名称 位置 类型 必选 描述
    user_id URL integer 子账户 UserID
    key URL string 子账户 APIKey
    body body SubAccountKey
    » mode body integer(int32) 模式 1 - 经典帐户 2 - 统一账户
    » name body string API Key名称
    » perms body array
    »» name body string 权限功能名称(不传值即为清空)
    »» read_only body boolean 该功能是否只读
    » ip_whitelist body array IP白名单列表(不传值即为清空)

    # 详细描述

    »» name: 权限功能名称(不传值即为清空)

    • wallet: 钱包
    • spot: 现货/杠杆
    • futures: 永续合约
    • delivery: 交割合约
    • earn: 理财
    • options: 期权
    • account: 账户信息
    • unified: 统一账户
    • loan: 借贷

    # 枚举值列表

    参数
    »» name wallet
    »» name spot
    »» name futures
    »» name delivery
    »» name earn
    »» name options
    »» name account
    »» name unified
    »» name loan

    返回

    状态码 含义 描述 格式
    204 No Content (opens new window) 修改成功

    WARNING

    该请求需要 API key 和 secret 认证

    # 删除子账户 API 密钥对

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts/0/keys/string'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('DELETE', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('DELETE', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="DELETE"
    url="/sub_accounts/0/keys/string"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    DELETE /sub_accounts/{user_id}/keys/{key}

    删除子账户 API 密钥对

    参数

    名称 位置 类型 必选 描述
    user_id URL integer 子账户 UserID
    key URL string 子账户 APIKey

    返回

    状态码 含义 描述 格式
    204 No Content (opens new window) 删除成功

    WARNING

    该请求需要 API key 和 secret 认证

    # 获取子账户 API 特定密钥对

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts/0/keys/string'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/sub_accounts/0/keys/string"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /sub_accounts/{user_id}/keys/{key}

    获取子账户 API 特定密钥对

    参数

    名称 位置 类型 必选 描述
    user_id URL integer 子账户 UserID
    key URL string 子账户 APIKey

    返回示例

    200 返回

    {
      "state": 1,
      "name": "spot",
      "user_id": 1000000,
      "perms": [
        {
          "name": "futures",
          "read_only": false
        },
        {
          "name": "wallet",
          "read_only": false
        },
        {
          "name": "delivery",
          "read_only": false
        },
        {
          "name": "options",
          "read_only": false
        },
        {
          "name": "spot",
          "read_only": false
        }
      ],
      "mode": 1,
      "ip_whitelist": [
        "127.0.0.1",
        "127.0.0.2"
      ],
      "key": "75c3264105b74693d8cb5c7f1a8e2420",
      "created_at": 1663642892,
      "update_at": 1663642892
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 获取成功 SubAccountKey

    WARNING

    该请求需要 API key 和 secret 认证

    # 锁定子账户

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts/0/lock'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/sub_accounts/0/lock"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /sub_accounts/{user_id}/lock

    锁定子账户

    参数

    名称 位置 类型 必选 描述
    user_id URL integer(int64) 子账户UserID

    返回

    状态码 含义 描述 格式
    204 No Content (opens new window) 锁定成功

    WARNING

    该请求需要 API key 和 secret 认证

    # 解锁子账户

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/sub_accounts/0/unlock'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/sub_accounts/0/unlock"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /sub_accounts/{user_id}/unlock

    解锁子账户

    参数

    名称 位置 类型 必选 描述
    user_id URL integer(int64) 子账户UserID

    返回

    状态码 含义 描述 格式
    204 No Content (opens new window) 解锁成功

    WARNING

    该请求需要 API key 和 secret 认证

    # Unified

    统一账户

    # 获取统一账户信息

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/accounts'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/unified/accounts"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /unified/accounts

    获取统一账户信息

    账户内的各币种资产将会根据其流动性,定义相应的调整系数,再统一折算为USD,来统一计算账户的资产及持仓价值

    具体公式可查询保证金公式

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定币种名称查询

    返回示例

    200 返回

    {
      "user_id": 10001,
      "locked": false,
      "balances": {
        "ETH": {
          "available": "0",
          "freeze": "0",
          "borrowed": "0.075393666654",
          "negative_liab": "0",
          "futures_pos_liab": "0",
          "equity": "1016.1",
          "total_freeze": "0",
          "total_liab": "0"
        },
        "POINT": {
          "available": "9999999999.017023138734",
          "freeze": "0",
          "borrowed": "0",
          "negative_liab": "0",
          "futures_pos_liab": "0",
          "equity": "12016.1",
          "total_freeze": "0",
          "total_liab": "0"
        },
        "USDT": {
          "available": "0.00000062023",
          "freeze": "0",
          "borrowed": "0",
          "negative_liab": "0",
          "futures_pos_liab": "0",
          "equity": "16.1",
          "total_freeze": "0",
          "total_liab": "0"
        }
      },
      "total": "230.94621713",
      "borrowed": "161.66395521",
      "total_initial_margin": "1025.0524665088",
      "total_margin_balance": "3382495.944473949183",
      "total_maintenance_margin": "205.01049330176",
      "total_initial_margin_rate": "3299.827135672679",
      "total_maintenance_margin_rate": "16499.135678363399",
      "total_available_margin": "3381470.892007440383",
      "unified_account_total": "3381470.892007440383",
      "unified_account_total_liab": "0",
      "unified_account_total_equity": "100016.1",
      "leverage": "2"
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » user_id integer(int64) 用户 ID
    » refresh_time integer(int64) 最近一次刷新时间
    » locked boolean 账户是否被锁定
    » balances object
    »» UnifiedBalance object
    »»» available string 可用额度
    »»» freeze string 被锁定的额度
    »»» borrowed string 借入额度
    »»» negative_liab string 负余额借贷
    »»» futures_pos_liab string 合约开仓借币
    »»» equity string 权益
    »»» total_freeze string 总占用
    »»» total_liab string 总借款
    »» total string 折算成 USD 的账户总资产,即所有币种 (available + freeze) * price 之和
    »» borrowed string 折算成 USD 的账户总借入数量,即所有币种(不包括点卡)的 borrowed * price 之和
    »» total_initial_margin string 总初始保证金
    »» total_margin_balance string 总保证金余额
    »» total_maintenance_margin string 总维持保证金
    »» total_initial_margin_rate string 总初始保证金率
    »» total_maintenance_margin_rate string 总维持保证金率
    »» total_available_margin string 可用的保证金额度
    »» unified_account_total string 统一账户总资产
    »» unified_account_total_liab string 统一账户总借贷
    »» unified_account_total_equity string 统一账户总权益
    »» leverage string 实际杠杆

    WARNING

    该请求需要 API key 和 secret 认证

    # 设置统一账户模式

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/account_mode'
    query_param = ''
    body='{"mode":"cross_margin","enabled":true}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/unified/account_mode"
    query_param=""
    body_param='{"mode":"cross_margin","enabled":true}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /unified/account_mode

    设置统一账户模式

    请求体示例

    {
      "mode": "cross_margin",
      "enabled": true
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » mode body string 保证金模式
    » enabled body boolean 是否启用

    # 详细描述

    » mode: 保证金模式

    • cross_margin : 现货全仓保证金
    • usdt_futures : USDT永续合约组合保证金

    返回示例

    200 返回

    {
      "cross_margin": true,
      "usdt_futures": true
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 设置成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » additionalProperties boolean

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询统一账户模式

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/account_mode'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/unified/account_mode"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /unified/account_mode

    查询统一账户模式

    cross_margin - 现货全仓保证金, usdt_futures - USDT永续合约组合保证金

    返回示例

    200 返回

    {
      "cross_margin": true,
      "usdt_futures": true
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » additionalProperties boolean

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询统一账户最多可借入

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/borrowable'
    query_param = 'currency=BTC'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/unified/borrowable"
    query_param="currency=BTC"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /unified/borrowable

    查询统一账户最多可借入

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定币种名称查询

    返回示例

    200 返回

    {
      "currency": "ETH",
      "amount": "10000"
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 Inline

    返回格式

    状态码 200

    UnifiedBorrowable

    名称 类型 描述
    » currency string 币种信息
    » amount string 最多可借入的额度

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询统一账户最多可转出

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/transferable'
    query_param = 'currency=BTC'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/unified/transferable"
    query_param="currency=BTC"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /unified/transferable

    查询统一账户最多可转出

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定币种名称查询

    返回示例

    200 返回

    {
      "currency": "ETH",
      "amount": "10000"
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 Inline

    返回格式

    状态码 200

    UnifiedTransferable

    名称 类型 描述
    » currency string 币种信息
    » amount string 最多可转出的额度

    WARNING

    该请求需要 API key 和 secret 认证

    # 借入或还款

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/loans'
    query_param = ''
    body='{"currency":"BTC","amount":"0.1","type":"borrow","repaid_all":false,"text":"t-test"}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/unified/loans"
    query_param=""
    body_param='{"currency":"BTC","amount":"0.1","type":"borrow","repaid_all":false,"text":"t-test"}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /unified/loans

    借入或还款

    借入时必须保证不能少于币种最小借入量,不能超过平台及用户最大可借数量

    借款利息会定期从账户自动扣除,用户需自主处理借款部分的还款

    还款支持repaid_all=true全部还款

    请求体示例

    {
      "currency": "BTC",
      "amount": "0.1",
      "type": "borrow",
      "repaid_all": false,
      "text": "t-test"
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » currency body string 币种
    » type body string 类型 , borrow - 借入 , repay - 还款
    » amount body string 借入或还款数量
    » repaid_all body boolean 全部还款,仅还款操作使用,为 true 时覆盖 amount ,直接全部还款
    » text body string 用户自定义 ID

    # 枚举值列表

    参数
    » type borrow
    » type repay

    返回

    状态码 含义 描述 格式
    204 No Content (opens new window) 操作成功

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询借贷

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/loans'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/unified/loans"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /unified/loans

    查询借贷

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定币种名称查询
    page 请求参数 integer(int32) 列表页数
    limit 请求参数 integer(int32) 列表返回的最大数量。默认为100,最小1,最大100。
    type 请求参数 string 借贷类型,平台借币 - platform,杠杆借币 - margin

    返回示例

    200 返回

    [
      {
        "currency": "USDT",
        "currency_pari": "GT_USDT",
        "amount": "1",
        "type": "margin",
        "change_time": 1673247054000,
        "create_time": 1673247054000
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    None array [借贷]
    » None object 借贷
    »» currency string 币种
    »» currency_pair string 交易对
    »» amount string 待归还数量
    »» type string 借贷类型,平台借币 - platform,杠杆借币 - margin
    »» create_time integer(int64) 创建时间戳
    »» update_time integer(int64) 最近更新时间戳

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询借贷记录

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/loan_records'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/unified/loan_records"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /unified/loan_records

    查询借贷记录

    参数

    名称 位置 类型 必选 描述
    type 请求参数 string 借贷记录类型 , borrow - 借入 , repay - 还款
    currency 请求参数 string 指定币种名称查询
    page 请求参数 integer(int32) 列表页数
    limit 请求参数 integer(int32) 列表返回的最大数量。默认为100,最小1,最大100。

    返回示例

    200 返回

    [
      {
        "id": 16442,
        "type": "borrow",
        "margin_mode": "cross",
        "currency_pair": "AE_USDT",
        "currency": "USDT",
        "amount": "1000",
        "create_time": 1673247054000,
        "repayment_type": "auto_repay"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » None object 借贷记录
    »» id integer(int64) id
    »» type string 类型 , borrow - 借入 , repay - 还款
    »» repayment_type string 还款类型 , none - 无还款类型, manual_repay - 手动还款 , auto_repay - 自动还款, cancel_auto_repay - 撤单后自动还款
    »» currency_pair string 交易对
    »» currency string 币种
    »» amount string 借入或还款数量
    »» create_time integer(int64) 创建时间戳

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询扣息记录

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/interest_records'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/unified/interest_records"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /unified/interest_records

    查询扣息记录

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定币种名称查询
    page 请求参数 integer(int32) 列表页数
    limit 请求参数 integer(int32) 列表返回的最大数量。默认为100,最小1,最大100。
    type 请求参数 string 借贷类型,平台借币 - platform,杠杆借币 - margin

    返回示例

    200 返回

    [
      {
        "status": 1,
        "currency_pair": "BTC_USDT",
        "currency": "USDT",
        "actual_rate": "0.00000236",
        "interest": "0.00006136",
        "type": "platform",
        "create_time": 1673247054000
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    None array [扣息记录]
    » None object 扣息记录
    »» currency string 币种名称
    »» currency_pair string 交易对
    »» actual_rate string 实际利率
    »» interest string 利息
    »» status integer 状态 0 - 失败 , 1 - 成功
    »» type string 平台借币 - platform,杠杆借币 - margin
    »» create_time integer(int64) 创建时间戳

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询统一账户的预估利率

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/estimate_rate'
    query_param = 'currencies=BTC,GT'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/unified/estimate_rate"
    query_param="currencies=BTC,GT"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /unified/estimate_rate

    查询统一账户的预估利率

    因为利率每小时会随借贷深度变化,不能提供完全精确的利率;当币种不支持时,返回利率为空字符串

    参数

    名称 位置 类型 必选 描述
    currencies 请求参数 array[string] 指定币种名称查询数组,数组用逗号分割,最大10个

    返回示例

    200 返回

    {
      "BTC": "0.000002",
      "GT": "0.000001",
      "ETH": ""
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 Inline

    返回格式

    状态码 200

    预估当前小时的借贷利率,按币种进行返回

    名称 类型 描述
    » additionalProperties string

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询统一账户梯度式discount

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/unified/currency_discount_tiers'
    query_param = ''
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/unified/currency_discount_tiers \
      -H 'Accept: application/json'
    
    

    GET /unified/currency_discount_tiers

    查询统一账户梯度式discount

    返回示例

    200 返回

    [
      [
        {
          "currency": "USDT",
          "discount_tiers": [
            {
              "tier": "1",
              "discount": "1",
              "lower_limit": "0",
              "upper_limit": "+"
            }
          ]
        },
        {
          "currency": "USDC",
          "discount_tiers": [
            {
              "tier": "1",
              "discount": "1",
              "lower_limit": "0",
              "upper_limit": "10000000"
            },
            {
              "tier": "2",
              "discount": "0.98",
              "lower_limit": "10000000",
              "upper_limit": "15000000"
            },
            {
              "tier": "3",
              "discount": "0.95",
              "lower_limit": "15000000",
              "upper_limit": "20000000"
            },
            {
              "tier": "4",
              "discount": "0.925",
              "lower_limit": "20000000",
              "upper_limit": "50000000"
            },
            {
              "tier": "5",
              "discount": "0.9",
              "lower_limit": "50000000",
              "upper_limit": "100000000"
            },
            {
              "tier": "6",
              "discount": "0",
              "lower_limit": "100000000",
              "upper_limit": "+"
            }
          ]
        },
        {
          "currency": "BTC",
          "discount_tiers": [
            {
              "tier": "1",
              "discount": "0.98",
              "lower_limit": "0",
              "upper_limit": "1000"
            },
            {
              "tier": "2",
              "discount": "0.95",
              "lower_limit": "1000",
              "upper_limit": "10000"
            },
            {
              "tier": "3",
              "discount": "0.9",
              "lower_limit": "10000",
              "upper_limit": "50000"
            },
            {
              "tier": "4",
              "discount": "0.85",
              "lower_limit": "50000",
              "upper_limit": "+"
            }
          ]
        },
        {
          "currency": "ETH",
          "discount_tiers": [
            {
              "tier": "1",
              "discount": "0.98",
              "lower_limit": "0",
              "upper_limit": "1000"
            },
            {
              "tier": "2",
              "discount": "0.95",
              "lower_limit": "1000",
              "upper_limit": "10000"
            },
            {
              "tier": "3",
              "discount": "0.9",
              "lower_limit": "10000",
              "upper_limit": "50000"
            },
            {
              "tier": "4",
              "discount": "0.85",
              "lower_limit": "50000",
              "upper_limit": "+"
            }
          ]
        }
      ]
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » None object 统一账户梯度discount
    »» currency string 币种名称
    »» discount_tiers array 阶梯式discount
    »»» tier string 档位
    »»» discount string 保证金折扣系数
    »»» lower_limit string 下限
    »»» upper_limit string 上限, +表示正无穷

    # Spot

    现货交易

    # 查询所有币种信息

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/currencies'
    query_param = ''
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/spot/currencies \
      -H 'Accept: application/json'
    
    

    GET /spot/currencies

    查询所有币种信息

    币种标识有两种类型:

    1. 仅币种名称,如 BTC, USDT
    2. <币>_<链>,如 HT_ETH

    后者是一个币种对应多个链时会出现。不管是哪种类型,币种信息里都会包含 chain 字段来标识链信息。 使用币种信息时可以通过该单币种名称以及 <币>_ 开头的币种名称来获取某个币对应的所有链的信息。

    返回示例

    200 返回

    [
      {
        "currency": "GT",
        "delisted": false,
        "withdraw_disabled": false,
        "withdraw_delayed": false,
        "deposit_disabled": false,
        "trade_disabled": false,
        "chain": "GT"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    None array
    » currency string 币种名称
    » delisted boolean 是否下架
    » withdraw_disabled boolean 是否暂停提现
    » withdraw_delayed boolean 提现是否存在延迟
    » deposit_disabled boolean 是否暂停充值
    » trade_disabled boolean 是否暂停交易
    » fixed_rate string 固定交易手续费率。仅限固定交易费率的币种,普通币种该字段无效
    » chain string 币对应的链

    # 查询单个币种信息

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/currencies/GT'
    query_param = ''
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/spot/currencies/GT \
      -H 'Accept: application/json'
    
    

    GET /spot/currencies/{currency}

    查询单个币种信息

    参数

    名称 位置 类型 必选 描述
    currency URL string 币种名称

    返回示例

    200 返回

    {
      "currency": "GT",
      "delisted": false,
      "withdraw_disabled": false,
      "withdraw_delayed": false,
      "deposit_disabled": false,
      "trade_disabled": false,
      "chain": "GT"
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » currency string 币种名称
    » delisted boolean 是否下架
    » withdraw_disabled boolean 是否暂停提现
    » withdraw_delayed boolean 提现是否存在延迟
    » deposit_disabled boolean 是否暂停充值
    » trade_disabled boolean 是否暂停交易
    » fixed_rate string 固定交易手续费率。仅限固定交易费率的币种,普通币种该字段无效
    » chain string 币对应的链

    # 查询支持的所有交易对

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/currency_pairs'
    query_param = ''
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/spot/currency_pairs \
      -H 'Accept: application/json'
    
    

    GET /spot/currency_pairs

    查询支持的所有交易对

    返回示例

    200 返回

    [
      {
        "id": "ETH_USDT",
        "base": "ETH",
        "quote": "USDT",
        "fee": "0.2",
        "min_base_amount": "0.001",
        "min_quote_amount": "1.0",
        "max_base_amount": "10000",
        "max_quote_amount": "10000000",
        "amount_precision": 3,
        "precision": 6,
        "trade_status": "tradable",
        "sell_start": 1516378650,
        "buy_start": 1516378650
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询到所有交易对 [CurrencyPair]

    # 查询单个交易对详情

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/currency_pairs/ETH_BTC'
    query_param = ''
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/spot/currency_pairs/ETH_BTC \
      -H 'Accept: application/json'
    
    

    GET /spot/currency_pairs/{currency_pair}

    查询单个交易对详情

    参数

    名称 位置 类型 必选 描述
    currency_pair URL string 交易对

    返回示例

    200 返回

    {
      "id": "ETH_USDT",
      "base": "ETH",
      "quote": "USDT",
      "fee": "0.2",
      "min_base_amount": "0.001",
      "min_quote_amount": "1.0",
      "max_base_amount": "10000",
      "max_quote_amount": "10000000",
      "amount_precision": 3,
      "precision": 6,
      "trade_status": "tradable",
      "sell_start": 1516378650,
      "buy_start": 1516378650
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 成功查询 CurrencyPair

    # 获取交易对 ticker 信息

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/tickers'
    query_param = ''
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/spot/tickers \
      -H 'Accept: application/json'
    
    

    GET /spot/tickers

    获取交易对 ticker 信息

    如果指定 currency_pair 则只查询该交易对,否则返回全部信息

    参数

    名称 位置 类型 必选 描述
    currency_pair 请求参数 string 交易对
    timezone 请求参数 string 时区

    # 枚举值列表

    参数
    timezone utc0
    timezone utc8
    timezone all

    返回示例

    200 返回

    [
      {
        "currency_pair": "BTC3L_USDT",
        "last": "2.46140352",
        "lowest_ask": "2.477",
        "highest_bid": "2.4606821",
        "change_percentage": "-8.91",
        "change_utc0": "-8.91",
        "change_utc8": "-8.91",
        "base_volume": "656614.0845820589",
        "quote_volume": "1602221.66468375534639404191",
        "high_24h": "2.7431",
        "low_24h": "1.9863",
        "etf_net_value": "2.46316141",
        "etf_pre_net_value": "2.43201848",
        "etf_pre_timestamp": 1611244800,
        "etf_leverage": "2.2803019447281203"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 成功查询 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » currency_pair string 交易对
    » last string 最新成交价
    » lowest_ask string 最新卖方最低价
    » highest_bid string 最新买方最高价
    » change_percentage string 最近24h涨跌百分比,跌用负数标识,如 -7.45
    » change_utc0 string utc0时区,最近24h涨跌百分比,跌用负数标识,如 -7.45
    » change_utc8 string utc8时区,最近24h涨跌百分比,跌用负数标识,如 -7.45
    » base_volume string 最近24h交易货币成交量
    » quote_volume string 最近24h计价货币成交量
    » high_24h string 24小时最高价
    » low_24h string 24小时最低价
    » etf_net_value string ETF 净值
    » etf_pre_net_value string|null ETF 前一再平衡点净值
    » etf_pre_timestamp integer(int64)|null ETF 前一再平衡时间
    » etf_leverage string|null ETF 当前杠杆率

    # 获取市场深度信息

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/order_book'
    query_param = 'currency_pair=BTC_USDT'
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/spot/order_book?currency_pair=BTC_USDT \
      -H 'Accept: application/json'
    
    

    GET /spot/order_book

    获取市场深度信息

    市场深度买单会按照价格从高到低排序,卖单反之

    参数

    名称 位置 类型 必选 描述
    currency_pair 请求参数 string 交易对
    interval 请求参数 string 合并深度指定的价格精度,0 为不合并,不指定则默认为 0
    limit 请求参数 integer 深度档位数量
    with_id 请求参数 boolean 返回深度更新 ID

    返回示例

    200 返回

    {
      "id": 123456,
      "current": 1623898993123,
      "update": 1623898993121,
      "asks": [
        [
          "1.52",
          "1.151"
        ],
        [
          "1.53",
          "1.218"
        ]
      ],
      "bids": [
        [
          "1.17",
          "201.863"
        ],
        [
          "1.16",
          "725.464"
        ]
      ]
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 成功查询 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » id integer(int64) 深度更新ID。深度每发生一次变化,ID 就会更新一次。仅在 with_id 设置为 true 该值有效
    » current integer(int64) 接口数据返回 ms 时间戳
    » update integer(int64) 深度变化 ms 时间戳
    » asks array 卖方深度列表
    »» None array 价格,数量的二元组
    » bids array 买方深度列表
    »» None array 价格,数量的二元组

    # 查询市场成交记录

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/trades'
    query_param = 'currency_pair=BTC_USDT'
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/spot/trades?currency_pair=BTC_USDT \
      -H 'Accept: application/json'
    
    

    GET /spot/trades

    查询市场成交记录

    支持指定 fromto 按时间范围查询或基于 last_id 的翻页查询。默认按时间范围查询。

    基于 last_id 翻页的查询方式不再推荐继续使用。如果指定 last_id ,时间范围查询参数会被忽略。

    参数

    名称 位置 类型 必选 描述
    currency_pair 请求参数 string 交易对
    limit 请求参数 integer(int32) 列表返回的最大数量。默认为100,最小1,最大1000。
    last_id 请求参数 string 以上个列表的最后一条记录的 ID 作为下个列表的起点
    reverse 请求参数 boolean 是否获取小于 last_id 的数据,默认返回大于 last_id 的记录。
    from 请求参数 integer(int64) 查询记录的起始时间
    to 请求参数 integer(int64) 查询记录的结束时间,不指定则默认为当前时间
    page 请求参数 integer(int32) 列表页数

    # 详细描述

    reverse: 是否获取小于 last_id 的数据,默认返回大于 last_id 的记录。

    设置该字段为 true 可以用来回溯市场成交记录,为 false 可以用来获取最新成交。

    last_id 未设置时,该字段无效。

    返回示例

    200 返回

    [
      {
        "id": "1232893232",
        "create_time": "1548000000",
        "create_time_ms": "1548000000123.456",
        "order_id": "4128442423",
        "side": "buy",
        "role": "maker",
        "amount": "0.15",
        "price": "0.03",
        "fee": "0.0005",
        "fee_currency": "ETH",
        "point_fee": "0",
        "gt_fee": "0",
        "sequence_id": "588018",
        "text": "t-test"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    None array
    » id string 成交记录 ID
    » create_time string 成交时间
    » create_time_ms string 成交时间,毫秒精度
    » currency_pair string 交易货币对
    » side string 买单或者卖单
    » role string 交易角色,公共接口无此字段返回
    » amount string 交易数量
    » price string 交易价
    » order_id string 关联的订单 ID,公共接口无此字段返回
    » fee string 成交扣除的手续费,公共接口无此字段返回
    » fee_currency string 手续费计价单位,公共接口无此字段返回
    » point_fee string 手续费抵扣使用的点卡数量,公共接口无此字段返回
    » gt_fee string 手续费抵扣使用的 GT 数量,公共接口无此字段返回
    » amend_text string 用户修改订单时备注的信息
    » sequence_id string 单市场连续成交ID
    » text string 订单的自定义信息,公共接口无此字段返回

    # 枚举值列表

    属性
    side buy
    side sell
    role taker
    role maker

    # 市场 K 线图

    示例代码

    # coding: utf-8
    import requests
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/candlesticks'
    query_param = 'currency_pair=BTC_USDT'
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    
    curl -X GET https://api.gateio.ws/api/v4/spot/candlesticks?currency_pair=BTC_USDT \
      -H 'Accept: application/json'
    
    

    GET /spot/candlesticks

    市场 K 线图

    K 线图数据单次请求最大返回 1000 个点,指定 from, to 和 interval 的时候注意点数不能过多

    参数

    名称 位置 类型 必选 描述
    currency_pair 请求参数 string 交易对
    limit 请求参数 integer 指定数据点的数量,适用于取最近 limit 数量的数据,该字段与 from, to 互斥,如果指定了 from, to 中的任意字段,该字段会被拒绝
    from 请求参数 integer(int64) 指定 K 线图的起始时间,注意时间格式为秒(s)精度的 Unix 时间戳,不指定则默认为 to - 100 * interval,即向前最多 100 个点的时间
    to 请求参数 integer(int64) 指定 K 线图的结束时间,不指定则默认当前时间,注意时间格式为秒(s)精度的 Unix 时间戳
    interval 请求参数 string 数据点的时间间隔, 注意 30d 代表的是自然月,不是按30天对齐

    # 详细描述

    limit: 指定数据点的数量,适用于取最近 limit 数量的数据,该字段与 from, to 互斥,如果指定了 from, to 中的任意字段,该字段会被拒绝

    to: 指定 K 线图的结束时间,不指定则默认当前时间,注意时间格式为秒(s)精度的 Unix 时间戳

    # 枚举值列表

    参数
    interval 10s
    interval 1m
    interval 5m
    interval 15m
    interval 30m
    interval 1h
    interval 4h
    interval 8h
    interval 1d
    interval 7d
    interval 30d

    返回示例

    200 返回

    [
      [
        "1539852480",
        "971519.677",
        "0.0021724",
        "0.0021922",
        "0.0021724",
        "0.0021737",
        "true"
      ]
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 成功查询 [[string]]

    返回格式

    状态码 200

    名称 类型 描述
    » None array 每个时间粒度的 K 线数据,从左到右依次为:

    - 秒(s)精度的 Unix 时间戳
    - 计价货币交易额
    - 收盘价
    - 最高价
    - 最低价
    - 开盘价
    - 基础货币交易量
    - 窗口是否关闭,true 代表此段K线蜡烛图数据结束,false 代表此段K线蜡烛图数据尚未结束

    # 查询账户费率

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/fee'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/spot/fee"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /spot/fee

    查询账户费率

    该接口已废弃,不再推荐使用,新的费率查询接口为 /wallet/fee

    参数

    名称 位置 类型 必选 描述
    currency_pair 请求参数 string 指定交易对获取更准确的费率设置。

    # 详细描述

    currency_pair: 指定交易对获取更准确的费率设置。

    该字段可选,通常情况下所有交易对的费率设置是一样的。

    返回示例

    200 返回

    {
      "user_id": 10001,
      "taker_fee": "0.002",
      "maker_fee": "0.002",
      "gt_discount": false,
      "gt_taker_fee": "0",
      "gt_maker_fee": "0",
      "loan_fee": "0.18",
      "point_type": "1",
      "currency_pair": "BTC_USDT",
      "debit_fee": 3
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » user_id integer(int64) 用户 ID
    » taker_fee string taker 费率
    » maker_fee string maker 费率
    » gt_discount boolean 是否开启 GT 抵扣折扣
    » gt_taker_fee string GT 抵扣 taker 费率,未开启 GT 抵扣则为 0
    » gt_maker_fee string GT 抵扣 maker 费率,未开启 GT 抵扣则为 0
    » loan_fee string 杠杆理财的费率
    » point_type string 点卡类型,0 - 初版点卡,1 - 202009 启用的新点卡
    » currency_pair string 交易对
    » debit_fee integer 费率抵扣类型 , 1 - GT抵扣 , 2 - 点卡抵扣 , 3 - VIP费率

    WARNING

    该请求需要 API key 和 secret 认证

    # 批量查询账户费率

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/batch_fee'
    query_param = 'currency_pairs=BTC_USDT,ETH_USDT'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/spot/batch_fee"
    query_param="currency_pairs=BTC_USDT,ETH_USDT"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /spot/batch_fee

    批量查询账户费率

    参数

    名称 位置 类型 必选 描述
    currency_pairs 请求参数 string 一次请求最多只能查询 50 个交易对

    返回示例

    200 返回

    {
      "BTC_USDT": {
        "user_id": 10001,
        "taker_fee": "0.002",
        "maker_fee": "0.002",
        "gt_discount": false,
        "gt_taker_fee": "0",
        "gt_maker_fee": "0",
        "loan_fee": "0.18",
        "point_type": "1",
        "currency_pair": "BTC_USDT",
        "debit_fee": 3
      },
      "GT_USDT": {
        "user_id": 10001,
        "taker_fee": "0.002",
        "maker_fee": "0.002",
        "gt_discount": false,
        "gt_taker_fee": "0",
        "gt_maker_fee": "0",
        "loan_fee": "0.18",
        "point_type": "1",
        "currency_pair": "GT_USDT",
        "debit_fee": 3
      },
      "ETH_USDT": {
        "user_id": 10001,
        "taker_fee": "0.002",
        "maker_fee": "0.002",
        "gt_discount": false,
        "gt_taker_fee": "0",
        "gt_maker_fee": "0",
        "loan_fee": "0.18",
        "point_type": "1",
        "currency_pair": "ETH_USDT",
        "debit_fee": 3
      }
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 查询成功 Inline

    返回格式

    状态码 200

    名称 类型 描述
    » additionalProperties object
    »» user_id integer(int64) 用户 ID
    »» taker_fee string taker 费率
    »» maker_fee string maker 费率
    »» gt_discount boolean 是否开启 GT 抵扣折扣
    »» gt_taker_fee string GT 抵扣 taker 费率,未开启 GT 抵扣则为 0
    »» gt_maker_fee string GT 抵扣 maker 费率,未开启 GT 抵扣则为 0
    »» loan_fee string 杠杆理财的费率
    »» point_type string 点卡类型,0 - 初版点卡,1 - 202009 启用的新点卡
    »» currency_pair string 交易对
    »» debit_fee integer 费率抵扣类型 , 1 - GT抵扣 , 2 - 点卡抵扣 , 3 - VIP费率

    WARNING

    该请求需要 API key 和 secret 认证

    # 获取现货交易账户列表

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/accounts'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/spot/accounts"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /spot/accounts

    获取现货交易账户列表

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定币种名称查询

    返回示例

    200 返回

    [
      {
        "currency": "ETH",
        "available": "968.8",
        "locked": "0"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » currency string 币种信息
    » available string 可用金额
    » locked string 冻结金额

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询现货账户变动历史

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/account_book'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/spot/account_book"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /spot/account_book

    查询现货账户变动历史

    记录查询时间范围不允许超过 30 天

    参数

    名称 位置 类型 必选 描述
    currency 请求参数 string 指定币种名称查询
    from 请求参数 integer(int64) 查询记录的起始时间
    to 请求参数 integer(int64) 查询记录的结束时间,不指定则默认为当前时间
    page 请求参数 integer(int32) 列表页数
    limit 请求参数 integer 列表返回的最大数量
    type 请求参数 string 指定账户变动类型查询,不指定则包含全部变动类型

    返回示例

    200 返回

    [
      {
        "id": "123456",
        "time": 1547633726123,
        "currency": "BTC",
        "change": "1.03",
        "balance": "4.59316525194",
        "type": "margin_in",
        "text": "3815099"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » id string 账户变更记录 ID
    » time integer(int64) 账户变更时间戳,毫秒单位
    » currency string 变更币种
    » change string 变更金额,正数表示转入,负数表示转出
    » balance string 变更后账户余额
    » type string 账户变更类型 , 详见资产流水类型
    » text string 附加信息

    WARNING

    该请求需要 API key 和 secret 认证

    # 批量下单

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/batch_orders'
    query_param = ''
    body='[{"text":"t-abc123","currency_pair":"BTC_USDT","type":"limit","account":"unified","side":"buy","amount":"0.001","price":"65000","time_in_force":"gtc","iceberg":"0"}]'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/spot/batch_orders"
    query_param=""
    body_param='[{"text":"t-abc123","currency_pair":"BTC_USDT","type":"limit","account":"unified","side":"buy","amount":"0.001","price":"65000","time_in_force":"gtc","iceberg":"0"}]'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /spot/batch_orders

    批量下单

    批量下单要求:

    1. 用户自定义订单信息 text 必须指定
    2. 每次只能下最多 4 个交易对且每个交易对只可批量下 10 个单
    3. 现货交易和杠杆交易不能同时存在,即同个请求里所有 account 必须一致

    请求体示例

    [
      {
        "text": "t-abc123",
        "currency_pair": "BTC_USDT",
        "type": "limit",
        "account": "unified",
        "side": "buy",
        "amount": "0.001",
        "price": "65000",
        "time_in_force": "gtc",
        "iceberg": "0"
      }
    ]
    

    参数

    名称 位置 类型 必选 描述
    body body array[Order]

    返回示例

    200 返回

    [
      {
        "order_id": "12332324",
        "amend_text": "t-123456",
        "text": "t-123456",
        "succeeded": true,
        "label": "",
        "message": "",
        "id": "12332324",
        "create_time": "1548000000",
        "update_time": "1548000100",
        "create_time_ms": 1548000000123,
        "update_time_ms": 1548000100123,
        "currency_pair": "ETC_BTC",
        "status": "cancelled",
        "type": "limit",
        "account": "spot",
        "side": "buy",
        "amount": "1",
        "price": "5.00032",
        "time_in_force": "gtc",
        "iceberg": "0",
        "left": "0.5",
        "filled_amount": "1.242",
        "filled_total": "2.50016",
        "avg_deal_price": "5.00032",
        "fee": "0.005",
        "fee_currency": "ETH",
        "point_fee": "0",
        "gt_fee": "0",
        "gt_discount": false,
        "rebated_fee": "0",
        "rebated_fee_currency": "BTC",
        "stp_act": "cn",
        "finish_as": "stp",
        "stp_id": 10240
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 请求执行完成 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    None array [批量订单信息]
    » None object 批量订单信息
    »» order_id string 订单 ID
    »» amend_text string 用户修改订单时备注的信息
    »» text string 订单自定义信息,用户可以用该字段设置自定义 ID,用户自定义字段必须满足以下条件:

    1. 必须以 t- 开头
    2. 不计算 t- ,长度不能超过 28 字节
    3. 输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.)
    »» succeeded boolean 请求执行结果
    »» label string 错误标识,当订单成功时该字段为空串
    »» message string 错误详情,当订单成功时改字段为空串
    »» id string 订单 ID
    »» create_time string 订单创建时间
    »» update_time string 订单最新修改时间
    »» create_time_ms integer(int64) 订单创建时间,毫秒精度
    »» update_time_ms integer(int64) 订单最近修改时间,毫秒精度
    »» status string 订单状态。

    - open: 等待处理
    - closed: 全部成交
    - cancelled: 订单撤销
    »» currency_pair string 交易货币对
    »» type string 订单类型

    - limit : 限价单
    - market : 市价单
    »» account string 账户类型,spot - 现货账户,margin - 杠杆账户,cross_margin - 全仓杠杆账户,unified - 统一账户
    »» side string 买单或者卖单
    »» amount string 交易数量
    »» price string 交易价
    »» time_in_force string Time in force 策略。

    - gtc: GoodTillCancelled
    - ioc: ImmediateOrCancelled,立即成交或者取消,只吃单不挂单
    - poc: PendingOrCancelled,被动委托,只挂单不吃单
    - fok: FillOrKill,全部成交或者全部取消
    »» iceberg string 冰山下单显示的数量,不指定或传 0 都默认为普通下单。目前不支持全部冰山。
    »» auto_repay boolean 全仓杠杆下单是否开启自动还款,默认关闭。需要注意的是:

    1. 此字段仅针对全仓杠杆有效。逐仓杠杆不支持订单级别的自动还款设置,只能通过 POST /margin/auto_repay 修改用户级别的设置
    2. auto_borrowauto_repay 支持同时开启
    »» left string 交易货币未成交数量
    »» filled_amount string 交易货币已成交数量
    »» fill_price string 已成交的计价币种总额,该字段废弃,建议使用相同意义的 filled_total
    »» filled_total string 已成交总金额
    »» avg_deal_price string 平均成交价
    »» fee string 成交扣除的手续费
    »» fee_currency string 手续费计价单位
    »» point_fee string 手续费抵扣使用的点卡数量
    »» gt_fee string 手续费抵扣使用的 GT 数量
    »» gt_discount boolean 是否开启GT抵扣
    »» rebated_fee string 返还的手续费
    »» rebated_fee_currency string 返还手续费计价单位
    »» stp_id integer 订单所属的STP用户组id,同一个STP用户组内用户之间的订单不允许发生自成交。

    1. 如果撮合时两个订单的 stp_id0 且相等,则不成交,而是根据 takerstp_act 执行相应策略。
    2. 没有设置STP用户组成交的订单,stp_id 默认返回 0
    »» stp_act string Self-Trading Prevention Action,用户可以用该字段设置自定义限制自成交策略。

    1. 用户在设置加入STP用户组后,可以通过传递 stp_act 来限制用户发生自成交的策略,没有传递 stp_act 默认按照 cn 的策略。
    2. 用户在没有设置加入STP用户组时,传递 stp_act 参数会报错。
    3. 用户没有使用 stp_act 发生成交的订单,stp_act 返回-

    - cn: Cancel newest,取消新订单,保留老订单
    - co: Cancel oldest,取消⽼订单,保留新订单
    - cb: Cancel both,新旧订单都取消
    »» finish_as string 订单结束方式,包括:

    - open: 等待处理
    - filled: 完全成交
    - cancelled: 用户撤销
    - ioc: 未立即完全成交,因为 tif 设置为 ioc
    - stp: 订单发生自成交限制而被撤销

    # 枚举值列表

    属性
    status open
    status closed
    status cancelled
    type limit
    type market
    account spot
    account margin
    account cross_margin
    account unified
    side buy
    side sell
    time_in_force gtc
    time_in_force ioc
    time_in_force poc
    time_in_force fok
    stp_act cn
    stp_act co
    stp_act cb
    stp_act -
    finish_as open
    finish_as filled
    finish_as cancelled
    finish_as ioc
    finish_as stp

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询所有挂单

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/open_orders'
    query_param = ''
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/spot/open_orders"
    query_param=""
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /spot/open_orders

    查询所有挂单

    查询所有交易对的当前挂单列表。

    注意分页参数控制的是每个交易对里的挂单数量,交易对个数没有分页控制,所有有挂单的交易对全部返回。

    默认查询现货,保证金和逐仓杠杆账户的挂单信息。查询全仓杠杆账户时,必须指定 account 参数为 cross_margin

    参数

    名称 位置 类型 必选 描述
    page 请求参数 integer(int32) 列表页数
    limit 请求参数 integer 每个交易对每页最多返回的数量
    account 请求参数 string 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。

    # 详细描述

    account: 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。
    统一账户只能指定 cross_margin

    返回示例

    200 返回

    [
      {
        "currency_pair": "ETH_BTC",
        "total": 1,
        "orders": [
          {
            "id": "12332324",
            "text": "t-123456",
            "create_time": "1548000000",
            "update_time": "1548000100",
            "currency_pair": "ETH_BTC",
            "status": "open",
            "type": "limit",
            "account": "spot",
            "side": "buy",
            "amount": "1",
            "price": "5.00032",
            "time_in_force": "gtc",
            "left": "0.5",
            "filled_total": "2.50016",
            "fee": "0.005",
            "fee_currency": "ETH",
            "point_fee": "0",
            "gt_fee": "0",
            "gt_discount": false,
            "rebated_fee": "0",
            "rebated_fee_currency": "BTC"
          }
        ]
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » currency_pair string 交易对
    » total integer 该交易对当前页面的挂单总数
    » orders array
    »» None object 现货单详情
    »»» id string 订单 ID
    »»» text string 订单自定义信息,用户可以用该字段设置自定义 ID,用户自定义字段必须满足以下条件:

    1. 必须以 t- 开头
    2. 不计算 t- ,长度不能超过 28 字节
    3. 输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.)

    除用户自定义信息以外,以下为内部保留字段,标识订单来源:
    101 代表 android 下单
    102 代表 IOS 下单
    103 代表 IPAD 下单
    104 代表 webapp 下单
    3 代表 web 下单
    2 代表 apiv2 下单
    apiv4 代表 apiv4 下单
    »»» amend_text string 用户修改订单时备注的信息
    »»» create_time string 订单创建时间
    »»» update_time string 订单最新修改时间
    »»» create_time_ms integer(int64) 订单创建时间,毫秒精度
    »»» update_time_ms integer(int64) 订单最近修改时间,毫秒精度
    »»» status string 订单状态。

    - open: 等待处理
    - closed: 全部成交
    - cancelled: 订单撤销
    »»» currency_pair string 交易货币对
    »»» type string 订单类型

    - limit : 限价单
    - market : 市价单
    »»» account string 账户类型,spot - 现货账户,margin - 杠杆账户,cross_margin - 全仓杠杆账户,unified - 统一账户
    统一账户(旧)只能设置 cross_margin
    »»» side string 买单或者卖单
    »»» amount string 交易数量
    typelimit时,指交易货币,即需要交易的货币,如BTC_USDT中指BTC
    typemarket时,根据买卖不同指代不同
    - side : buy 指代计价货币,BTC_USDT中指USDT
    - side : sell 指代交易货币,BTC_USDT中指BTC
    »»» price string 交易价,type=limit时必填
    »»» time_in_force string Time in force 策略。

    - gtc: GoodTillCancelled
    - ioc: ImmediateOrCancelled,立即成交或者取消,只吃单不挂单
    - poc: PendingOrCancelled,被动委托,只挂单不吃单
    - fok: FillOrKill,全部成交或者全部取消

    type=market时仅支持iocfok
    »»» iceberg string 冰山下单显示的数量,不指定或传 0 都默认为普通下单。目前不支持全部冰山。
    »»» auto_repay boolean 全仓杠杆下单是否开启自动还款,默认关闭。需要注意的是:

    1. 此字段仅针对全仓杠杆有效。逐仓杠杆不支持订单级别的自动还款设置,只能通过 POST /margin/auto_repay 修改用户级别的设置
    2. auto_borrowauto_repay 支持同时开启
    »»» left string 交易货币未成交数量
    »»» filled_amount string 交易货币已成交数量
    »»» fill_price string 已成交的计价币种总额,该字段废弃,建议使用相同意义的 filled_total
    »»» filled_total string 已成交总金额
    »»» avg_deal_price string 平均成交价
    »»» fee string 成交扣除的手续费
    »»» fee_currency string 手续费计价单位
    »»» point_fee string 手续费抵扣使用的点卡数量
    »»» gt_fee string 手续费抵扣使用的 GT 数量
    »»» gt_maker_fee string 手续费maker抵扣使用的 GT 数量
    »»» gt_taker_fee string 手续费taker抵扣使用的 GT 数量
    »»» gt_discount boolean 是否开启GT抵扣
    »»» rebated_fee string 返还的手续费
    »»» rebated_fee_currency string 返还手续费计价单位
    »»» stp_id integer 订单所属的STP用户组id,同一个STP用户组内用户之间的订单不允许发生自成交。

    1. 如果撮合时两个订单的 stp_id0 且相等,则不成交,而是根据 takerstp_act 执行相应策略。
    2. 没有设置STP用户组成交的订单,stp_id 默认返回 0
    »»» stp_act string Self-Trading Prevention Action,用户可以用该字段设置自定义限制自成交策略。

    1. 用户在设置加入STP用户组后,可以通过传递 stp_act 来限制用户发生自成交的策略,没有传递 stp_act 默认按照 cn 的策略。
    2. 用户在没有设置加入STP用户组时,传递 stp_act 参数会报错。
    3. 用户没有使用 stp_act 发生成交的订单,stp_act 返回 -

    - cn: Cancel newest,取消新订单,保留老订单
    - co: Cancel oldest,取消⽼订单,保留新订单
    - cb: Cancel both,新旧订单都取消
    »»» finish_as string 订单结束方式,包括:

    - open: 等待处理
    - filled: 完全成交
    - cancelled: 用户撤销
    - ioc: 未立即完全成交,因为 tif 设置为 ioc
    - stp: 订单发生自成交限制而被撤销

    # 枚举值列表

    属性
    status open
    status closed
    status cancelled
    type limit
    type market
    side buy
    side sell
    time_in_force gtc
    time_in_force ioc
    time_in_force poc
    time_in_force fok
    stp_act cn
    stp_act co
    stp_act cb
    stp_act -
    finish_as open
    finish_as filled
    finish_as cancelled
    finish_as ioc
    finish_as stp

    WARNING

    该请求需要 API key 和 secret 认证

    # 禁用币种下平仓单

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/cross_liquidate_orders'
    query_param = ''
    body='{"currency_pair":"GT_USDT","amount":"12","price":"10.15","text":"t-34535"}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/spot/cross_liquidate_orders"
    query_param=""
    body_param='{"currency_pair":"GT_USDT","amount":"12","price":"10.15","text":"t-34535"}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /spot/cross_liquidate_orders

    禁用币种下平仓单

    目前只支持全仓账户对禁用币种进行买入下单 最大买入数量 = (未还本息 - 币种余额 - 挂单该币种数量) / 0.998

    请求体示例

    {
      "currency_pair": "GT_USDT",
      "amount": "12",
      "price": "10.15",
      "text": "t-34535"
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » text body string 订单自定义信息,用户可以用该字段设置自定义 ID,用户自定义字段必须满足以下条件:
    » currency_pair body string 交易货币对
    » amount body string 交易数量
    » price body string 交易价
    » action_mode body string 处理模式:

    # 详细描述

    » text: 订单自定义信息,用户可以用该字段设置自定义 ID,用户自定义字段必须满足以下条件:

    1. 必须以 t- 开头
    2. 不计算 t- ,长度不能超过 28 字节
    3. 输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.)

    » action_mode: 处理模式:

    下单时根据action_mode返回不同的字段, 该字段只在请求时有效,响应结果中不包含该字段 ACK: 异步模式,只返回订单关键字段 RESULT: 无清算信息 FULL: 完整模式(默认)

    返回示例

    201 返回

    {
      "id": "1852454420",
      "text": "t-abc123",
      "amend_text": "-",
      "create_time": "1710488334",
      "update_time": "1710488334",
      "create_time_ms": 1710488334073,
      "update_time_ms": 1710488334074,
      "status": "closed",
      "currency_pair": "BTC_USDT",
      "type": "limit",
      "account": "unified",
      "side": "buy",
      "amount": "0.001",
      "price": "65000",
      "time_in_force": "gtc",
      "iceberg": "0",
      "left": "0",
      "filled_amount": "0.001",
      "fill_price": "63.4693",
      "filled_total": "63.4693",
      "avg_deal_price": "63469.3",
      "fee": "0.00000022",
      "fee_currency": "BTC",
      "point_fee": "0",
      "gt_fee": "0",
      "gt_maker_fee": "0",
      "gt_taker_fee": "0",
      "gt_discount": false,
      "rebated_fee": "0",
      "rebated_fee_currency": "USDT",
      "finish_as": "filled"
    }
    

    返回

    状态码 含义 描述 格式
    201 Created (opens new window) 交易成功执行 Order

    WARNING

    该请求需要 API key 和 secret 认证

    # 下单

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/orders'
    query_param = ''
    body='{"text":"t-abc123","currency_pair":"BTC_USDT","type":"limit","account":"unified","side":"buy","amount":"0.001","price":"65000","time_in_force":"gtc","iceberg":"0"}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/spot/orders"
    query_param=""
    body_param='{"text":"t-abc123","currency_pair":"BTC_USDT","type":"limit","account":"unified","side":"buy","amount":"0.001","price":"65000","time_in_force":"gtc","iceberg":"0"}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /spot/orders

    下单

    支持现货、保证金、杠杆、全仓杠杆下单。通过 account 字段来使用不同的账户,默认为 spot ,即使用现货账户下单,如果用户是 unified 账户,默认是用统一账户下单

    使用杠杆账户交易,即 account 设置为 margin 的时候,可以设置 auto_borrowtrue, 在账户余额不足的情况,由系统自动执行 POST /margin/loans 借入不足部分。 杠杆下单成交之后的获取到的资产是否自动用于归还逐仓杠杆账户的借入单,取决于用户逐仓杠杆账户的自动还款设置, 该账户自动还款设置可以通过 /margin/auto_repay 来查询和设置。

    使用全仓杠杆账户交易,即 account 设置为 cross_margin 的时候,同样可以启用 auto_borrow 来实现自动借入不足部分,但是与逐仓杠杆账户不同的是,全仓杠杆账户的委托是否自动还款取决于下单时的 auto_repay 设置,该设置只对当前委托生效,即只有该委托成交之后获取到的资产会用来还款全仓杠杆账户的借入单。 全仓杠杆账户下单目前支持同时开启 auto_borrowauto_repay

    自动还款会在订单结束时触发,即 statuscancelled 或者 closed

    委托状态

    挂单中的委托状态是 open ,在数量全部成交之前保持为 open 。如果被全部吃掉,则订单结束,状态变成 closed 。 假如全部成交之前,订单被撤销,不管是否有部分成交,状态都会变为 cancelled

    冰山委托

    iceberg 用来设置冰山委托显示的数量,如果需要完全隐藏,设置为 -1 。注意隐藏部分成交时按照 taker 的手续费率收取。

    限制用户自成交

    设置 stp_act 来决定使用限制用户自成交的策略

    请求体示例

    {
      "text": "t-abc123",
      "currency_pair": "BTC_USDT",
      "type": "limit",
      "account": "unified",
      "side": "buy",
      "amount": "0.001",
      "price": "65000",
      "time_in_force": "gtc",
      "iceberg": "0"
    }
    

    参数

    名称 位置 类型 必选 描述
    body body Order
    » text body string 订单自定义信息,用户可以用该字段设置自定义 ID,用户自定义字段必须满足以下条件:
    » currency_pair body string 交易货币对
    » type body string 订单类型
    » account body string 账户类型,spot - 现货账户,margin - 杠杆账户,cross_margin - 全仓杠杆账户,unified - 统一账户
    » side body string 买单或者卖单
    » amount body string 交易数量
    » price body string 交易价,type=limit时必填
    » time_in_force body string Time in force 策略。
    » iceberg body string 冰山下单显示的数量,不指定或传 0 都默认为普通下单。目前不支持全部冰山。
    » auto_borrow body boolean 杠杆(包括逐仓全仓)交易时,如果账户余额不足,是否由系统自动借入不足部分
    » auto_repay body boolean 全仓杠杆下单是否开启自动还款,默认关闭。需要注意的是:
    » stp_act body string Self-Trading Prevention Action,用户可以用该字段设置自定义限制自成交策略。
    » action_mode body string 处理模式:

    # 详细描述

    » text: 订单自定义信息,用户可以用该字段设置自定义 ID,用户自定义字段必须满足以下条件:

    1. 必须以 t- 开头
    2. 不计算 t- ,长度不能超过 28 字节
    3. 输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.)

    除用户自定义信息以外,以下为内部保留字段,标识订单来源: 101 代表 android 下单 102 代表 IOS 下单 103 代表 IPAD 下单 104 代表 webapp 下单 3 代表 web 下单 2 代表 apiv2 下单 apiv4 代表 apiv4 下单

    » type: 订单类型

    • limit : 限价单
    • market : 市价单

    » account: 账户类型,spot - 现货账户,margin - 杠杆账户,cross_margin - 全仓杠杆账户,unified - 统一账户 统一账户(旧)只能设置 cross_margin

    » amount: 交易数量
    typelimit时,指交易货币,即需要交易的货币,如BTC_USDT中指BTC
    typemarket时,根据买卖不同指代不同

    • side : buy 指代计价货币,BTC_USDT中指USDT
    • side : sell 指代交易货币,BTC_USDT中指BTC

    » time_in_force: Time in force 策略。

    • gtc: GoodTillCancelled
    • ioc: ImmediateOrCancelled,立即成交或者取消,只吃单不挂单
    • poc: PendingOrCancelled,被动委托,只挂单不吃单
    • fok: FillOrKill,全部成交或者全部取消

    type=market时仅支持iocfok

    » auto_repay: 全仓杠杆下单是否开启自动还款,默认关闭。需要注意的是:

    1. 此字段仅针对全仓杠杆有效。逐仓杠杆不支持订单级别的自动还款设置,只能通过 POST /margin/auto_repay 修改用户级别的设置
    2. auto_borrowauto_repay 支持同时开启

    » stp_act: Self-Trading Prevention Action,用户可以用该字段设置自定义限制自成交策略。

    1. 用户在设置加入STP用户组后,可以通过传递 stp_act 来限制用户发生自成交的策略,没有传递 stp_act 默认按照 cn 的策略。
    2. 用户在没有设置加入STP用户组时,传递 stp_act 参数会报错。
    3. 用户没有使用 stp_act 发生成交的订单,stp_act 返回 -
    • cn: Cancel newest,取消新订单,保留老订单
    • co: Cancel oldest,取消⽼订单,保留新订单
    • cb: Cancel both,新旧订单都取消

    » action_mode: 处理模式: 下单时根据action_mode返回不同的字段, 该字段只在请求时有效,响应结果中不包含该字段 ACK: 异步模式,只返回订单关键字段 RESULT: 无清算信息 FULL: 完整模式(默认)

    # 枚举值列表

    参数
    » type limit
    » type market
    » side buy
    » side sell
    » time_in_force gtc
    » time_in_force ioc
    » time_in_force poc
    » time_in_force fok
    » stp_act cn
    » stp_act co
    » stp_act cb
    » stp_act -

    返回示例

    ACK response body example

    {
      "id": "12332324",
      "text": "t-123456",
      "amend_text": "test2"
    }
    

    RESULT response body example

    {
      "id": "12332324",
      "text": "t-123456",
      "create_time": "1548000000",
      "update_time": "1548000100",
      "create_time_ms": 1548000000123,
      "update_time_ms": 1548000100123,
      "currency_pair": "ETH_BTC",
      "status": "cancelled",
      "type": "limit",
      "account": "spot",
      "side": "buy",
      "iceberg": "0",
      "amount": "1",
      "price": "5.00032",
      "time_in_force": "gtc",
      "auto_borrow": false,
      "left": "0.5",
      "filled_total": "2.50016",
      "avg_deal_price": "5.00032",
      "stp_act": "cn",
      "finish_as": "stp",
      "stp_id": 10240
    }
    

    FULL response body example

    {
      "id": "1852454420",
      "text": "t-abc123",
      "amend_text": "-",
      "create_time": "1710488334",
      "update_time": "1710488334",
      "create_time_ms": 1710488334073,
      "update_time_ms": 1710488334074,
      "status": "closed",
      "currency_pair": "BTC_USDT",
      "type": "limit",
      "account": "unified",
      "side": "buy",
      "amount": "0.001",
      "price": "65000",
      "time_in_force": "gtc",
      "iceberg": "0",
      "left": "0",
      "filled_amount": "0.001",
      "fill_price": "63.4693",
      "filled_total": "63.4693",
      "avg_deal_price": "63469.3",
      "fee": "0.00000022",
      "fee_currency": "BTC",
      "point_fee": "0",
      "gt_fee": "0",
      "gt_maker_fee": "0",
      "gt_taker_fee": "0",
      "gt_discount": false,
      "rebated_fee": "0",
      "rebated_fee_currency": "USDT",
      "finish_as": "filled"
    }
    

    返回

    状态码 含义 描述 格式
    201 Created (opens new window) 交易成功执行。具体执行结果根据下单时的 Time in force 策略来决定 Order

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询订单列表

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/orders'
    query_param = 'currency_pair=BTC_USDT&status=open'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/spot/orders"
    query_param="currency_pair=BTC_USDT&status=open"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /spot/orders

    查询订单列表

    注意查询结果默认是现货,保证金和逐仓杠杆账户的订单列表,如果查询全仓杠杆账户的订单列表时,必须要设置 accountcross_margin

    status 设置为 open ,即查询挂单列表时,只支持 pagelimit 的分页控制。 limit 最大只允许设置到 100 。 不支持 side 和按时间范围查询的 from, to 参数。

    status 设置为 finished ,即查询历史委托的时候, 除分页查询以外,还支持 fromto 按时间范围的查询。 此外还支持设置 side 参数筛选单边历史。

    时间范围筛选的参数均是按订单结束时间来处理。

    参数

    名称 位置 类型 必选 描述
    currency_pair 请求参数 string 指定交易对查询。如果查询挂单的记录,该字段必选。如果查询已成交的记录,该字段可以不指定。
    status 请求参数 string 基于状态查询订单列表
    page 请求参数 integer(int32) 列表页数
    limit 请求参数 integer 列表返回的最大数量,如果 status 设置为 openlimit 最大允许 100
    account 请求参数 string 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。
    from 请求参数 integer(int64) 查询记录的起始时间
    to 请求参数 integer(int64) 查询记录的结束时间,不指定则默认为当前时间
    side 请求参数 string 指定全部买单或全部卖单,不指定则两者都包括

    # 详细描述

    status: 基于状态查询订单列表

    open - 挂单中 finished - 已结束

    account: 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。
    统一账户只能指定 cross_margin

    返回示例

    200 返回

    [
      {
        "id": "1852454420",
        "text": "t-abc123",
        "amend_text": "-",
        "create_time": "1710488334",
        "update_time": "1710488334",
        "create_time_ms": 1710488334073,
        "update_time_ms": 1710488334074,
        "status": "closed",
        "currency_pair": "BTC_USDT",
        "type": "limit",
        "account": "unified",
        "side": "buy",
        "amount": "0.001",
        "price": "65000",
        "time_in_force": "gtc",
        "iceberg": "0",
        "left": "0",
        "filled_amount": "0.001",
        "fill_price": "63.4693",
        "filled_total": "63.4693",
        "avg_deal_price": "63469.3",
        "fee": "0.00000022",
        "fee_currency": "BTC",
        "point_fee": "0",
        "gt_fee": "0",
        "gt_maker_fee": "0",
        "gt_taker_fee": "0",
        "gt_discount": false,
        "rebated_fee": "0",
        "rebated_fee_currency": "USDT",
        "finish_as": "filled"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 列表查询成功 [Order]

    WARNING

    该请求需要 API key 和 secret 认证

    # 批量取消一个交易对里状态为 open 的订单

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/orders'
    query_param = 'currency_pair=BTC_USDT'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('DELETE', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('DELETE', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="DELETE"
    url="/spot/orders"
    query_param="currency_pair=BTC_USDT"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    DELETE /spot/orders

    批量取消一个交易对里状态为 open 的订单

    不指定 account 参数时,包括现货、保证金、逐仓杠杆和全仓杠杆在内的所有挂单都会执行撤销操作。

    可以单独指定某一种账户,撤销指定账户下的所有挂单

    参数

    名称 位置 类型 必选 描述
    currency_pair 请求参数 string 交易对
    side 请求参数 string 指定全部买单或全部卖单,不指定则两者都包括
    account 请求参数 string 指定账户类型
    action_mode 请求参数 string 处理模式

    # 详细描述

    account: 指定账户类型

    • 经典账户:不指定则全部包含
    • 统一账户:只能指定cross_margin

    action_mode: 处理模式

    下单时根据action_mode返回不同的字段

    • ACK: 异步模式,只返回订单关键字段
    • RESULT: 无清算信息
    • FULL: 完整模式(默认)

    返回示例

    200 返回

    [
      {
        "id": "1852454420",
        "text": "t-abc123",
        "amend_text": "-",
        "create_time": "1710488334",
        "update_time": "1710488334",
        "create_time_ms": 1710488334073,
        "update_time_ms": 1710488334074,
        "status": "closed",
        "currency_pair": "BTC_USDT",
        "type": "limit",
        "account": "unified",
        "side": "buy",
        "amount": "0.001",
        "price": "65000",
        "time_in_force": "gtc",
        "iceberg": "0",
        "left": "0",
        "filled_amount": "0.001",
        "fill_price": "63.4693",
        "filled_total": "63.4693",
        "avg_deal_price": "63469.3",
        "fee": "0.00000022",
        "fee_currency": "BTC",
        "point_fee": "0",
        "gt_fee": "0",
        "gt_maker_fee": "0",
        "gt_taker_fee": "0",
        "gt_discount": false,
        "rebated_fee": "0",
        "rebated_fee_currency": "USDT",
        "finish_as": "filled"
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 批量撤销请求接收并处理,是否成功根据订单列表来决定 [Order]

    WARNING

    该请求需要 API key 和 secret 认证

    # 批量撤销指定 ID 的订单列表

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/cancel_batch_orders'
    query_param = ''
    body='[{"currency_pair":"BTC_USDT","id":"123456"}]'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('POST', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('POST', host + prefix + url, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="POST"
    url="/spot/cancel_batch_orders"
    query_param=""
    body_param='[{"currency_pair":"BTC_USDT","id":"123456"}]'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    POST /spot/cancel_batch_orders

    批量撤销指定 ID 的订单列表

    可以指定多个不同的交易对。一次请求最多只能撤销 20 条记录

    请求体示例

    [
      {
        "currency_pair": "BTC_USDT",
        "id": "123456"
      }
    ]
    

    参数

    名称 位置 类型 必选 描述
    body body array[CancelBatchOrder]

    返回示例

    200 返回

    [
      {
        "currency_pair": "BTC_USDT",
        "id": "123456",
        "succeeded": true,
        "label": null,
        "message": null
      }
    ]
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 撤销任务执行完成 [Inline]

    返回格式

    状态码 200

    名称 类型 描述
    » CancelOrderResult object 订单撤销结果
    »» currency_pair string 订单的交易对
    »» id string 订单 ID
    »» succeeded boolean 是否撤销成功
    »» label string 撤销失败时的错误标识,成功时为空
    »» message string 撤销失败时的错误描述,成功时为空
    »» account string 默认为空,当撤销的订单是全仓杠杆账户订单时,该字段为 cross_margin

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询单个订单详情

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/orders/12345'
    query_param = 'currency_pair=BTC_USDT'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('GET', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('GET', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="GET"
    url="/spot/orders/12345"
    query_param="currency_pair=BTC_USDT"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    GET /spot/orders/{order_id}

    查询单个订单详情

    默认查询现货、保证金和逐仓杠杆账户的订单,如果需要查询全仓杠杆账户订单,必须指定 accountcross_margin。 统一账户 account 只能指定为 cross_margin

    参数

    名称 位置 类型 必选 描述
    order_id URL string 成功创建订单时返回的订单 ID 或者用户创建时指定的自定义 ID(即 text 字段)。
    currency_pair 请求参数 string 交易对
    account 请求参数 string 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。

    # 详细描述

    order_id: 成功创建订单时返回的订单 ID 或者用户创建时指定的自定义 ID(即 text 字段)。 基于自定义 ID 的操作只在挂单中可查,当结束订单(成交/取消)后,在结束之后1小时内可查,过期之后只能使用订单 ID

    account: 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。
    统一账户只能指定 cross_margin

    返回示例

    200 返回

    {
      "id": "1852454420",
      "text": "t-abc123",
      "amend_text": "-",
      "create_time": "1710488334",
      "update_time": "1710488334",
      "create_time_ms": 1710488334073,
      "update_time_ms": 1710488334074,
      "status": "closed",
      "currency_pair": "BTC_USDT",
      "type": "limit",
      "account": "unified",
      "side": "buy",
      "amount": "0.001",
      "price": "65000",
      "time_in_force": "gtc",
      "iceberg": "0",
      "left": "0",
      "filled_amount": "0.001",
      "fill_price": "63.4693",
      "filled_total": "63.4693",
      "avg_deal_price": "63469.3",
      "fee": "0.00000022",
      "fee_currency": "BTC",
      "point_fee": "0",
      "gt_fee": "0",
      "gt_maker_fee": "0",
      "gt_taker_fee": "0",
      "gt_discount": false,
      "rebated_fee": "0",
      "rebated_fee_currency": "USDT",
      "finish_as": "filled"
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 详情查询成功 Order

    WARNING

    该请求需要 API key 和 secret 认证

    # 修改单个订单

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/orders/12345'
    query_param = 'currency_pair=BTC_USDT'
    body='{"amount":"1","price":"14"}'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('PATCH', prefix + url, query_param, body)
    headers.update(sign_headers)
    r = requests.request('PATCH', host + prefix + url + "?" + query_param, headers=headers, data=body)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="PATCH"
    url="/spot/orders/12345"
    query_param="currency_pair=BTC_USDT"
    body_param='{"amount":"1","price":"14"}'
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url -d "$body_param" -H "Content-Type: application/json" \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    PATCH /spot/orders/{order_id}

    修改单个订单

    默认修改现货、保证金和逐仓杠杆账户的订单,如果需要修改全仓杠杆账户订单,必须指定 accountcross_margin,统一账户 account 只能指定为 cross_margin

    目前只支持修改价格或数量(二选一)

    关于限速:修改订单和创建订单共享限速规则

    关于匹配优先级:只修改数量变小不影响匹配优先级,修改价格或修改数量变大则优先级将调整到新价格最后面

    注意事项:修改数量小于已成交数量会触发撤单操作

    请求体示例

    {
      "amount": "1",
      "price": "14"
    }
    

    参数

    名称 位置 类型 必选 描述
    body body object
    » amount body string 交易数量,amountprice必须指定其中一个
    » price body string 交易价,amountprice必须指定其中一个
    » amend_text body string 用户可以备注这次修改的信息。
    » action_mode body string 处理模式:
    order_id URL string 成功创建订单时返回的订单 ID 或者用户创建时指定的自定义 ID(即 text 字段)。
    currency_pair 请求参数 string 交易对
    account 请求参数 string 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。

    # 详细描述

    » action_mode: 处理模式: 下单时根据action_mode返回不同的字段, 该字段只在请求时有效,响应结果中不包含该字段 ACK: 异步模式,只返回订单关键字段 RESULT: 无清算信息 FULL: 完整模式(默认)

    order_id: 成功创建订单时返回的订单 ID 或者用户创建时指定的自定义 ID(即 text 字段)。 基于自定义 ID 的操作只在挂单中可查,当结束订单(成交/取消)后,在结束之后1小时内可查,过期之后只能使用订单 ID

    account: 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。
    统一账户只能指定 cross_margin

    返回示例

    200 返回

    {
      "id": "1852454420",
      "text": "t-abc123",
      "amend_text": "-",
      "create_time": "1710488334",
      "update_time": "1710488334",
      "create_time_ms": 1710488334073,
      "update_time_ms": 1710488334074,
      "status": "closed",
      "currency_pair": "BTC_USDT",
      "type": "limit",
      "account": "unified",
      "side": "buy",
      "amount": "0.001",
      "price": "65000",
      "time_in_force": "gtc",
      "iceberg": "0",
      "left": "0",
      "filled_amount": "0.001",
      "fill_price": "63.4693",
      "filled_total": "63.4693",
      "avg_deal_price": "63469.3",
      "fee": "0.00000022",
      "fee_currency": "BTC",
      "point_fee": "0",
      "gt_fee": "0",
      "gt_maker_fee": "0",
      "gt_taker_fee": "0",
      "gt_discount": false,
      "rebated_fee": "0",
      "rebated_fee_currency": "USDT",
      "finish_as": "filled"
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 修改成功 Order

    WARNING

    该请求需要 API key 和 secret 认证

    # 撤销单个订单

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type': 'application/json'}
    
    url = '/spot/orders/12345'
    query_param = 'currency_pair=BTC_USDT'
    # `gen_sign` 的实现参考认证一章
    sign_headers = gen_sign('DELETE', prefix + url, query_param)
    headers.update(sign_headers)
    r = requests.request('DELETE', host + prefix + url + "?" + query_param, headers=headers)
    print(r.json())
    
    
    key="YOUR_API_KEY"
    secret="YOUR_API_SECRET"
    host="https://api.gateio.ws"
    prefix="/api/v4"
    method="DELETE"
    url="/spot/orders/12345"
    query_param="currency_pair=BTC_USDT"
    body_param=''
    timestamp=$(date +%s)
    body_hash=$(printf "$body_param" | openssl sha512 | awk '{print $NF}')
    sign_string="$method\n$prefix$url\n$query_param\n$body_hash\n$timestamp"
    sign=$(printf "$sign_string" | openssl sha512 -hmac "$secret" | awk '{print $NF}')
    
    full_url="$host$prefix$url?$query_param"
    curl -X $method $full_url \
        -H "Timestamp: $timestamp" -H "KEY: $key" -H "SIGN: $sign"
    
    

    DELETE /spot/orders/{order_id}

    撤销单个订单

    默认撤销现货、保证金和逐仓杠杆账户的订单,如果需要撤销全仓杠杆账户订单,必须指定 accountcross_margin。 统一账户 account 只能指定为 cross_margin

    参数

    名称 位置 类型 必选 描述
    action_mode 请求参数 string 处理模式
    order_id URL string 成功创建订单时返回的订单 ID 或者用户创建时指定的自定义 ID(即 text 字段)。
    currency_pair 请求参数 string 交易对
    account 请求参数 string 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。

    # 详细描述

    action_mode: 处理模式

    下单时根据action_mode返回不同的字段

    • ACK: 异步模式,只返回订单关键字段
    • RESULT: 无清算信息
    • FULL: 完整模式(默认)

    order_id: 成功创建订单时返回的订单 ID 或者用户创建时指定的自定义 ID(即 text 字段)。 基于自定义 ID 的操作只在挂单中可查,当结束订单(成交/取消)后,在结束之后1小时内可查,过期之后只能使用订单 ID

    account: 指定查询账户。不指定默认现货,保证金和逐仓杠杆账户。指定 cross_margin 则查询全仓杠杆账户。
    统一账户只能指定 cross_margin

    返回示例

    200 返回

    {
      "id": "1852454420",
      "text": "t-abc123",
      "amend_text": "-",
      "create_time": "1710488334",
      "update_time": "1710488334",
      "create_time_ms": 1710488334073,
      "update_time_ms": 1710488334074,
      "status": "closed",
      "currency_pair": "BTC_USDT",
      "type": "limit",
      "account": "unified",
      "side": "buy",
      "amount": "0.001",
      "price": "65000",
      "time_in_force": "gtc",
      "iceberg": "0",
      "left": "0",
      "filled_amount": "0.001",
      "fill_price": "63.4693",
      "filled_total": "63.4693",
      "avg_deal_price": "63469.3",
      "fee": "0.00000022",
      "fee_currency": "BTC",
      "point_fee": "0",
      "gt_fee": "0",
      "gt_maker_fee": "0",
      "gt_taker_fee": "0",
      "gt_discount": false,
      "rebated_fee": "0",
      "rebated_fee_currency": "USDT",
      "finish_as": "filled"
    }
    

    返回

    状态码 含义 描述 格式
    200 OK (opens new window) 订单撤销成功 Order

    WARNING

    该请求需要 API key 和 secret 认证

    # 查询个人成交记录

    示例代码

    # coding: utf-8
    import requests
    import time
    import hashlib
    import hmac
    
    host = "https://api.gateio.ws"
    prefix = "/api/v4"
    headers = {'Accept': 'application/json', 'Content-Type'