Quickstart

Prerequisites

Node.js 20 or newer. The SDK is server-only.
A Blank account with a username set and a verified wallet.
A scoped API key for the environment you are calling.

1. Install the SDK

npm install @blankdotbuild/sdk@^3.0.0

pnpm add @blankdotbuild/sdk@^3.0.0

bun add @blankdotbuild/sdk@^3.0.0

Major version 3 is the client for API v2. Pin it explicitly: earlier majors targeted the removed legacy API and will not work against /api/v2. Version 3 ships typed resource modules, runtime response validation, bounded retries, durable idempotency keys, Problem Details errors, pagination helpers, transaction-intent submission, and webhook signature verification.

2. Create an API key

Sign in at blank.build and open Settings.
Set a username if the account does not have one.
Create a key: name it, pick an expiry, and select only the scopes it needs. Scopes cannot be widened after creation.
Copy the secret immediately. It is displayed once and never again.

Production keys start with blank_live_. Development and staging keys start with blank_test_. See Authentication for the full lifecycle.

3. Configure your server environment

BLANK_API_KEY=blank_live_...

Never ship an API key to a browser, a mobile app, or a public repository. The SDK throws if you construct a client with an apiKey in a browser runtime, and the API grants no browser CORS allowance to authenticated requests.

4. Create a client

import { BlankClient } from "@blankdotbuild/sdk";

const blank = new BlankClient({
  apiKey: process.env.BLANK_API_KEY,
});

The default origin is https://api.blank.build/api/v2. Override baseUrl only for a trusted staging or local Blank deployment; it must use HTTPS outside localhost. apiKey also accepts a function returning a string or Promise<string>, so you can pull the credential from a secret manager on each request.

5. Confirm the key

const identity = await blank.identity.me();

console.log(identity.data.environment); // "production"
console.log(identity.data.walletAddress); // the wallet pinned to this key
console.log(identity.data.scopes); // the scopes this key grants
console.log(identity.data.expiresAt); // when the key stops working

GET /me works with any valid key and returns nothing beyond the key’s own identity. It is the fastest way to check that a credential, environment, and scope set are what you expect.

6. Read public data

Token and market reads need no key at all:

const tokens = await blank.tokens.list({ status: "bonding", limit: 20 });

for (const token of tokens.data.data) {
  console.log(token.mintAddress, token.symbol, token.currentPriceInSol);
}

console.log(tokens.data.page.hasMore, tokens.data.page.nextCursor);

The same call over raw HTTP:

curl -s "https://api.blank.build/api/v2/tokens?status=bonding&limit=20" \
  -H "Accept: application/json"

7. Read the response metadata

Every SDK call returns { data, metadata, response }.

const snapshot = await blank.marketData.snapshot(mintAddress);

console.log(snapshot.metadata.requestId); // X-Request-Id — log this
console.log(snapshot.metadata.rateLimit.remaining); // X-RateLimit-Remaining
console.log(snapshot.metadata.apiVersion); // "2"

Log metadata.requestId alongside every failure. It is the identifier Blank needs to trace a request.

Next steps

Scopes

Exactly which scope each operation requires.

Conventions

Pagination, rate limits, retries, deadlines, and idempotency.

Price predictions

The main automation surface: eligibility, rounds, and submissions.

Webhooks

Signed CloudEvents instead of polling.

Start Here

Features

For Developers

Reference

API Reference

Endpoints

Quickstart

Quickstart

Prerequisites

1. Install the SDK

2. Create an API key

3. Configure your server environment

4. Create a client

5. Confirm the key

6. Read public data

7. Read the response metadata

Next steps

Scopes

Conventions

Price predictions

Webhooks

​Quickstart

​Prerequisites

​1. Install the SDK

​2. Create an API key

​3. Configure your server environment

​4. Create a client

​5. Confirm the key

​6. Read public data

​7. Read the response metadata

​Next steps

Scopes

Conventions

Price predictions

Webhooks

Quickstart

Prerequisites

1. Install the SDK

2. Create an API key

3. Configure your server environment

4. Create a client

5. Confirm the key

6. Read public data

7. Read the response metadata

Next steps