Skip to content

Latest commit

 

History

History
881 lines (670 loc) · 15.9 KB

platform.md

File metadata and controls

881 lines (670 loc) · 15.9 KB
Raw

文档过时

文档过时

文档过时

文档过时

请看最新文档。

Platform

用户中心颁发的有效证书（token），有效时间2小时，过期后请重新获取。 该鉴权方式只支持部分高级接口，不支持的部分请要使用read token

使用资格

该功能仅对部分用户开放，如需使用请联系客服。

获取证书 token

  1. 准备我方提供的client_id,client_secret
  2. [post] https://account.blockin.com/oauth/v1/token 参数client_id，client_secret，grant_type，scopes
  3. grant_type传固定值"client_credentials"
  4. scopes目前有subaccount-create，watcher-create，address-update，cloud四种，对应具体的接口权限。用空格分隔成字符串提交。

会得到类似返回

{
     "access_token" : "eyJ0e***************************kjerg",
     "expires_in" : 7200,
     "token_type" : "bearer",
     "scope" : "cloud"
}

access_token就是我们需要的token，expires_in是有效期

可用API

api的相关信息如返回的格式，携带token的方式请统一参考 api.md

子账户列表

请求参数

字段 类型 必须 备注
filter string true 只能是visible,hidden,all三选一

请求URL

GET https://api-prod.poolin.com/api/public/v2/platform/subaccount

返回结果

{
    "err_no": 0,
    "data": [
        "puid": 9999888,
        "name": "111ttbtc",
        "nickname": "111ttbtc",
        "default_coin_type": "zec",
        "coins": {},
        "created_at": 1561537835
    ],
    [
        ...
    ]
}

返回字段说明

返回值字段 说明
puid 子账户id
name 名称
default_coin_type 默认币种

批量查询子账户算力信息

请求参数

字段 类型 必须 备注
puids string true 逗号分隔的puid

请求URL

GET https://api-prod.poolin.com/api/public/v2/platform/subaccount/batch

返回结果

{
    "err_no": 0,
    "data": [
        "puid": 9999888,
        "name": "111ttbtc",
        "shares_unit": "T",
        "default_coin_type": "zec",
        "workers_active": 21,
        "workers_inactive": 1,
        "workers_dead": 0,
        "accept_count": 21,
        "yesterday_amount": 12389283,
        "shares_15m": 33.1
        "shares_1h": 23.1
        "shares_24h": 33.2
        "reject_1h": 0.03
    ],
    [
        ...
    ]
}

返回字段说明

返回值字段 说明
puid 子账户id
name 名称
shares_unit 算力单位
default_coin_type 默认币种
workers_active 活跃矿机
workers_inactive 非活跃矿机
workers_dead 死亡矿机
accept_count
yesterday_amount 昨日收益
shares_15m 实时算力
shares_1h 1小时算力
shares_24h 24小时算力
reject_1h 拒绝率 小数形式

查询某个子账户和币种的信息

请求参数

字段 类型 必须 备注
puid int true 子账户id
coin_type string true 币种

请求URL

GET https://api-prod.poolin.com/api/public/v2/platform/subaccount/summary

返回结果

同 批量查询子账户算力信息 返回类似。

创建子账户 |需要subaccount-create

请求参数

字段 类型 必须 备注
name string true 子账户名称
coin_type string true 默认的币种
address string false 收款地址
payment_id string false xmr、etn的支付id

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/subaccount/create

返回结果

{
    "err_no": 0,
    "data": [
        "puid": 9999888,
        "name": "111ttbtc",
        "default_coin_type": "zec",
        "coins": {},
        "created_at": 1561537835
    ],
    [
        ...
    ]
}

如果err_no不为0，是以下的数字的话，请对应错误原因修改。

错误码 原因
100 目前最多允许200个子账户，更多需要单独申请
101 子账户名称已经存在了
102 24小时内只能创建100个子账户，超过频率会报错，需要更高频率单独申请
501，505 地址验证失败
504 payment_id验证失败
507 意外的错误

返回字段说明

返回值字段 说明
puid 子账户id
name 名称
default_coin_type 默认币种

创建观察者、观察者token |需要watcher-create

请求参数

字段 类型 必须 备注
name string true 子账户名称
coin_types array true 观察者能看到的币种,如['btc']
puid int true 子账户id

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/watcher/token/create

返回结果

{
    "err_no": 0,
    "data": {
        "token": "wowEuP*************EiL",
        "puid": 9999888,
        "coin_types": "btc",
        "regions": "*",
        "name": "ttttt",
        "created_at": 1561538162,
        "expired_at": 1577349362,
        "subaccount_name": "111ttbtc"
    }
}

如果err_no不为0，是以下的数字的话，请对应错误原因修改。

错误码 原因
100 目前最多50个生效的观察者

返回字段说明

返回值字段 说明
token 观察者token
puid 子账户id
coin_types 支持的币种信息
name 观察者名称
created_at 创建时间
expired_at 过期时间
subaccount_name 子账户名称

创建新版本观察者token(分权限) |需要watcher-create

请求参数

字段 类型 必须 备注
name string true 子账户名称
coin_types array true 观察者能看到的币种,如['btc']
puid int true 子账户id
watcher_type array true 观察者权限['dashboard', 'payment', 'worker']

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/watcher/token/create/new

返回结果

{
    "err_no": 0,
    "data": {
        "token": "wowEuP*************EiL",
        "puid": 9999888,
        "coin_types": "btc",
        "regions": "*",
        "name": "ttttt",
        "created_at": 1561538162,
        "expired_at": 1577349362,
        "subaccount_name": "111ttbtc"
    }
}

如果err_no不为0，是以下的数字的话，请对应错误原因修改。

错误码 原因
100 目前最多50个生效的观察者

返回字段说明

返回值字段 说明
token 观察者token
puid 子账户id
coin_types 支持的币种信息
name 观察者名称
created_at 创建时间
expired_at 过期时间
subaccount_name 子账户名称

更新子账户地址 |需要address-update

请求参数

字段 类型 必须 备注
address string true 要更新的地址
coin_type string true 是要更新哪一个币种的地址

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/subaccount/{puid}/update/address

返回结果

{
    "err_no": 0,
    "data": null
}

如果err_no不为0，是以下的数字的话，请对应错误原因修改。

错误码 原因
100 子账户不存在
501，505 地址验证失败
504 payment_id验证失败

返回字段说明

返回值字段 说明

删除观察者

请求参数

字段 类型 必须 备注
puid string true PUID
token string true 要删除的观察者token

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/watcher/token/delete

返回结果

{
    "err_no": 0,
    "data": null
}

云算力功能的基本情况 |需要cloud

我们不允许一个子账户既出让算力，也受让算力。同一时间只能是一种状态。现在仅支持比特币btc的转移，单位只能是T。从美东区域接入的算力暂时无法被转移。

云算力-合约、转移列表

云算力现在仅支持btc 显示最新的100条未删除云算力分配记录。

请求参数

字段 类型 必须 备注
coin_type string true 币种，目前仅支持btc
puid int true 子账户id

请求URL

GET https://api-prod.poolin.com/api/public/v2/platform/cloud/transfer-hashrate?coin_type=btc&puid=9001000

返回结果

{
    "err_no": 0,
    "data": {
        "id": 101,
        "name": "suba",
        "to": "subb",
        "hashrate": 23,
        "unit": "T",
        "start_ts": 1557936000,
        "end_ts": 1558022400,
        "status": 3,
        "suspend": 0
    }
}

返回字段说明

返回值字段 说明
id 转移合约id
name 转让人
to 受让人
hashrate 算力值
unit 算力单位
start_ts 开始时间戳
end_ts 过期时间戳
status 1未开始 2生效中 3过期 4已删除
suspend 0-正常,1-已暂停

云算力-可转让算力查询

云算力现在仅支持btc 目前最多只能转让实时算力的90%，多个合约累计计算。

请求参数

字段 类型 必须 备注
coin_type string true 币种，目前仅支持btc
puid int true 子账户id

请求URL

GET https://api-prod.poolin.com/api/public/v2/platform/cloud/allow-sell?coin_type=btc&puid=9001000

返回结果

{
    "err_no": 0,
    "data": {
        "can_sell": 89,
        "unit": "T",
    }
}

返回字段说明

返回值字段 说明
can_sell 允许转移的算力大小
unit 算力单位

云算力-受让方查询

云算力现在仅支持btc

请求参数

字段 类型 必须 备注
puid int true 出让方puid
name string true 受让方名称，长度4-30

请求URL

GET https://api-prod.poolin.com/api/public/v2/platform/cloud/check-name?name=testname&puid=9001000

返回结果

{
    "err_no": 0,
    "data": true
}
|错误码|原因|
|---|---|
|101|受让方出让算力中|
|103|出让方有来自别人的算力|

返回字段说明

返回值字段 说明
data 是否存在受让方

云算力-删除合约

云算力现在仅支持btc

请求参数

字段 类型 必须 备注
puid int true 合约所属转让人的puid
id int true 合约id

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/cloud/delete

返回结果

{
    "err_no": 0,
    "data": null
}

返回字段说明

返回值字段 说明

云算力-创建合约、转移算力

云算力现在仅支持btc

请求参数

字段 类型 必须 备注
puid int true 出让人子账户id
coin_type string true 币种，目前仅支持btc
unit string true 转让算力单位，目前只能是T
hashrate int true 转让的算力值
to string true 受让方子账户名
start_time int true 开始时间，web上目前只显示到天级别的精度，建议以某天0点开始。
end_time int true 结束时间

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/cloud/{puid}/transfer

返回结果

{
    "err_no": 0,
    "data": 123
}
错误码 原因
100 受让方不存在
101 受让方出让算力中
102 不允许出让超过90%的算力
103 出让方有来自别人的算力

返回字段说明

返回值字段 说明
data 合约id

云算力暂停

说明：该接口不是幂等的，会根据当前合约的状态开或关（已暂停的合约会切换为正常，正常的合约会切换为暂停）

请求参数

字段 类型 必须 备注
id int true 合约ID

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/cloud/suspend

返回结果

{
    "err_no": 0,
    "data": {
        "suspend": 1
    }
}

返回字段说明

返回值字段 说明
suspend 当前状态(0正常,1暂停)

错误码说明

错误码 原因
113 未找到该算力转让合约
114 该合约还未开始
115 该合约已结束

云算力卖方合约列表

请求参数

字段 类型 必须 备注
puid int true 子账户ID
coin_type string true 币种
page_size int false 每页条数，默认20，最大100
page int false 页数

请求URL

GET https://api-prod.poolin.com/api/public/v2/platform/cloud/sells

返回结果

{
    "err_no": 0,
    "data": {
        "total": 10,
        "per_page": 5,
        "last_page": 2,
        "current_page": 1,
        "data": [
            {
                "id": 16,
                "name": "",
                "to": "btctest",
                "hashrate": 1,
                "unit": "T",
                "start_ts": 1557936000,
                "end_ts": 1558022400,
                "status": 3,
                "suspend": 0
            },
            {
                "id": 17,
                "name": "",
                "to": "btctest",
                "hashrate": 5,
                "unit": "T",
                "start_ts": 1558022400,
                "end_ts": 1558195200,
                "status": 3,
                "suspend": 0
            },
            ......
        ]
    }
}

返回字段说明

返回值字段 说明
total 总条数
per_page 每页条数
last_page 最后一页
current_page 当前页
data.id 转移合约id
data.name 转让人
data.to 受让人
data.hashrate 算力值
data.unit 算力单位
data.start_ts 开始时间戳
data.end_ts 过期时间戳
data.status 1未开始 2生效中 3过期 4已删除
data.suspend 0-正常,1-已暂停

云算力-根据合约ID获取合约信息

请求参数

字段 类型 必须 备注
- - - -

请求URL

GET https://api-prod.poolin.com/api/public/v2/platform/cloud/contracts/{id} {id}应替换为合约ID

返回结果

{
    "err_no": 0,
    "data": {
        "id": 16,
        "name": "",
        "to": "btctest",
        "hashrate": 1,
        "unit": "T",
        "start_ts": 1557936000,
        "end_ts": 1558022400,
        "status": 3,
        "suspend": 0
    }
}

返回字段说明

返回值字段 说明
id 转移合约id
name 转让人
to 受让人
hashrate 算力值
unit 算力单位
start_ts 开始时间戳
end_ts 过期时间戳
status 1未开始 2生效中 3过期 4已删除
suspend 0-正常,1-已暂停

错误码说明

错误码 原因
404 未找到该算力转让合约

vcash 合并挖矿开关

请求参数

字段 类型 必须 备注
puid int true 子账户ID

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/vcash/open  打开vcash合并挖矿

POST https://api-prod.poolin.com/api/public/v2/platform/vcash/close  关闭vcash合并挖矿

返回结果

打开vcash接口

{
    "err_no": 0,
    "data": null
}

关闭vcash接口

{
    "err_no": 0,
    "data": null
}

获取自动支付状态

请求参数

字段 类型 必须 备注
puid int true 子账户ID
coin_type string true 币种

请求URL

GET https://api-prod.poolin.com/api/public/v2/platform/payment/auto

返回结果

{
    "err_no": 0,
    "data": {
        "is_close": 0   
    }
}

返回字段说明

返回值字段 说明
is_close 是否关闭 (0-正常, 1-关闭了自动支付)

打开/关闭自动支付

说明：该接口会自动根据当前支付状态取反

请求参数

字段 类型 必须 备注
puid int true 子账户ID
coin_type string true 币种

请求URL

POST https://api-prod.poolin.com/api/public/v2/platform/payment/auto

返回结果

{
    "err_no": 0,
    "data": {
        "is_close": 1  
    }
}

返回字段说明

返回值字段 说明
is_close 是否关闭 (0-正常, 1-关闭了自动支付)