> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cdp.coinbase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Types

## Interfaces

### CreateAccountRequest

Defined in: [\_vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts:14](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts#L14)

#### Example

```ts theme={null}
{
    idempotencyKey: "8e03978e-40d5-43e8-bc93-6894a57f9324",
    name: "My Business Account"
}
```

#### Properties

##### idempotencyKey?

```ts theme={null}
optional idempotencyKey: string;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts:20](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts#L20)

An optional string request header for making requests safely retryable.
When included, duplicate requests with the same key will return identical responses.
Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.

##### name?

```ts theme={null}
optional name: string;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts:21](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/CreateAccountRequest.ts#L21)

***

### GetAccountByIdRequest

Defined in: [\_vendor/api/resources/accounts/client/requests/GetAccountByIdRequest.ts:13](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/GetAccountByIdRequest.ts#L13)

#### Example

```ts theme={null}
{
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114"
}
```

#### Properties

##### accountId

```ts theme={null}
accountId: string;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/GetAccountByIdRequest.ts:15](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/GetAccountByIdRequest.ts#L15)

The ID of the account to retrieve.

***

### GetBalanceByAssetRequest

Defined in: [\_vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts:14](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts#L14)

#### Example

```ts theme={null}
{
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    asset: "usd"
}
```

#### Properties

##### accountId

```ts theme={null}
accountId: string;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts:16](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts#L16)

The unique identifier of the account.

##### asset

```ts theme={null}
asset: string;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts:18](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/GetBalanceByAssetRequest.ts#L18)

The symbol of the asset.

***

### ListAccountsRequest

Defined in: [\_vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:13](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts#L13)

#### Example

```ts theme={null}
{
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}
```

#### Properties

##### pageSize?

```ts theme={null}
optional pageSize: number;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:15](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts#L15)

The number of resources to return per page.

##### pageToken?

```ts theme={null}
optional pageToken: string;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:17](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts#L17)

The token for the next page of resources, if any.

##### type?

```ts theme={null}
optional type: AccountType;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts:19](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/ListAccountsRequest.ts#L19)

Filter accounts by account type. When omitted, accounts of any type are returned. Combined with `owner` using AND.

***

### ListAccountsResponse

Defined in: [\_vendor/api/resources/accounts/types/ListAccountsResponse.ts:5](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/types/ListAccountsResponse.ts#L5)

#### Properties

##### accounts

```ts theme={null}
accounts: Account[];
```

Defined in: [\_vendor/api/resources/accounts/types/ListAccountsResponse.ts:7](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/types/ListAccountsResponse.ts#L7)

The list of accounts.

##### nextPageToken?

```ts theme={null}
optional nextPageToken: string;
```

Defined in: [\_vendor/api/resources/accounts/types/ListAccountsResponse.ts:9](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/types/ListAccountsResponse.ts#L9)

The token for the next page of items, if any.

***

### ListBalancesRequest

Defined in: [\_vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:14](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts#L14)

#### Example

```ts theme={null}
{
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}
```

#### Properties

##### accountId

```ts theme={null}
accountId: string;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:16](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts#L16)

The unique identifier of the account.

##### pageSize?

```ts theme={null}
optional pageSize: number;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:18](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts#L18)

The number of resources to return per page.

##### pageToken?

```ts theme={null}
optional pageToken: string;
```

Defined in: [\_vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts:20](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/client/requests/ListBalancesRequest.ts#L20)

The token for the next page of resources, if any.

***

### ListBalancesResponse

Defined in: [\_vendor/api/resources/accounts/types/ListBalancesResponse.ts:5](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/types/ListBalancesResponse.ts#L5)

#### Properties

##### balances

```ts theme={null}
balances: Balance[];
```

Defined in: [\_vendor/api/resources/accounts/types/ListBalancesResponse.ts:7](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/types/ListBalancesResponse.ts#L7)

The list of balances.

##### nextPageToken?

```ts theme={null}
optional nextPageToken: string;
```

Defined in: [\_vendor/api/resources/accounts/types/ListBalancesResponse.ts:9](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/accounts/types/ListBalancesResponse.ts#L9)

The token for the next page of items, if any.

## Interfaces

### Account

Defined in: [\_vendor/api/types/Account.ts:5](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Account.ts#L5)

#### Properties

##### accountId

```ts theme={null}
accountId: string;
```

Defined in: [\_vendor/api/types/Account.ts:6](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Account.ts#L6)

##### createdAt

```ts theme={null}
createdAt: string;
```

Defined in: [\_vendor/api/types/Account.ts:11](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Account.ts#L11)

The timestamp when the account was created.

##### name?

```ts theme={null}
optional name: string;
```

Defined in: [\_vendor/api/types/Account.ts:9](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Account.ts#L9)

##### owner

```ts theme={null}
owner: string;
```

Defined in: [\_vendor/api/types/Account.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Account.ts#L8)

##### type

```ts theme={null}
type: AccountType;
```

Defined in: [\_vendor/api/types/Account.ts:7](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Account.ts#L7)

##### updatedAt

```ts theme={null}
updatedAt: string;
```

Defined in: [\_vendor/api/types/Account.ts:13](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Account.ts#L13)

The timestamp when the account was last updated.

***

### AmountDetail

Defined in: [\_vendor/api/types/AmountDetail.ts:6](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/AmountDetail.ts#L6)

Available and total amounts for a specific currency.

#### Properties

##### available

```ts theme={null}
available: string;
```

Defined in: [\_vendor/api/types/AmountDetail.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/AmountDetail.ts#L8)

The amount that is currently available to be used.

##### total

```ts theme={null}
total: string;
```

Defined in: [\_vendor/api/types/AmountDetail.ts:10](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/AmountDetail.ts#L10)

The total amount, including the amount that is currently on hold.

***

### Balance

Defined in: [\_vendor/api/types/Balance.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Balance.ts#L8)

A balance of an asset.

#### Properties

##### amount

```ts theme={null}
amount: Record<string, AmountDetail>;
```

Defined in: [\_vendor/api/types/Balance.ts:14](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Balance.ts#L14)

Amount details denominated in different assets.

* The keys represent the asset symbols (e.g., "btc", "usd"), - Each value contains available and total amounts. - There will always be an entry for the asset specified in the `asset` field.

##### asset

```ts theme={null}
asset: BalancesAsset;
```

Defined in: [\_vendor/api/types/Balance.ts:9](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/Balance.ts#L9)

***

### BalancesAsset

Defined in: [\_vendor/api/types/BalancesAsset.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/BalancesAsset.ts#L8)

An asset, e.g. fiat or crypto.

#### Properties

##### decimals

```ts theme={null}
decimals: number;
```

Defined in: [\_vendor/api/types/BalancesAsset.ts:14](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/BalancesAsset.ts#L14)

The number of decimals (i.e. significant digits to the right of the decimal point) supported for the asset.

##### name

```ts theme={null}
name: string;
```

Defined in: [\_vendor/api/types/BalancesAsset.ts:12](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/BalancesAsset.ts#L12)

The name of the asset.

##### symbol

```ts theme={null}
symbol: string;
```

Defined in: [\_vendor/api/types/BalancesAsset.ts:9](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/BalancesAsset.ts#L9)

##### type

```ts theme={null}
type: AssetType;
```

Defined in: [\_vendor/api/types/BalancesAsset.ts:10](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/BalancesAsset.ts#L10)

## Type Aliases

* [AccountId](/sdks/cdp-sdks-v2/typescript/Accounts/AccountId)
* [AccountName](/sdks/cdp-sdks-v2/typescript/Accounts/AccountName)
* [AccountType](/sdks/cdp-sdks-v2/typescript/Accounts/AccountType)
* [Asset](/sdks/cdp-sdks-v2/typescript/Accounts/Asset)
* [AssetType](/sdks/cdp-sdks-v2/typescript/Accounts/AssetType)
* [Owner](/sdks/cdp-sdks-v2/typescript/Accounts/Owner)

## Variables

* [AccountType](/sdks/cdp-sdks-v2/typescript/Accounts/AccountType-1)
* [AssetType](/sdks/cdp-sdks-v2/typescript/Accounts/AssetType-1)