Overview

These examples assume you installed qn and authenticated with qn auth login. If you have not set up the CLI yet, start with the CLI Overview. For install options, authentication order, output formats, and confirmation behavior, see the CLI Overview.

Use --format json when command output will be read by a script. See Output for all supported formats.

Copy the commands below into your terminal and replace example IDs, labels, URLs, and addresses with values from your account.

Auth

For API key setup and credential precedence, see Authenticate.

qn auth login
qn auth whoami
qn auth status
qn auth logout

Endpoints

qn endpoint list --limit 20
qn endpoint list --network ethereum-mainnet --status active
qn endpoint show 123
qn endpoint urls 123
qn endpoint logs 123 --from 1h --to now --limit 50
qn endpoint metrics 123 --metric method_calls_over_time --period day

Create and lifecycle commands change endpoint state:

These commands prompt before acting when confirmation is required. See Confirmations for prompt-safe usage.

qn endpoint create --chain ethereum --network mainnet
qn endpoint pause 123
qn endpoint resume 123
qn endpoint archive 123

Endpoint tags

Tag add, rename, remove, and delete commands change endpoint metadata.

qn endpoint tag list
qn endpoint tag add 123 --label production
qn endpoint tag remove 123 12
qn endpoint tag rename 12 --label mainnet-production
qn endpoint tag delete 12

Endpoint security

Token, referrer, IP allowlist, and request filter commands can change endpoint access rules. Review Authenticate before using these in scripts.

qn endpoint security show 123
qn endpoint security options 123
qn endpoint security token create 123
qn endpoint security token delete 123 9
qn endpoint security referrer add 123 --referrer https://example.com
qn endpoint security referrer remove 123 9
qn endpoint security ip add 123 --ip 203.0.113.10
qn endpoint security ip remove 123 9
qn endpoint security request-filter add 123 --method eth_getBalance --method eth_blockNumber
qn endpoint security request-filter remove 123 9

Endpoint rate limits

Rate limit set and delete commands change endpoint traffic controls.

qn endpoint rate-limit get 123
qn endpoint rate-limit set 123 --rps 100 --rpm 5000
qn endpoint rate-limit delete-override 123 9
qn endpoint rate-limit method-list 123
qn endpoint rate-limit method-create 123 --interval minute --method eth_getLogs --rate 120
qn endpoint rate-limit method-delete 123 9

Bulk endpoint operations

Bulk operations can change multiple endpoints in one command.

qn endpoint bulk pause 123 456 789
qn endpoint bulk resume 123 456 789
qn endpoint bulk tag add --label production 123 456
qn endpoint bulk tag remove --tag-id 12 123 456

Teams

Team create, membership, endpoint assignment, and delete commands change account configuration.

qn team list
qn team show 7
qn team endpoints 7
qn team create --name "Data Platform"
qn team set-endpoints 7 123 456
qn team member invite 7 --email teammate@example.com --role viewer
qn team member remove 7 42
qn team delete 7

Usage, metrics, chains, and billing

qn usage summary --from 7d
qn usage by-endpoint --from 7d
qn usage by-chain --from 7d
qn usage by-tag --from 7d
qn metrics account --period day --metric credits_over_time
qn metrics endpoint 123 --period day --metric method_calls_over_time
qn chain list
qn billing invoices
qn billing payments

Streams

qn stream list --limit 20
qn stream show 123
qn stream enabled-count
qn stream test-filter \
  --network ethereum-mainnet \
  --dataset block \
  --block 17811625 \
  --filter-file filter.js

Create and lifecycle commands change Stream state:

These commands prompt before acting when confirmation is required. See Confirmations.

qn stream create \
  --name blocks \
  --network ethereum-mainnet \
  --dataset block \
  --start 17811625 \
  --end=-1 \
  --region usa-east \
  --webhook https://example.com/webhook

qn stream pause 123
qn stream activate 123
qn stream delete 123

Webhooks

qn webhook list --limit 20
qn webhook show 123
qn webhook enabled-count

Create and lifecycle commands change Webhook state:

These commands prompt before acting when confirmation is required. See Confirmations.

qn webhook create \
  --name "wallet alerts" \
  --network ethereum-mainnet \
  --url https://example.com/webhook \
  --template evm-wallet \
  --wallet 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48

qn webhook pause 123
qn webhook activate 123 --start-from latest
qn webhook delete 123

Key-Value Store

Sets store a single value by key:

Write and delete commands change KV data.

qn kv set put mykey myvalue
qn kv set get mykey
qn kv set ls
qn kv set delete mykey

Lists store ordered values under a key:

qn kv list create allowlist 0xabc 0xdef
qn kv list append allowlist 0x123
qn kv list contains allowlist 0xabc
qn kv list get allowlist
qn kv list delete allowlist

Global flags

For credentials in CI, use --config-file or pass --api-key from a secret store. See Authenticate.

qn endpoint list --format json
qn endpoint list --wide
qn endpoint list --no-color
qn endpoint list --verbose
qn --config-file ./qn.toml endpoint list
qn --api-key YOUR_API_KEY endpoint list
qn completions zsh