Bitnob Enterprise API quickstart

This quickstart is for the Bitnob Enterprise API, Bitnob’s non-custodial wallet infrastructure. If you want Bitnob to hold the balance and settle payouts, cards, or trades for you, use the Bitnob Business API quickstart instead. Every request goes to https://api.platform.bitnob.com with your key in the X-API-Key header. There’s no request signing.

Get an API key

Create a key in the Bitnob dashboard, as described in Set up your account, and store it server-side. The key decides the environment: a live key works on mainnet, and a sandbox key on testnets.

export PLATFORM_API_KEY=your_api_key

Confirm the key works

Get API key info returns the key, the organization it belongs to, and the scopes it carries.

curl https://api.platform.bitnob.com/v1/me \
  -H "X-API-Key: $PLATFORM_API_KEY"

{
  "id": "d6c33cfa-7ffa-492a-b7da-dd3b4e1f013b",
  "object": "api_key",
  "name": "playground-work",
  "organization_id": "00000000-0000-4000-8000-000000000001",
  "scopes": [
    "transactions:create",
    "transactions:read",
    "vaults:view",
    "wallets:create",
    "wallets:read"
  ],
  "api_version": "v1",
  "created_at": "2026-10-18T07:16:33.516081Z"
}

The scope list is shortened here. A missing or wrong key returns 401 with a code you can branch on:

{
  "error": {
    "type": "authentication_error",
    "code": "not_authenticated",
    "message": "Invalid or expired API key"
  }
}

See the chains you can use

List chains returns every supported chain and its networks.

curl https://api.platform.bitnob.com/v1/assets/chains \
  -H "X-API-Key: $PLATFORM_API_KEY"

{
  "object": "list",
  "data": [
    { "id": "bitcoin", "object": "chain", "name": "bitcoin", "networks": ["mainnet", "testnet"] },
    { "id": "ethereum", "object": "chain", "name": "ethereum", "networks": ["mainnet", "sepolia"] },
    { "id": "polygon", "object": "chain", "name": "polygon", "networks": ["mainnet", "amoy"] }
  ]
}

The list is shortened here.

Find your vault

Wallets live inside a vault, and vaults are created in the dashboard, not over the API. Once you have one, List vaults returns its id:

curl https://api.platform.bitnob.com/v1/vaults \
  -H "X-API-Key: $PLATFORM_API_KEY"

Lists share one shape. A new organization with no vaults yet returns:

{
  "object": "list",
  "data": [],
  "has_more": false,
  "url": "/v1/vaults"
}

Create a wallet

Create wallet needs a name, a chain, and the vault_id. It also needs an Idempotency-Key header, so a retried request can’t create a second wallet.

curl -X POST https://api.platform.bitnob.com/v1/wallets \
  -H "X-API-Key: $PLATFORM_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "name": "treasury-btc",
    "chain": "bitcoin",
    "vault_id": "<your vault id>"
  }'

The wallet’s primary address is created with it. Leave out Idempotency-Key and the request fails before anything is created:

{
  "error": {
    "type": "invalid_request_error",
    "code": "idempotency_key_required",
    "message": "Idempotency-Key header is required",
    "param": "Idempotency-Key"
  }
}

Next steps

Core concepts

How organizations, vaults, wallets, and addresses fit together.

Making requests

Versioning, idempotency, pagination, errors, and rate limits.

Best practices

Key handling, policies, and safe retries.

Bitnob Enterprise API reference

Every endpoint, with request and response schemas.

Get started

Policies

Gas sponsorship

Bitcoin

Use cases

Bitnob Enterprise API quickstart

Next steps

Core concepts

Making requests

Best practices

Bitnob Enterprise API reference

​Next steps

Core concepts

Making requests

Best practices

Bitnob Enterprise API reference

Next steps