CLI 参考

pikeway balance

查看余额、当前 key 剩余的预算,以及实际可用的额度。

用法

bash

pikeway balance [--json] [--key pk-...]

说明

读取 key 所属账户的 GET /v1/wallet/balance。需要 key。

balance:账户的美元余额。
key budget:仅当 key 设置了消费上限时显示,即该上限还剩多少。
spendable:接下来的调用可用的额度,取余额和 key 预算中较小的一个。调用价格超过该值时会返回 402。

参数

除全局参数 --json 和 --key 外没有其他参数。

示例

bash

pikeway balance

# balance of another key's account
pikeway balance -k pk-...

# warn in a script when running low
[ "$(pikeway balance --json | jq '.spendable.value < 1')" = true ] && echo "top up soon"

输出

有消费上限的 key

balance   $12.4831
key budget $3.75 left of $5
spendable $3.75

无上限的 key

balance   $12.4831
spendable $12.4831

--json

json

{
  "balance":   { "value": 12.4831, "currency": "USD" },
  "earnings":  { "value": 0, "currency": "USD" },
  "keyBudget": { "limit": 5, "used": 1.25, "remaining": 3.75, "currency": "USD" },
  "spendable": { "value": 3.75, "currency": "USD" }
}

keyBudgetobject

仅当 key 设置了消费上限时出现。

earningsobject

作为 API 提供方获得的收入(文本模式不显示)。

错误与退出码

退出码	错误信息	触发条件
3	no API key: run `pikeway keys add --label main --key pk-...`, set PIKEWAY_API_KEY, or pass --key	没有 --key、没有 PIKEWAY_API_KEY,也没有已保存的当前 key。在发出请求之前就会检查。
3	invalid or revoked API key — add a key with `pikeway keys add --label main --key pk-...` (or use --x402)	网关返回 401(key 不存在、已吊销或已过期)。403 同样以 3 退出。
1	cannot reach <gateway>: ECONNREFUSED	无法连接网关(DNS、网络,或 PIKEWAY_API_BASE_URL 写错)。冒号后的错误码来自 Node。

同样支持全局参数 -j, --json 和 -k, --key。见全局参数与退出码。