CDP Client - Coinbase Developer Documentation

Classes

CdpClient

Defined in: client/cdp.ts:27 The main client for interacting with the CDP API.

Extends

VendoredClient

Constructors

Constructor

new CdpClient(options?: CdpClientOptions): CdpClient;

Defined in: client/cdp.ts:82 The CdpClient is the main class for interacting with the CDP API. There are a few required parameters that are configured in the CDP Portal:

CDP Secret API Key (apiKeyId & apiKeySecret): These are used to authenticate requests to the entire suite of APIs offered on Coinbase Developer Platform. Read more about CDP API keys.
Wallet Secret (walletSecret): This secret is used specifically to authenticate requests to POST, and DELETE endpoints in the EVM and Solana Account APIs.

These parameters can be set as environment variables:

CDP_API_KEY_ID=your-api-key-id
CDP_API_KEY_SECRET=your-api-key-secret
CDP_WALLET_SECRET=your-wallet-secret

Or passed as options to the constructor:

const cdp = new CdpClient({
  apiKeyId: "your-api-key-id",
  apiKeySecret: "your-api-key-secret",
  walletSecret: "your-wallet-secret",
});

The CdpClient is namespaced by chain type: evm or solana. As an example, to create a new EVM account, use cdp.evm.createAccount(). To create a new Solana account, use cdp.solana.createAccount(). The CDP Secret API Key is not required to call public (unauthenticated) endpoints, such as the x402 Bazaar discovery endpoints. A CdpClient may be constructed without credentials for this purpose; calling an authenticated endpoint without credentials will raise a clear error.

Parameters

options?

CdpClientOptions = {} Configuration options for the CdpClient.

Returns

CdpClient

Overrides

VendoredClient.constructor

Properties

_accounts

protected _accounts: AccountsClient | undefined;

Defined in: _vendor/Client.ts:23

Inherited from

VendoredClient._accounts

_depositDestinations

protected _depositDestinations: DepositDestinationsClient | undefined;

Defined in: _vendor/Client.ts:24

Inherited from

VendoredClient._depositDestinations

_options

protected readonly _options: NormalizedClientOptionsWithAuth<BaseClientOptions>;

Defined in: _vendor/Client.ts:22

Inherited from

VendoredClient._options

_paymentMethods

protected _paymentMethods: PaymentMethodsClient | undefined;

Defined in: _vendor/Client.ts:26

Inherited from

VendoredClient._paymentMethods

_transfers

protected _transfers: TransfersClient | undefined;

Defined in: _vendor/Client.ts:25

Inherited from

VendoredClient._transfers

endUser

endUser: EndUserClient;

Defined in: client/cdp.ts:38 Namespace containing all end user methods.

evm

evm: EvmClient;

Defined in: client/cdp.ts:29 Namespace containing all EVM methods.

policies

policies: PoliciesClient;

Defined in: client/cdp.ts:35 Namespace containing all Policies methods.

solana

solana: SolanaClient;

Defined in: client/cdp.ts:32 Namespace containing all Solana methods.

webhooks

webhooks: WebhooksClient;

Defined in: client/cdp.ts:41 Namespace containing all webhook methods.

Accessors

accounts

Get Signature

get accounts(): AccountsClient;

Defined in: _vendor/Client.ts:32

Returns

AccountsClient

Inherited from

VendoredClient.accounts

depositDestinations

Get Signature

get depositDestinations(): DepositDestinationsClient;

Defined in: _vendor/Client.ts:36

Returns

DepositDestinationsClient

Inherited from

VendoredClient.depositDestinations

paymentMethods

Get Signature

get paymentMethods(): PaymentMethodsClient;

Defined in: _vendor/Client.ts:44

Returns

PaymentMethodsClient

Inherited from

VendoredClient.paymentMethods

transfers

Get Signature

get transfers(): TransfersClient;

Defined in: _vendor/Client.ts:40

Returns

TransfersClient

Inherited from

VendoredClient.transfers

Methods

fetch()

fetch(
   input: string | Request | URL, 
   init?: RequestInit, 
requestOptions?: RequestOptions): Promise<Response>;

Defined in: _vendor/Client.ts:58 Make a passthrough request using the SDK’s configured auth, retry, logging, etc. This is useful for making requests to endpoints not yet supported in the SDK. The input can be a URL string, URL object, or Request object. Relative paths are resolved against the configured base URL.

Parameters

input

The URL, path, or Request object. string | Request | URL

init?

RequestInit Standard fetch RequestInit options.

requestOptions?

RequestOptions Per-request overrides (timeout, retries, headers, abort signal).

Returns

Promise<Response> A standard Response object.

Inherited from

VendoredClient.fetch

Interfaces

CdpClientOptions

Defined in: client/cdp.ts:11

Properties

apiKeyId?

optional apiKeyId: string;

Defined in: client/cdp.ts:13 The API key ID.

apiKeySecret?

optional apiKeySecret: string;

Defined in: client/cdp.ts:15 The API key secret.

basePath?

optional basePath: string;

Defined in: client/cdp.ts:21 The host URL to connect to.

debugging?

optional debugging: boolean;

Defined in: client/cdp.ts:19 Whether to enable debugging.

walletSecret?

optional walletSecret: string;

Defined in: client/cdp.ts:17 The wallet secret.

​Classes

​CdpClient

​Extends

​Constructors

Constructor

Parameters

options?

Returns

Overrides

​Properties

_accounts

Inherited from

_depositDestinations

Inherited from

_options

Inherited from

_paymentMethods

Inherited from

_transfers

Inherited from

endUser

evm

policies

solana

webhooks

​Accessors

accounts

Get Signature

Returns

Inherited from

depositDestinations

Get Signature

Returns

Inherited from

paymentMethods

Get Signature

Returns

Inherited from

transfers

Get Signature

Returns

Inherited from

​Methods

fetch()

Parameters

input

init?

requestOptions?

Returns

Inherited from

​Interfaces

​CdpClientOptions

​Properties

apiKeyId?

apiKeySecret?

basePath?

debugging?

walletSecret?

Classes

CdpClient

Extends

Constructors

Properties

Accessors

Methods

Interfaces

CdpClientOptions

Properties