REST SDK

You’re viewing the 2.0 (LTS) docs. View the current 3.0 version of this page.

@getpara/rest-sdk is Para’s typed SDK for REST API wallets. Use it from trusted backend code when your server owns API-key-backed wallet creation, lookup, signing, transfers, and transaction history.

This SDK sends your partner API key as X-API-Key. Never import it from browser, React, mobile, wagmi, RainbowKit, or any user-controlled runtime.

Install

yarn add @getpara/rest-sdk

The core client works in Node.js 18+ or any server runtime where you inject fetch. Install adapter peers only when you use those subpaths:

yarn add ethers
yarn add viem
yarn add @solana/addresses @solana/keys @solana/signers @solana/transactions

Choose the Right SDK

Use case	Package
API-key-backed programmatic wallets, REST pregen wallets, typed REST signing	`@getpara/rest-sdk`
Share-backed server flows, imported user sessions, `migrateWalletShare()` encryption	`@getpara/server-sdk`
User authentication, wallet UI, browser/mobile signing	Web, React, React Native, Swift, or Flutter SDKs

Core Client

import { ParaRestClient, ParaRestError } from '@getpara/rest-sdk';

const para = new ParaRestClient({
  apiKey: process.env.PARA_API_KEY!,
  env: 'BETA',
});

const wallet = await para.createWallet(
  {
    type: 'EVM',
    userIdentifier: 'user@test.getpara.com',
    userIdentifierType: 'EMAIL',
  },
  { idempotencyKey: crypto.randomUUID() },
);

const { signature } = await para.signMessage(wallet.id, { message: 'hello' });

env accepts PROD, BETA, or { baseUrl }. Each request sends X-API-Key and X-Request-Id. Idempotency-Key is caller-supplied; the SDK does not retry requests or generate idempotency keys internally. Pass AbortSignal per call when your server needs a request deadline:

await para.getWallet(wallet.id, {
  signal: AbortSignal.timeout(10_000),
});

Wallet type boundaries

The core client uses the same lifecycle methods for every supported wallet type. Pass EVM, COSMOS, SOLANA, STELLAR, or SUI to createWallet(); later methods infer the chain from the wallet ID.

Capability	EVM	Cosmos	Solana	Stellar	Sui
Create, list, get, and update	Yes	Yes	Yes	Yes	Yes
`getWalletBalance()`	Yes	No	Yes	No	No
`signMessage()` and `signRaw()`	Yes	Yes	Yes	Yes	Yes
`signTransaction()`	Yes	No	Yes	Yes	Yes
`transfer()` and `estimateFee()`	Yes	No	Yes	No	No
`listRestTransactions()` and `getRestTransaction()`	Yes	No	Yes	No	No

See Wallet Lifecycle by Wallet Type for creation examples, Sign Messages by Wallet Type for message payloads, and Transaction Signing by Wallet Type for transaction and raw-byte payloads.

The Sui transaction-signing route returns signature and transaction, but the SDK’s generic signTransaction() TypeScript response currently declares signedTransaction, txHash, and transactionId. Use the REST route directly when TypeScript code needs the Sui response fields.

Adapters

import { createParaRestEthersSigner } from '@getpara/rest-sdk/ethers';
import { createParaRestViemAccount } from '@getpara/rest-sdk/viem';
import { createParaRestSolanaSigner } from '@getpara/rest-sdk/solana';

const ethersSigner = createParaRestEthersSigner({ client: para, walletId, address });
const viemAccount = createParaRestViemAccount({ client: para, walletId, address: address as `0x${string}` });
const solanaSigner = createParaRestSolanaSigner({ client: para, walletId: solanaWalletId, address: solanaAddress });

Adapters are convenience layers, not separate wallet APIs. REST and session-backed signing use different packages:

Wallet type	REST SDK interface	Session-backed integration after claim
EVM	`@getpara/rest-sdk/ethers` or `@getpara/rest-sdk/viem`	`@getpara/ethers-v5-integration`, `@getpara/ethers-v6-integration`, `@getpara/viem-v1-integration`, or `@getpara/viem-v2-integration`
Cosmos	`ParaRestClient`	`@getpara/cosmjs-v0-integration`
Solana	`@getpara/rest-sdk/solana`	`@getpara/solana-signers-v2-integration` or `@getpara/solana-web3.js-v1-integration`
Stellar	`ParaRestClient`	`@getpara/stellar-sdk-v14-integration`
Sui	`ParaRestClient`	`@getpara/sui-sdk-integration`

The session-backed packages use an authenticated Para session. They are not REST adapters. For EVM, string messages use signMessage() and typed data uses signTypedData(), so Para performs the EIP-191 or EIP-712 hash. Byte-like messages are EIP-191 hashed locally by both adapters and sent through signRaw(). In viem, a 0x... string is text; pass { raw: bytes } when it represents bytes. Both EVM adapters support ordinary legacy and EIP-1559 transaction sends. They reject contract deployments, access lists, blob transactions, and authorization-list transactions before calling REST. The Viem adapter also rejects custom transaction serializers. Only the Viem REST account exposes signAuthorization() for EIP-7702. Ethers callers use para.signAuthorization() directly. The Solana adapter implements Solana v2 signer traits by signing message bytes through sign-raw. For broadcasted transactions, call para.signTransaction(walletId, { transaction, broadcast: true }) or para.transfer(...).

Errors

ParaRestValidationError is thrown before fetch for missing local required fields or unsupported adapter inputs. ParaRestSerializationError means the request body cannot be JSON serialized. HTTP errors become ParaRestError with status, code, requestId, and parsed body.

try {
  await para.getWallet(wallet.id);
} catch (error) {
  if (error instanceof ParaRestError) {
    console.error(error.status, error.code, error.requestId, error.body);
  }
}

Example

The typed SDK example creates REST wallets and demonstrates core client, ethers, viem, and Solana adapters:

cd examples-hub/server/rest-with-typed-sdk
cp .env.example .env
yarn install
yarn dev

Use examples-hub/server/rest-with-node when you want to inspect the raw HTTP baseline.

Trust Boundary

REST signing uses the wallet ID and your partner API key. Your backend is responsible for deciding which end user or job is allowed to request a wallet operation before calling Para. The SDK validates local required fields and normalizes adapter inputs, but it does not independently reconstruct or audit every signed transaction returned by REST.

Non-goals

The REST SDK does not include browser connectors, React hooks, wagmi or RainbowKit integration, mobile auth, hosted UI, client-side sessions, automatic retries, or user-share encryption helpers. Use @getpara/server-sdk for migrateWalletShare() and share-backed server flows.

Getting Started

Create and Manage Wallets

Sign and Transact

Manage Access

Use Pregeneration

Endpoints

Install

Choose the Right SDK

Core Client

Wallet type boundaries

Adapters

Errors

Example

Trust Boundary

Non-goals

​Install

​Choose the Right SDK

​Core Client

​Wallet type boundaries

​Adapters

​Errors

​Example

​Trust Boundary

​Non-goals

Install

Choose the Right SDK

Core Client

Wallet type boundaries

Adapters

Errors

Example

Trust Boundary

Non-goals