Skip to main content

​
Classes

​
CdpClient

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

​
Constructors

Constructor
new CdpClient(options?: CdpClientOptions): CdpClient;
Defined in: cdp.ts:73 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().
Parameters
options?
CdpClientOptions = {} Configuration options for the CdpClient.
Returns
CdpClient

​
Properties

endUser
endUser: CDPEndUserClient;
Defined in: cdp.ts:36 Namespace containing all end user methods.
evm
evm: EvmClient;
Defined in: cdp.ts:27 Namespace containing all EVM methods.
policies
policies: PoliciesClient;
Defined in: cdp.ts:33 Namespace containing all Policies methods.
solana
solana: SolanaClient;
Defined in: cdp.ts:30 Namespace containing all Solana methods.

​
Interfaces

​
CdpClientOptions

Defined in: cdp.ts:9

​
Properties

apiKeyId?
optional apiKeyId: string;
Defined in: cdp.ts:11 The API key ID.
apiKeySecret?
optional apiKeySecret: string;
Defined in: cdp.ts:13 The API key secret.
basePath?
optional basePath: string;
Defined in: cdp.ts:19 The host URL to connect to.
debugging?
optional debugging: boolean;
Defined in: cdp.ts:17 Whether to enable debugging.
walletSecret?
optional walletSecret: string;
Defined in: cdp.ts:15 The wallet secret.