API 索引

f2pool API 支持通过 HTTPS 请求访问矿池服务，用户可通过网站设置页面获取 API token，或者联系我们的服务人员进行开通。

API 认证

如：

curl --request POST {url}
--header 'Content-Type: application/json'
--header 'F2P-API-SECRET: {token}'
--data-raw '{
"currency": "bitcoin",
"user_name": "xxx",
...
}'

{url} 地址为 https://api.f2pool.com/v2/{request_name}

当发生错误的时候，会返回给统一格式的数据

{
"code": {ERR_CODE},
"msg": "错误类型: 错误描述"
}

API 中 currency 字段可取值支持：

bitcoin,bitcoin-cash,conflux,dash,decred,digibyte-qubit,digibyte-scrypt,digibyte-sha256d,digibyte-skein,dogecoin,elacoin,ethereum,ethereum-classic,handshake,hathor,kadena,litecoin,nervos,nmccoin,qitmeer-meer,raven,siacoin-new,verge-blake2s,verge-groestl,verge-lyra,verge-scrypt,verge-x17,xaya,zcash,zen

算力情况模块目前仅支持：

bitcoin,bitcoin-cash,litecoin

算力分配模块目前仅支持：

bitcoin

帐户管理

公共结构

ReadOnlyPage

观察者链接数据

名称 类型 备注 解释
key string /mining-user-{currency}/{key} 为观察者链接 URI
permissions string 不同权限以逗号隔开

* 1 表示拥有矿工详情权限
* 2 表示拥有收益列表包含支付信息权限
* 3 表示拥有收益列表不包含支付信息权限
page_name string 观察者链接备注

Wallet

钱包数据

名称 类型 备注 解释
currency string 币种
address string 地址
threshold string 起付额

ExtraEntry

名称 类型 备注 解释
key string
value string

MiningUserInfo

挖矿子帐户数据

名称 类型 备注 解释
mining_user_name string 子帐户名
pages ReadOnlyPage repeated 观察者链接
wallets Wallet repeated 所有币种钱包信息
description string 子帐户备注

WalletParams

名称 类型 备注 解释
mining_user_name string 子帐户名
wallets Wallet repeated 钱包配置列表

ResultsEntry

名称 类型 备注 解释
key string
value string

WalletResp

名称 类型 备注 解释
currency string 币种
address string 钱包地址
result string 成功/失败
msg string 失败信息

MiningUserWalletResp

名称 类型 备注 解释
mining_user_name string 子帐户名
wallet_result WalletResp repeated

ResultsEntry

名称 类型 备注 解释
key string
value MiningUserWalletResp

获取子帐户信息

POST /v2/mining_user/get

请求参数

名称 类型 备注 解释
mining_user_name string 子账号名

响应参数

名称 类型 备注 解释
mining_user_name string 子帐户名
pages ReadOnlyPage repeated 观察者链接
wallets Wallet repeated 所有币种钱包信息
description string 子帐户备注

添加子帐户

POST /v2/mining_user/add

请求参数

名称 类型 备注 解释
mining_user_name string 创建子帐户，帐户名必须在 2~15 个字符之间（数字和小写字母），以小写字母开头

响应参数

名称 类型 备注 解释
mining_user_name string 子帐户名
pages ReadOnlyPage repeated 观察者链接
wallets Wallet repeated 所有币种钱包信息
description string 子帐户备注

获取子帐户列表

POST /v2/mining_user/list

响应参数

名称 类型 备注 解释
mining_user_list MiningUserInfo repeated 获取子帐户列表

变更钱包地址

POST /v2/mining_user/wallet/update

请求参数

名称 类型 备注 解释
params WalletParams repeated

响应参数

名称 类型 备注 解释
results ResultsEntry repeated

新增观察者链接

POST /v2/mining_user/read_only_page/add

请求参数

名称 类型 备注 解释
mining_user_name string 子帐户名
page_name string 观察者链接备注
permissions string 权限配置，同 ReadOnlyPage

响应参数

名称 类型 备注 解释
mining_user_name string 子帐户名
page ReadOnlyPage 观察者链接

删除观察者链接

POST /v2/mining_user/read_only_page/delete

请求参数

名称 类型 备注 解释
mining_user_name string 子帐户名
key string ReadOnlyPage 中的 key

响应参数

名称 类型 备注 解释
mining_user_name string 子帐户名

小额提币

POST /v2/mining_user/balance/withdraw

请求参数

名称 类型 备注 解释
mining_user_name string 子帐户名
currency string 币种

响应参数

名称 类型 备注 解释
paid_time int64 支付时间戳

暂停支付

POST /v2/mining_user/payment/pause

请求参数

名称 类型 备注 解释
currency string 币种
mining_user_names string repeated 子帐户名列表

响应参数

名称 类型 备注 解释
results ResultsEntry repeated 结果

恢复支付

POST /v2/mining_user/payment/resume

请求参数

名称 类型 备注 解释
currency string 币种
mining_user_names string repeated 子帐户名列表

响应参数

名称 类型 备注 解释
results ResultsEntry repeated 结果

更新起付额

POST /v2/mining_user/threshold/update

请求参数

名称 类型 备注 解释
mining_user_name string 子帐户名
currency string 币种
threshold string 请使用网站定义的合法值

响应参数

名称 类型 备注 解释
threshold string 起付额

资产情况

公共结构

BalanceInfo

挖矿收益

名称 类型 备注 解释
balance double 当前余额（UTC 0 点之前）
paid double 已支付收益
total_income double 总收益
yesterday_income double 昨日收益
estimated_today_income double 今日预估收益（根据算力预估）

MiningExtra

名称 类型 备注 解释
mining_date int64 产生收益日期时间戳
settle_date int64 结算收益日期时间戳
pps double PPS 收益
pps_fee_rate float PPS 矿池费率
tx_fee double 矿工费奖励
tx_fee_rate float 矿工费部分的矿池费率
hash_rate double 当日平均算力

PayoutExtra

名称 类型 备注 解释
value double 支出金额
address string 收款地址或收款子账号
tx_id string 链上交易 ID
paid_time int64 支付时间戳
wallet_type string 钱包类型（链上钱包或第三方钱包）
tip double 交易手续费

TransactionItem

名称 类型 备注 解释
id int64
type string
changed_balance double changed_balance 大于 0 为收入， 小于 0 为支出
created_at int64 交易生成时间戳
mining_extra MiningExtra 收入明细
payout_extra PayoutExtra 支出明细

获取用户当前资产信息

POST /v2/assets/balance

请求参数

名称 类型 备注 解释
currency string
mining_user_name string 帐户名（用户名信息只能使用帐户名 mining_user_name 或钱包地址 wallet address 之一）
address string 钱包地址

响应参数

名称 类型 备注 解释
balance_info BalanceInfo

收支流水账单

POST /v2/assets/transactions/list

请求参数

名称 类型 备注 解释
currency string 必填
mining_user_name string 帐户名（用户名信息只能使用帐户名 mining_user_name 或钱包地址 wallet address 之一）
address string 钱包地址
type string 多个类型以 "," 分割
- all 全部
- revenue 挖矿收益
- reward 活动奖励或补偿
- dividend 股份分成
- flash_exchange 闪兑
- payout 支出
返回值中有更详细的账目类型以实际业务为准
start_time int64 开始时间戳
end_time int64 结束时间戳

响应参数

名称 类型 备注 解释
transactions TransactionItem repeated

更新结算方式

POST /v2/assets/settle_mode/switch

请求参数

名称 类型 备注 解释
currency string 币种
mode string 模式
mining_user_name string 子账户
activated_at int64 生效时间

响应参数

名称 类型 备注 解释
mode string
activated_at int64 生效时间

算力情况

公共结构

HashRateInfo

名称 类型 备注 解释
name string 帐户名，或者矿工名
hash_rate double 实时算力
h1_hash_rate double 过去 1 小时平均算力
h24_hash_rate double 过去 24 小时平均算力
h1_stale_hash_rate double 过去 1 小时平均拒绝算力
h24_stale_hash_rate double 过去 24 小时平均拒绝算力
h24_delay_hash_rate double 过去 24 小时延迟算力
local_hash_rate double 实时本地算力
h24_local_hash_rate double 过去 24 小时本地平均算力

MiningHistoryItem

名称 类型 备注 解释
timestamp int64 时间戳
hash_rate double 算力
stale_hash_rate double 拒绝算力
delay_hash_rate double 延迟算力
local_hash_rate double 本地算力
normal_reward double 算力对应收益
delay_reward double 延迟算力对应收益
online_miners uint32 在线矿机数

UserMiningReq

名称 类型 备注 解释
mining_user_name string 帐户名（用户名信息只能使用帐户名 mining_user_name 或钱包地址 wallet address 之一）
address string 钱包地址
currency string 币种

WorkerStatus

名称 解释
0 在线
1 离线
2 失效

WorkerMiningInfo

名称 类型 备注 解释
hash_rate_info HashRateInfo 算力信息
last_share_at int64 最近一次算力提交时间戳
status WorkerStatus 当前状态
host string IP 地址

算力数据

POST /v2/hash_rate/info

请求参数

名称 类型 备注 解释
mining_user_name string 帐户名（用户名信息只能使用帐户名 mining_user_name 或钱包地址 wallet address 之一）
address string 钱包地址
currency string 币种

响应参数

名称 类型 备注 解释
info HashRateInfo 算力信息
currency string 币种

同时查询多帐户的算力数据

POST /v2/hash_rate/info_list

请求参数

名称 类型 备注 解释
reqs UserMiningReq repeated 需要查询的子帐户名或匿名地址列表，最多 100

响应参数

名称 类型 备注 解释
info HashRateInfo repeated

算力历史数据（曲线数据）

POST /v2/hash_rate/history

请求参数

名称 类型 备注 解释
mining_user_name string 帐户名（用户名信息只能使用帐户名 mining_user_name 或钱包地址 wallet address 之一）
address string 钱包地址
currency string 币种
interval int64 单位为秒，间隔应该是 10 分钟的倍数
duration int64 单位为秒，时长最多是30天

响应参数

名称 类型 备注 解释
history MiningHistoryItem repeated 历史数据

矿工列表

POST /v2/hash_rate/worker/list

请求参数

名称 类型 备注 解释
mining_user_name string 帐户名（用户名信息只能使用帐户名 mining_user_name 或钱包地址 wallet address 之一）
address string 钱包地址
currency string 币种

响应参数

名称 类型 备注 解释
workers WorkerMiningInfo repeated 矿机列表

矿工算力历史数据（曲线数据）

POST /v2/hash_rate/worker/history

请求参数

名称 类型 备注 解释
mining_user_name string 帐户名（用户名信息只能使用帐户名 mining_user_name 或钱包地址 wallet address 之一）
address string 钱包地址
currency string 币种
worker_name string 矿机名称
interval int64 单位为秒，间隔应该是 10 分钟的倍数
duration int64 单位为秒，时长最多是3天

响应参数

名称 类型 备注 解释
history MiningHistoryItem repeated

算力分配

公共结构

HashRateDistributionOrder

请求算力分配订单

名称 类型 备注 解释
id int64
start_date int64 开始时间戳
end_date int64 结束时间戳（必须大于开始时间）
distributor string 分配算力的挖矿帐户
recipient string 算力接受者的挖矿帐户
hash_rate double 算力
terminate_at int64 如果提前结束了订单，那么会有值，否则为 0

HashRateDistributionSettlement

名称 类型 备注 解释
id int64
order HashRateDistributionOrder 订单
hashes double 注意这里是 hash 数，而不是算力
income double 所得收益
timestamp int64 算力分配结算时间戳

算力分配信息查询

POST /v2/hash_rate/distribution/info

请求参数

名称 类型 备注 解释
currency string 币种
distributor string 分配算力的挖矿帐户
recipient string 算力接受者的挖矿帐户
start_date int64 开始时间戳
end_date int64 结束时间戳（必须大于开始时间）
hash_rate double 算力值

响应参数

名称 类型 备注 解释
current_hash_rate double 总算力
sold_hash_rate double 已分配出去的算力
remaining_hash_rate double 剩余算力

算力分配订单查询

POST /v2/hash_rate/distribution/orders

请求参数

名称 类型 备注 解释
currency string 币种
distributor string 分配算力的挖矿帐户

响应参数

名称 类型 备注 解释
orders HashRateDistributionOrder repeated

算力分配结算查询

POST /v2/hash_rate/distribution/settlements

请求参数

名称 类型 备注 解释
currency string 币种
distributor string 分配算力的挖矿帐户

响应参数

名称 类型 备注 解释
settlements HashRateDistributionSettlement repeated

分配算力给挖矿帐户

POST /v2/hash_rate/distribute

请求参数

名称 类型 备注 解释
currency string 币种
distributor string 分配算力的挖矿帐户
recipient string 算力接受者的挖矿帐户
start_date int64 开始时间戳
end_date int64 结束时间戳（必须大于开始时间）
hash_rate double 算力值

响应参数

名称 类型 备注 解释
order HashRateDistributionOrder

终止算力分配订单

POST /v2/hash_rate/distribution/terminate

请求参数

名称 类型 备注 解释
order_id int64

响应参数

名称 类型 备注 解释
reason string

收益分配

公共结构

RevenueDistribution

名称 类型 备注 解释
id string id
currency string 币种
distributor string 分配收益的挖矿帐户
recipient string 收益接受者的挖矿帐户
description string 描述
proportion double 比例

收益分配信息查询

POST /v2/revenue/distribution/info

请求参数

名称 类型 备注 解释
currency string 币种
distributor string 分配收益的挖矿帐户
recipient string 收益接受者的挖矿帐户

响应参数

名称 类型 备注 解释
data RevenueDistribution repeated 配置列表

分配收益给挖矿帐户

POST /v2/revenue/distribution/add

请求参数

名称 类型 备注 解释
currency string 币种
distributor string 分配收益的挖矿帐户
recipient string 收益接受者的挖矿帐户
description string 描述
proportion double 比例

响应参数

名称 类型 备注 解释
id string id
currency string 币种
distributor string 分配收益的挖矿帐户
recipient string 收益接受者的挖矿帐户
description string 描述
proportion double 比例

取消收益分配规则

POST  /v2/revenue/distribution/delete

请求参数

名称 类型 备注 解释
id int64
distributor string 分配收益的挖矿帐户

响应参数

名称 类型 备注 解释
reason string

矿池信息

公共结构

LuckyEntry

名称 类型 备注 解释
key string
value float

Block

名称 类型 备注 解释
height int64
block_hash string
base_reward double
total_reward double
timestamp int64
settle_timestamp int64

矿池出块分页

POST /v2/blocks/paging

请求参数

名称 类型 备注 解释
page int32
pagesize int32
currency string 币种

响应参数

名称 类型 备注 解释
lucky LuckyEntry repeated
blocklist Block repeated
sum int32

时间范围内矿池出块

POST /v2/blocks/date_range

请求参数

名称 类型 备注 解释
start_time int64
end_time int64
currency string 币种

响应参数

名称 类型 备注 解释
lucky LuckyEntry repeated
blocklist Block repeated
sum int32