Skip to content

About

Pocket API CLI (budgetkitctl): versioned releases and customer + agent docs, published from budgetkit

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

6 Commits

Folders and files

Repository files navigation

Pocket API: CLI and documentation

Access to the services Pocket Network serves: blockchain RPC and the other APIs the deployment lists. There are three products:

  • Pocket API Free: the free domain, no account and no token, at lower rate limits.
  • Pocket API Pro: the Pro domain, metered and paid from your account, with an API token.
  • Pocket API Console: the web console where you manage that account.

Your account is a secp256k1 key, the same kind Pocket and Ethereum wallets use, so there is no email or password; you pay in POKT or in EVM coins verified on chain.

This repository publishes two things:

  • budgetkitctl, the command-line tool, on the Releases page: Linux, macOS and Windows on x86-64 and ARM64, each release signed.
  • The documentation, the pages below.

Start here

you are read
asking a quick question faq.md: short answers, each pointing to its page
new to Pocket API index.md: accounts, balances, tokens, endpoints
using a browser console.md
using a terminal cli.md
sending your first relay over HTTP, WebSocket, gRPC or SSE protocols.md: one copy-paste example per protocol
writing code against the API api.md: request signing, relays, where the token goes (header, path, browser WebSocket), per-token allowlists, error codes
an AI agent, or automating it agents.md: one runbook, every command in order
paying billing-rules.md: which payments are credited

Endpoints

what mainnet beta
Pocket API Console https://console.api.pocket.network https://console.beta.api.pocket.network
Pocket API Pro: requests with a token https://<service>.pro.api.pocket.network https://<service>.pro.beta.api.pocket.network
Pocket API Free: requests with no token https://<service>.api.pocket.network https://<service>.beta.api.pocket.network

Install the CLI

Download your binary and SHA256SUMS plus SHA256SUMS.asc from the release, then check the signature before running anything. The release key is release-key.asc, fingerprint 03E7 C270 9090 327D F488 6C02 8B4B EE82 473C 7CB9:

gpg --import release-key.asc
gpg --fingerprint developer@pokt.foundation   # must show the fingerprint above
gpg --verify SHA256SUMS.asc SHA256SUMS        # must say "Good signature"
sha256sum -c SHA256SUMS --ignore-missing

cli.md has the full steps for every system.

Help

Ask on the Pocket Network Discord, https://discord.gg/pocket-network. faq.md says what to include, and what never to share.

About

Pocket API CLI (budgetkitctl): versioned releases and customer + agent docs, published from budgetkit

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors