Skip to main content

​
Overview

Get started with the Brickken API in minutes using our official Postman collection. It includes ready-to-run requests for every public endpoint — the BKN faucet, KYC onboarding, agent getters, transaction preparation, signed transaction submission, token documentation management, and the Agentic (x402) API — pre-configured with example payloads and environment variables.

​
Downloads

Brickken API Collection

The full client collection: Create Transaction, Send Transaction, Information, Management, Agentic API (x402) and Discovery requests.

Sandbox Environment

Targets https://api.sandbox.brickken.com — use this for testing.

Production Environment

Targets https://api.brickken.com — use this for live operations.
If a file opens in the browser instead of downloading, right-click the card and choose Save Link As….

​
Import into Postman

  1. Open Postman and click Import (top left).
  2. Drop in the collection file and both environment files.
  3. Select the Brickken API — Sandbox environment from the environment picker (top right).
  4. Open the environment and set your apiKey. Optionally adjust tokenSymbol, chainId, agentChainId, agentUuid, and ownerWalletAddress for the requests you plan to run.
  5. Run any request — authentication is applied automatically via the x-api-key header at collection level.

​
Authentication

Business endpoints are authenticated with an API key in the x-api-key header, and your signerAddress must be whitelisted before writes are accepted.

Request an API key

The form sends a complete request — key and signer whitelist — to tech@brickken.com.
Agentic (x402) endpoints alternatively accept a per-call payment via the X-Payment header. See Authentication for the full credential matrix. The Agent Getters folder defaults to API-key authentication and includes disabled X-Payment headers for manual x402 retries. The KYC folder always requires the API key; creating a link can create an investor and send an invitation email.

​
Faucet UUID lifecycle

The BKN Faucet request uses the materialized bknFaucetIdempotencyKey environment variable. Its pre-request script creates and validates UUID v4 when the variable is empty.
  • Keep the variable unchanged when retrying the same logical claim.
  • Clear bknFaucetIdempotencyKey before a new claim; the next run generates a new UUID v4.
  • Never reuse the UUID with another recipient.
The faucet uses one of the API key’s 10 dedicated lifetime claims. Postman does not sign x402 payment payloads; use the SDK, CLI, or MCP for the 0.01 USDC x402 path.

​
Typical Workflow

1

Prepare

Call a request from the Create Transaction folder — it returns unsigned transactions and a txId.
2

Sign

Sign the returned transactions locally with your whitelisted signer wallet (e.g. using ethers.js).
3

Send

Submit the signed transactions with Send Transactions.
4

Track

Poll Check Transaction Status in the Information folder until the transaction confirms.