Skip to content

v0.1.0-rc.35

Pre-release
Pre-release

Choose a tag to compare

@pnf-opps-app pnf-opps-app released this 19 Nov 10:19

Pocket API Console 0.1.0

The first release of the Pocket API Console: paid, metered access to the
services Pocket Network serves, with an account that is a secp256k1 key (the
kind Pocket and Ethereum wallets use) and payments that are verified on chain.

What you can do

  • Sign in to the web console with a wallet, with no email and no password.
    Your secp256k1 key is your account; its Pocket address and its EVM address open the
    same account. Tested with Soothe Vault (Pocket accounts) and MetaMask (EVM
    accounts).
  • See your balance, spend and history: the trial, plan and credit pools,
    spend per service by hour or day, and every event that moved your balance.
  • Mint and revoke API tokens (pkt_...), each with a name and an optional
    expiry, and send them as Authorization: Bearer <token>.
  • Send requests to the Pro endpoints, https://<service>.pro.api.pocket.network,
    billed per relay over HTTP and per message the service sends over WebSocket,
    with rate-limit headers on every served request.
  • Use the free endpoints, https://<service>.api.pocket.network, with no
    token and no charge, at the free tier's rate limit per client IP address and
    per service (5 requests per second).
  • Pay in POKT or in EVM coins (a chain's native coin or an ERC-20 token).
    Every payment is read and verified on its chain, waits for the network's
    confirmations, and is credited only to the account whose key sent it. Some
    coins earn a bonus; the console's Fund page and GET /v1/payments/options
    show the coins, wallets, bonuses and confirmations in force, and
    GET /v1/payments/quote estimates what an amount is credited as.
  • Read the price of every service at GET /v1/prices: it comes from the
    Pocket chain's own parameters at the live POKT price, plus a markup, and every
    input is published so a price can be recomputed.
  • Do all of it from a terminal with budgetkitctl, for Linux, macOS and
    Windows on x86-64 and ARM64, or from code with the signed HTTP API. The
    documentation includes a runbook for AI agents.

Known limits

  • The token is shown once. Only its hash is stored; a lost token cannot be
    shown again. Mint a new one.
  • A lost key cannot be recovered. Whoever holds the key controls the account
    and its money.
  • Each deployment is separate. A signed request names its deployment, so a
    request signed for beta is refused by mainnet, and balances, tokens and
    payments do not move between them.
  • Pay from your own key's address. A withdrawal from an exchange, or a
    payment from a Safe or another contract wallet, is not credited to anyone;
    withdraw to your own wallet first and pay from it.
  • No refunds of on-chain payments through the API. Credit stays on the
    account and never expires.
  • A paid WebSocket needs the Authorization header on the upgrade, so a
    browser's WebSocket API, which cannot set that header, cannot open one.
  • The free endpoints serve no account API and no WebSocket.
  • The console has been tested with two wallets. Other wallets it lists have
    not been tested.

Built from pokt-network/budgetkit@1367ee877ac4. Verify downloads with SHA256SUMS and SHA256SUMS.asc (docs: cli.md).