cdp.openapi_client.api package

Submodules

cdp.openapi_client.api.end_user_accounts_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.end_user_accounts_api.EndUserAccountsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async create_end_user(x_wallet_auth=None, x_idempotency_key=None, create_end_user_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an end user

Creates an end user. An end user is an entity that can own CDP EVM accounts, EVM smart accounts, and/or Solana accounts. 1 or more authentication methods must be associated with an end user. By default, no accounts are created unless the optional evmAccount and/or solanaAccount fields are provided. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_end_user_request (CreateEndUserRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EndUser

Returns:

Returns the result object.

async create_end_user_with_http_info(x_wallet_auth=None, x_idempotency_key=None, create_end_user_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an end user

Creates an end user. An end user is an entity that can own CDP EVM accounts, EVM smart accounts, and/or Solana accounts. 1 or more authentication methods must be associated with an end user. By default, no accounts are created unless the optional evmAccount and/or solanaAccount fields are provided. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_end_user_request (CreateEndUserRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EndUser]

Returns:

Returns the result object.

async create_end_user_without_preload_content(x_wallet_auth=None, x_idempotency_key=None, create_end_user_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an end user

Creates an end user. An end user is an entity that can own CDP EVM accounts, EVM smart accounts, and/or Solana accounts. 1 or more authentication methods must be associated with an end user. By default, no accounts are created unless the optional evmAccount and/or solanaAccount fields are provided. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_end_user_request (CreateEndUserRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_end_user(user_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an end user

Gets an end user by ID. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

• user_id (str) – The ID of the end user to get. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EndUser

Returns:

Returns the result object.

async get_end_user_with_http_info(user_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an end user

Gets an end user by ID. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

• user_id (str) – The ID of the end user to get. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EndUser]

Returns:

Returns the result object.

async get_end_user_without_preload_content(user_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an end user

Gets an end user by ID. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

• user_id (str) – The ID of the end user to get. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async list_end_users(page_size=None, page_token=None, sort=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List end users

Lists the end users belonging to the developer’s CDP Project. By default, the response is sorted by creation date in ascending order and paginated to 20 users per page.

Parameters:

• page_size (int) – The number of end users to return per page.

• page_token (str) – The token for the desired page of end users. Will be empty if there are no more end users to fetch.

• sort (List[str]) – Sort end users. Defaults to ascending order (oldest first).

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListEndUsers200Response

Returns:

Returns the result object.

async list_end_users_with_http_info(page_size=None, page_token=None, sort=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List end users

Lists the end users belonging to the developer’s CDP Project. By default, the response is sorted by creation date in ascending order and paginated to 20 users per page.

Parameters:

• page_size (int) – The number of end users to return per page.

• page_token (str) – The token for the desired page of end users. Will be empty if there are no more end users to fetch.

• sort (List[str]) – Sort end users. Defaults to ascending order (oldest first).

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ListEndUsers200Response]

Returns:

Returns the result object.

async list_end_users_without_preload_content(page_size=None, page_token=None, sort=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List end users

Lists the end users belonging to the developer’s CDP Project. By default, the response is sorted by creation date in ascending order and paginated to 20 users per page.

Parameters:

• page_size (int) – The number of end users to return per page.

• page_token (str) – The token for the desired page of end users. Will be empty if there are no more end users to fetch.

• sort (List[str]) – Sort end users. Defaults to ascending order (oldest first).

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async validate_end_user_access_token(validate_end_user_access_token_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Validate end user access token

Validates the end user’s access token and returns the end user’s information. Returns an error if the access token is invalid or expired. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

• validate_end_user_access_token_request (ValidateEndUserAccessTokenRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EndUser

Returns:

Returns the result object.

async validate_end_user_access_token_with_http_info(validate_end_user_access_token_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Validate end user access token

Validates the end user’s access token and returns the end user’s information. Returns an error if the access token is invalid or expired. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

• validate_end_user_access_token_request (ValidateEndUserAccessTokenRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EndUser]

Returns:

Returns the result object.

async validate_end_user_access_token_without_preload_content(validate_end_user_access_token_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Validate end user access token

Validates the end user’s access token and returns the end user’s information. Returns an error if the access token is invalid or expired. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

• validate_end_user_access_token_request (ValidateEndUserAccessTokenRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.evm_accounts_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.evm_accounts_api.EVMAccountsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async create_evm_account(x_wallet_auth=None, x_idempotency_key=None, create_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an EVM account

Creates a new EVM account.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_evm_account_request (CreateEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmAccount

Returns:

Returns the result object.

async create_evm_account_with_http_info(x_wallet_auth=None, x_idempotency_key=None, create_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an EVM account

Creates a new EVM account.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_evm_account_request (CreateEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmAccount]

Returns:

Returns the result object.

async create_evm_account_without_preload_content(x_wallet_auth=None, x_idempotency_key=None, create_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an EVM account

Creates a new EVM account.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_evm_account_request (CreateEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async export_evm_account(address, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export an EVM account

Export an existing EVM account’s private key. It is important to store the private key in a secure place after it’s exported.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. The address does not need to be checksummed. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ExportEvmAccount200Response

Returns:

Returns the result object.

async export_evm_account_by_name(name, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export an EVM account by name

Export an existing EVM account’s private key by its name. It is important to store the private key in a secure place after it’s exported.

Parameters:

• name (str) – The name of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ExportEvmAccount200Response

Returns:

Returns the result object.

async export_evm_account_by_name_with_http_info(name, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export an EVM account by name

Export an existing EVM account’s private key by its name. It is important to store the private key in a secure place after it’s exported.

Parameters:

• name (str) – The name of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ExportEvmAccount200Response]

Returns:

Returns the result object.

async export_evm_account_by_name_without_preload_content(name, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export an EVM account by name

Export an existing EVM account’s private key by its name. It is important to store the private key in a secure place after it’s exported.

Parameters:

• name (str) – The name of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async export_evm_account_with_http_info(address, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export an EVM account

Export an existing EVM account’s private key. It is important to store the private key in a secure place after it’s exported.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. The address does not need to be checksummed. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ExportEvmAccount200Response]

Returns:

Returns the result object.

async export_evm_account_without_preload_content(address, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export an EVM account

Export an existing EVM account’s private key. It is important to store the private key in a secure place after it’s exported.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. The address does not need to be checksummed. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_evm_account(address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an EVM account by address

Gets an EVM account by its address.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. The address does not need to be checksummed. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmAccount

Returns:

Returns the result object.

async get_evm_account_by_name(name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an EVM account by name

Gets an EVM account by its name.

Parameters:

• name (str) – The name of the EVM account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmAccount

Returns:

Returns the result object.

async get_evm_account_by_name_with_http_info(name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an EVM account by name

Gets an EVM account by its name.

Parameters:

• name (str) – The name of the EVM account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmAccount]

Returns:

Returns the result object.

async get_evm_account_by_name_without_preload_content(name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an EVM account by name

Gets an EVM account by its name.

Parameters:

• name (str) – The name of the EVM account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_evm_account_with_http_info(address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an EVM account by address

Gets an EVM account by its address.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. The address does not need to be checksummed. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmAccount]

Returns:

Returns the result object.

async get_evm_account_without_preload_content(address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an EVM account by address

Gets an EVM account by its address.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. The address does not need to be checksummed. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async import_evm_account(x_wallet_auth=None, x_idempotency_key=None, import_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Import an EVM account

Import an existing EVM account into the developer’s CDP Project. This API should be called from the [CDP SDK](https://github.com/coinbase/cdp-sdk) to ensure that the associated private key is properly encrypted.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• import_evm_account_request (ImportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmAccount

Returns:

Returns the result object.

async import_evm_account_with_http_info(x_wallet_auth=None, x_idempotency_key=None, import_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Import an EVM account

Import an existing EVM account into the developer’s CDP Project. This API should be called from the [CDP SDK](https://github.com/coinbase/cdp-sdk) to ensure that the associated private key is properly encrypted.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• import_evm_account_request (ImportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmAccount]

Returns:

Returns the result object.

async import_evm_account_without_preload_content(x_wallet_auth=None, x_idempotency_key=None, import_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Import an EVM account

Import an existing EVM account into the developer’s CDP Project. This API should be called from the [CDP SDK](https://github.com/coinbase/cdp-sdk) to ensure that the associated private key is properly encrypted.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• import_evm_account_request (ImportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async list_evm_accounts(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List EVM accounts

Lists the EVM accounts belonging to the developer’s CDP Project. The response is paginated, and by default, returns 20 accounts per page.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListEvmAccounts200Response

Returns:

Returns the result object.

async list_evm_accounts_with_http_info(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List EVM accounts

Lists the EVM accounts belonging to the developer’s CDP Project. The response is paginated, and by default, returns 20 accounts per page.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ListEvmAccounts200Response]

Returns:

Returns the result object.

async list_evm_accounts_without_preload_content(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List EVM accounts

Lists the EVM accounts belonging to the developer’s CDP Project. The response is paginated, and by default, returns 20 accounts per page.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async send_evm_transaction(address, x_wallet_auth=None, x_idempotency_key=None, send_evm_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Send a transaction

Signs a transaction with the given EVM account and sends it to the indicated supported network. This API handles nonce management and gas estimation, leaving the developer to provide only the minimal set of fields necessary to send the transaction. The transaction should be serialized as a hex string using [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/). The transaction must be an [EIP-1559 dynamic fee transaction](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). Transaction fields and API behavior - to (Required): The address of the contract or account to send the transaction to. - chainId (Ignored): The value of the chainId field in the transaction is ignored. The transaction will be sent to the network indicated by the network field in the request body. - nonce (Optional): The nonce to use for the transaction. If not provided, the API will assign a nonce to the transaction based on the current state of the account. - maxPriorityFeePerGas (Optional): The maximum priority fee per gas to use for the transaction. If not provided, the API will estimate a value based on current network conditions. - maxFeePerGas (Optional): The maximum fee per gas to use for the transaction. If not provided, the API will estimate a value based on current network conditions. - gasLimit (Optional): The gas limit to use for the transaction. If not provided, the API will estimate a value based on the to and data fields of the transaction. - value (Optional): The amount of ETH, in wei, to send with the transaction. - data (Optional): The data to send with the transaction; only used for contract calls. - accessList (Optional): The access list to use for the transaction.

Parameters:

• address (str) – The 0x-prefixed address of the Ethereum account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• send_evm_transaction_request (SendEvmTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SendEvmTransaction200Response

Returns:

Returns the result object.

async send_evm_transaction_with_http_info(address, x_wallet_auth=None, x_idempotency_key=None, send_evm_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Send a transaction

Signs a transaction with the given EVM account and sends it to the indicated supported network. This API handles nonce management and gas estimation, leaving the developer to provide only the minimal set of fields necessary to send the transaction. The transaction should be serialized as a hex string using [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/). The transaction must be an [EIP-1559 dynamic fee transaction](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). Transaction fields and API behavior - to (Required): The address of the contract or account to send the transaction to. - chainId (Ignored): The value of the chainId field in the transaction is ignored. The transaction will be sent to the network indicated by the network field in the request body. - nonce (Optional): The nonce to use for the transaction. If not provided, the API will assign a nonce to the transaction based on the current state of the account. - maxPriorityFeePerGas (Optional): The maximum priority fee per gas to use for the transaction. If not provided, the API will estimate a value based on current network conditions. - maxFeePerGas (Optional): The maximum fee per gas to use for the transaction. If not provided, the API will estimate a value based on current network conditions. - gasLimit (Optional): The gas limit to use for the transaction. If not provided, the API will estimate a value based on the to and data fields of the transaction. - value (Optional): The amount of ETH, in wei, to send with the transaction. - data (Optional): The data to send with the transaction; only used for contract calls. - accessList (Optional): The access list to use for the transaction.

Parameters:

• address (str) – The 0x-prefixed address of the Ethereum account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• send_evm_transaction_request (SendEvmTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SendEvmTransaction200Response]

Returns:

Returns the result object.

async send_evm_transaction_without_preload_content(address, x_wallet_auth=None, x_idempotency_key=None, send_evm_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Send a transaction

Signs a transaction with the given EVM account and sends it to the indicated supported network. This API handles nonce management and gas estimation, leaving the developer to provide only the minimal set of fields necessary to send the transaction. The transaction should be serialized as a hex string using [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/). The transaction must be an [EIP-1559 dynamic fee transaction](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). Transaction fields and API behavior - to (Required): The address of the contract or account to send the transaction to. - chainId (Ignored): The value of the chainId field in the transaction is ignored. The transaction will be sent to the network indicated by the network field in the request body. - nonce (Optional): The nonce to use for the transaction. If not provided, the API will assign a nonce to the transaction based on the current state of the account. - maxPriorityFeePerGas (Optional): The maximum priority fee per gas to use for the transaction. If not provided, the API will estimate a value based on current network conditions. - maxFeePerGas (Optional): The maximum fee per gas to use for the transaction. If not provided, the API will estimate a value based on current network conditions. - gasLimit (Optional): The gas limit to use for the transaction. If not provided, the API will estimate a value based on the to and data fields of the transaction. - value (Optional): The amount of ETH, in wei, to send with the transaction. - data (Optional): The data to send with the transaction; only used for contract calls. - accessList (Optional): The access list to use for the transaction.

Parameters:

• address (str) – The 0x-prefixed address of the Ethereum account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• send_evm_transaction_request (SendEvmTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async sign_evm_hash(address, x_wallet_auth=None, x_idempotency_key=None, sign_evm_hash_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a hash

Signs an arbitrary 32 byte hash with the given EVM account.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_evm_hash_request (SignEvmHashRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SignEvmHash200Response

Returns:

Returns the result object.

async sign_evm_hash_with_http_info(address, x_wallet_auth=None, x_idempotency_key=None, sign_evm_hash_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a hash

Signs an arbitrary 32 byte hash with the given EVM account.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_evm_hash_request (SignEvmHashRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SignEvmHash200Response]

Returns:

Returns the result object.

async sign_evm_hash_without_preload_content(address, x_wallet_auth=None, x_idempotency_key=None, sign_evm_hash_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a hash

Signs an arbitrary 32 byte hash with the given EVM account.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_evm_hash_request (SignEvmHashRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async sign_evm_message(address, x_wallet_auth=None, x_idempotency_key=None, sign_evm_message_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign an EIP-191 message

Signs an [EIP-191](https://eips.ethereum.org/EIPS/eip-191) message with the given EVM account. Per the specification, the message in the request body is prepended with 0x19 <0x45 (E)> <thereum Signed Message:n” + len(message)> before being signed.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_evm_message_request (SignEvmMessageRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SignEvmMessage200Response

Returns:

Returns the result object.

async sign_evm_message_with_http_info(address, x_wallet_auth=None, x_idempotency_key=None, sign_evm_message_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign an EIP-191 message

Signs an [EIP-191](https://eips.ethereum.org/EIPS/eip-191) message with the given EVM account. Per the specification, the message in the request body is prepended with 0x19 <0x45 (E)> <thereum Signed Message:n” + len(message)> before being signed.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_evm_message_request (SignEvmMessageRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SignEvmMessage200Response]

Returns:

Returns the result object.

async sign_evm_message_without_preload_content(address, x_wallet_auth=None, x_idempotency_key=None, sign_evm_message_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign an EIP-191 message

Signs an [EIP-191](https://eips.ethereum.org/EIPS/eip-191) message with the given EVM account. Per the specification, the message in the request body is prepended with 0x19 <0x45 (E)> <thereum Signed Message:n” + len(message)> before being signed.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_evm_message_request (SignEvmMessageRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async sign_evm_transaction(address, x_wallet_auth=None, x_idempotency_key=None, sign_evm_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a transaction

Signs a transaction with the given EVM account. The transaction should be serialized as a hex string using [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/). The transaction must be an [EIP-1559 dynamic fee transaction](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_evm_transaction_request (SignEvmTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SignEvmTransaction200Response

Returns:

Returns the result object.

async sign_evm_transaction_with_http_info(address, x_wallet_auth=None, x_idempotency_key=None, sign_evm_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a transaction

Signs a transaction with the given EVM account. The transaction should be serialized as a hex string using [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/). The transaction must be an [EIP-1559 dynamic fee transaction](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_evm_transaction_request (SignEvmTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SignEvmTransaction200Response]

Returns:

Returns the result object.

async sign_evm_transaction_without_preload_content(address, x_wallet_auth=None, x_idempotency_key=None, sign_evm_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a transaction

Signs a transaction with the given EVM account. The transaction should be serialized as a hex string using [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/). The transaction must be an [EIP-1559 dynamic fee transaction](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_evm_transaction_request (SignEvmTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async sign_evm_typed_data(address, x_wallet_auth=None, x_idempotency_key=None, eip712_message=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign EIP-712 typed data

Signs [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data with the given EVM account.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• eip712_message (EIP712Message)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SignEvmTypedData200Response

Returns:

Returns the result object.

async sign_evm_typed_data_with_http_info(address, x_wallet_auth=None, x_idempotency_key=None, eip712_message=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign EIP-712 typed data

Signs [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data with the given EVM account.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• eip712_message (EIP712Message)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SignEvmTypedData200Response]

Returns:

Returns the result object.

async sign_evm_typed_data_without_preload_content(address, x_wallet_auth=None, x_idempotency_key=None, eip712_message=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign EIP-712 typed data

Signs [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data with the given EVM account.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• eip712_message (EIP712Message)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async update_evm_account(address, x_idempotency_key=None, update_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update an EVM account

Updates an existing EVM account. Use this to update the account’s name or account-level policy.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. The address does not need to be checksummed. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• update_evm_account_request (UpdateEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmAccount

Returns:

Returns the result object.

async update_evm_account_with_http_info(address, x_idempotency_key=None, update_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update an EVM account

Updates an existing EVM account. Use this to update the account’s name or account-level policy.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. The address does not need to be checksummed. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• update_evm_account_request (UpdateEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmAccount]

Returns:

Returns the result object.

async update_evm_account_without_preload_content(address, x_idempotency_key=None, update_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update an EVM account

Updates an existing EVM account. Use this to update the account’s name or account-level policy.

Parameters:

• address (str) – The 0x-prefixed address of the EVM account. The address does not need to be checksummed. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• update_evm_account_request (UpdateEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.evm_smart_accounts_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.evm_smart_accounts_api.EVMSmartAccountsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async create_evm_smart_account(x_idempotency_key=None, create_evm_smart_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a Smart Account

Creates a new Smart Account.

Parameters:

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_evm_smart_account_request (CreateEvmSmartAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmSmartAccount

Returns:

Returns the result object.

async create_evm_smart_account_with_http_info(x_idempotency_key=None, create_evm_smart_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a Smart Account

Creates a new Smart Account.

Parameters:

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_evm_smart_account_request (CreateEvmSmartAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmSmartAccount]

Returns:

Returns the result object.

async create_evm_smart_account_without_preload_content(x_idempotency_key=None, create_evm_smart_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a Smart Account

Creates a new Smart Account.

Parameters:

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_evm_smart_account_request (CreateEvmSmartAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async create_spend_permission(address, create_spend_permission_request, x_wallet_auth=None, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a spend permission

Creates a spend permission for the given smart account address.

Parameters:

• address (str) – The address of the Smart Account to create the spend permission for. (required)

• create_spend_permission_request (CreateSpendPermissionRequest) – (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmUserOperation

Returns:

Returns the result object.

async create_spend_permission_with_http_info(address, create_spend_permission_request, x_wallet_auth=None, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a spend permission

Creates a spend permission for the given smart account address.

Parameters:

• address (str) – The address of the Smart Account to create the spend permission for. (required)

• create_spend_permission_request (CreateSpendPermissionRequest) – (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmUserOperation]

Returns:

Returns the result object.

async create_spend_permission_without_preload_content(address, create_spend_permission_request, x_wallet_auth=None, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a spend permission

Creates a spend permission for the given smart account address.

Parameters:

• address (str) – The address of the Smart Account to create the spend permission for. (required)

• create_spend_permission_request (CreateSpendPermissionRequest) – (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_evm_smart_account(address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Smart Account by address

Gets a Smart Account by its address.

Parameters:

• address (str) – The 0x-prefixed address of the Smart Account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmSmartAccount

Returns:

Returns the result object.

async get_evm_smart_account_by_name(name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Smart Account by name

Gets a Smart Account by its name.

Parameters:

• name (str) – The name of the Smart Account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmSmartAccount

Returns:

Returns the result object.

async get_evm_smart_account_by_name_with_http_info(name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Smart Account by name

Gets a Smart Account by its name.

Parameters:

• name (str) – The name of the Smart Account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmSmartAccount]

Returns:

Returns the result object.

async get_evm_smart_account_by_name_without_preload_content(name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Smart Account by name

Gets a Smart Account by its name.

Parameters:

• name (str) – The name of the Smart Account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_evm_smart_account_with_http_info(address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Smart Account by address

Gets a Smart Account by its address.

Parameters:

• address (str) – The 0x-prefixed address of the Smart Account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmSmartAccount]

Returns:

Returns the result object.

async get_evm_smart_account_without_preload_content(address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Smart Account by address

Gets a Smart Account by its address.

Parameters:

• address (str) – The 0x-prefixed address of the Smart Account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_user_operation(address, user_op_hash, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a user operation

Gets a user operation by its hash.

Parameters:

• address (str) – The address of the Smart Account the user operation belongs to. (required)

• user_op_hash (str) – The hash of the user operation to fetch. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmUserOperation

Returns:

Returns the result object.

async get_user_operation_with_http_info(address, user_op_hash, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a user operation

Gets a user operation by its hash.

Parameters:

• address (str) – The address of the Smart Account the user operation belongs to. (required)

• user_op_hash (str) – The hash of the user operation to fetch. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmUserOperation]

Returns:

Returns the result object.

async get_user_operation_without_preload_content(address, user_op_hash, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a user operation

Gets a user operation by its hash.

Parameters:

• address (str) – The address of the Smart Account the user operation belongs to. (required)

• user_op_hash (str) – The hash of the user operation to fetch. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async list_evm_smart_accounts(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Smart Accounts

Lists the Smart Accounts belonging to the developer’s CDP Project. The response is paginated, and by default, returns 20 accounts per page.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListEvmSmartAccounts200Response

Returns:

Returns the result object.

async list_evm_smart_accounts_with_http_info(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Smart Accounts

Lists the Smart Accounts belonging to the developer’s CDP Project. The response is paginated, and by default, returns 20 accounts per page.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ListEvmSmartAccounts200Response]

Returns:

Returns the result object.

async list_evm_smart_accounts_without_preload_content(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Smart Accounts

Lists the Smart Accounts belonging to the developer’s CDP Project. The response is paginated, and by default, returns 20 accounts per page.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async list_spend_permissions(address, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List spend permissions

Lists spend permission for the given smart account address.

Parameters:

• address (str) – The address of the Smart account to list spend permissions for. (required)

• page_size (int) – The number of spend permissions to return per page.

• page_token (str) – The token for the next page of spend permissions. Will be empty if there are no more spend permissions to fetch.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListSpendPermissions200Response

Returns:

Returns the result object.

async list_spend_permissions_with_http_info(address, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List spend permissions

Lists spend permission for the given smart account address.

Parameters:

• address (str) – The address of the Smart account to list spend permissions for. (required)

• page_size (int) – The number of spend permissions to return per page.

• page_token (str) – The token for the next page of spend permissions. Will be empty if there are no more spend permissions to fetch.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ListSpendPermissions200Response]

Returns:

Returns the result object.

async list_spend_permissions_without_preload_content(address, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List spend permissions

Lists spend permission for the given smart account address.

Parameters:

• address (str) – The address of the Smart account to list spend permissions for. (required)

• page_size (int) – The number of spend permissions to return per page.

• page_token (str) – The token for the next page of spend permissions. Will be empty if there are no more spend permissions to fetch.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async prepare_and_send_user_operation(address, x_idempotency_key=None, x_wallet_auth=None, prepare_and_send_user_operation_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Prepare and send a user operation for EVM Smart Account

Prepares, signs, and sends a user operation for an EVM Smart Account. This API can be used only if the owner on Smart Account is a CDP EVM Account.

Parameters:

• address (str) – The address of the EVM Smart Account to execute the user operation from. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• prepare_and_send_user_operation_request (PrepareAndSendUserOperationRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmUserOperation

Returns:

Returns the result object.

async prepare_and_send_user_operation_with_http_info(address, x_idempotency_key=None, x_wallet_auth=None, prepare_and_send_user_operation_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Prepare and send a user operation for EVM Smart Account

Prepares, signs, and sends a user operation for an EVM Smart Account. This API can be used only if the owner on Smart Account is a CDP EVM Account.

Parameters:

• address (str) – The address of the EVM Smart Account to execute the user operation from. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• prepare_and_send_user_operation_request (PrepareAndSendUserOperationRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmUserOperation]

Returns:

Returns the result object.

async prepare_and_send_user_operation_without_preload_content(address, x_idempotency_key=None, x_wallet_auth=None, prepare_and_send_user_operation_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Prepare and send a user operation for EVM Smart Account

Prepares, signs, and sends a user operation for an EVM Smart Account. This API can be used only if the owner on Smart Account is a CDP EVM Account.

Parameters:

• address (str) – The address of the EVM Smart Account to execute the user operation from. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• prepare_and_send_user_operation_request (PrepareAndSendUserOperationRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async prepare_user_operation(address, prepare_user_operation_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Prepare a user operation

Prepares a new user operation on a Smart Account for a specific network.

Parameters:

• address (str) – The address of the Smart Account to create the user operation on. (required)

• prepare_user_operation_request (PrepareUserOperationRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmUserOperation

Returns:

Returns the result object.

async prepare_user_operation_with_http_info(address, prepare_user_operation_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Prepare a user operation

Prepares a new user operation on a Smart Account for a specific network.

Parameters:

• address (str) – The address of the Smart Account to create the user operation on. (required)

• prepare_user_operation_request (PrepareUserOperationRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmUserOperation]

Returns:

Returns the result object.

async prepare_user_operation_without_preload_content(address, prepare_user_operation_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Prepare a user operation

Prepares a new user operation on a Smart Account for a specific network.

Parameters:

• address (str) – The address of the Smart Account to create the user operation on. (required)

• prepare_user_operation_request (PrepareUserOperationRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async revoke_spend_permission(address, revoke_spend_permission_request, x_wallet_auth=None, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Revoke a spend permission

Revokes an existing spend permission.

Parameters:

• address (str) – The address of the Smart account this spend permission is valid for. (required)

• revoke_spend_permission_request (RevokeSpendPermissionRequest) – (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmUserOperation

Returns:

Returns the result object.

async revoke_spend_permission_with_http_info(address, revoke_spend_permission_request, x_wallet_auth=None, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Revoke a spend permission

Revokes an existing spend permission.

Parameters:

• address (str) – The address of the Smart account this spend permission is valid for. (required)

• revoke_spend_permission_request (RevokeSpendPermissionRequest) – (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmUserOperation]

Returns:

Returns the result object.

async revoke_spend_permission_without_preload_content(address, revoke_spend_permission_request, x_wallet_auth=None, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Revoke a spend permission

Revokes an existing spend permission.

Parameters:

• address (str) – The address of the Smart account this spend permission is valid for. (required)

• revoke_spend_permission_request (RevokeSpendPermissionRequest) – (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async send_user_operation(address, user_op_hash, send_user_operation_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Send a user operation

Sends a user operation with a signature. The payload to sign must be the userOpHash field of the user operation. This hash should be signed directly (not using personal_sign or EIP-191 message hashing). The signature must be 65 bytes in length, consisting of: - 32 bytes for the r value - 32 bytes for the s value - 1 byte for the v value (must be 27 or 28) If using the CDP Paymaster, the user operation must be signed and sent within 2 minutes of being prepared.

Parameters:

• address (str) – The address of the Smart Account to send the user operation from. (required)

• user_op_hash (str) – The hash of the user operation to send. (required)

• send_user_operation_request (SendUserOperationRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmUserOperation

Returns:

Returns the result object.

async send_user_operation_with_http_info(address, user_op_hash, send_user_operation_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Send a user operation

Sends a user operation with a signature. The payload to sign must be the userOpHash field of the user operation. This hash should be signed directly (not using personal_sign or EIP-191 message hashing). The signature must be 65 bytes in length, consisting of: - 32 bytes for the r value - 32 bytes for the s value - 1 byte for the v value (must be 27 or 28) If using the CDP Paymaster, the user operation must be signed and sent within 2 minutes of being prepared.

Parameters:

• address (str) – The address of the Smart Account to send the user operation from. (required)

• user_op_hash (str) – The hash of the user operation to send. (required)

• send_user_operation_request (SendUserOperationRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmUserOperation]

Returns:

Returns the result object.

async send_user_operation_without_preload_content(address, user_op_hash, send_user_operation_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Send a user operation

Sends a user operation with a signature. The payload to sign must be the userOpHash field of the user operation. This hash should be signed directly (not using personal_sign or EIP-191 message hashing). The signature must be 65 bytes in length, consisting of: - 32 bytes for the r value - 32 bytes for the s value - 1 byte for the v value (must be 27 or 28) If using the CDP Paymaster, the user operation must be signed and sent within 2 minutes of being prepared.

Parameters:

• address (str) – The address of the Smart Account to send the user operation from. (required)

• user_op_hash (str) – The hash of the user operation to send. (required)

• send_user_operation_request (SendUserOperationRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async update_evm_smart_account(address, update_evm_smart_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update an EVM Smart Account

Updates an existing EVM smart account. Use this to update the smart account’s name.

Parameters:

• address (str) – The 0x-prefixed address of the EVM smart account. The address does not need to be checksummed. (required)

• update_evm_smart_account_request (UpdateEvmSmartAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

EvmSmartAccount

Returns:

Returns the result object.

async update_evm_smart_account_with_http_info(address, update_evm_smart_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update an EVM Smart Account

Updates an existing EVM smart account. Use this to update the smart account’s name.

Parameters:

• address (str) – The 0x-prefixed address of the EVM smart account. The address does not need to be checksummed. (required)

• update_evm_smart_account_request (UpdateEvmSmartAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[EvmSmartAccount]

Returns:

Returns the result object.

async update_evm_smart_account_without_preload_content(address, update_evm_smart_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update an EVM Smart Account

Updates an existing EVM smart account. Use this to update the smart account’s name.

Parameters:

• address (str) – The 0x-prefixed address of the EVM smart account. The address does not need to be checksummed. (required)

• update_evm_smart_account_request (UpdateEvmSmartAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.evm_swaps_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.evm_swaps_api.EVMSwapsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async create_evm_swap_quote(create_evm_swap_quote_request, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a swap quote

Create a swap quote, which includes the payload to sign as well as the transaction data needed to execute the swap. The developer is responsible for signing the payload and submitting the transaction to the network in order to execute the swap.

Parameters:

• create_evm_swap_quote_request (CreateEvmSwapQuoteRequest) – (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

CreateSwapQuoteResponseWrapper

Returns:

Returns the result object.

async create_evm_swap_quote_with_http_info(create_evm_swap_quote_request, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a swap quote

Create a swap quote, which includes the payload to sign as well as the transaction data needed to execute the swap. The developer is responsible for signing the payload and submitting the transaction to the network in order to execute the swap.

Parameters:

• create_evm_swap_quote_request (CreateEvmSwapQuoteRequest) – (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[CreateSwapQuoteResponseWrapper]

Returns:

Returns the result object.

async create_evm_swap_quote_without_preload_content(create_evm_swap_quote_request, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a swap quote

Create a swap quote, which includes the payload to sign as well as the transaction data needed to execute the swap. The developer is responsible for signing the payload and submitting the transaction to the network in order to execute the swap.

Parameters:

• create_evm_swap_quote_request (CreateEvmSwapQuoteRequest) – (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_evm_swap_price(network, to_token, from_token, from_amount, taker, signer_address=None, gas_price=None, slippage_bps=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a price estimate for a swap

Get a price estimate for a swap between two tokens on an EVM network.

Parameters:

• network (EvmSwapsNetwork) – (required)

• to_token (str) – (required)

• from_token (str) – (required)

• from_amount (str) – (required)

• taker (str) – (required)

• signer_address (str)

• gas_price (str)

• slippage_bps (int)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

GetSwapPriceResponseWrapper

Returns:

Returns the result object.

async get_evm_swap_price_with_http_info(network, to_token, from_token, from_amount, taker, signer_address=None, gas_price=None, slippage_bps=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a price estimate for a swap

Get a price estimate for a swap between two tokens on an EVM network.

Parameters:

• network (EvmSwapsNetwork) – (required)

• to_token (str) – (required)

• from_token (str) – (required)

• from_amount (str) – (required)

• taker (str) – (required)

• signer_address (str)

• gas_price (str)

• slippage_bps (int)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[GetSwapPriceResponseWrapper]

Returns:

Returns the result object.

async get_evm_swap_price_without_preload_content(network, to_token, from_token, from_amount, taker, signer_address=None, gas_price=None, slippage_bps=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a price estimate for a swap

Get a price estimate for a swap between two tokens on an EVM network.

Parameters:

• network (EvmSwapsNetwork) – (required)

• to_token (str) – (required)

• from_token (str) – (required)

• from_amount (str) – (required)

• taker (str) – (required)

• signer_address (str)

• gas_price (str)

• slippage_bps (int)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.evm_token_balances_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.evm_token_balances_api.EVMTokenBalancesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async list_evm_token_balances(address, network, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List EVM token balances

Lists the token balances of an EVM address on a given network. The balances include ERC-20 tokens and the native gas token (usually ETH). The response is paginated, and by default, returns 20 balances per page. Note: This endpoint is still under development and does not yet provide strong freshness guarantees. Specifically, balances of new tokens can, on occasion, take up to ~30 seconds to appear, while balances of tokens already belonging to an address will generally be close to chain tip. Freshness of new token balances will improve over the coming weeks.

Parameters:

• address (str) – The 0x-prefixed EVM address to get balances for. The address does not need to be checksummed. (required)

• network (ListEvmTokenBalancesNetwork) – The human-readable network name to get the balances for. (required)

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListEvmTokenBalances200Response

Returns:

Returns the result object.

async list_evm_token_balances_with_http_info(address, network, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List EVM token balances

Lists the token balances of an EVM address on a given network. The balances include ERC-20 tokens and the native gas token (usually ETH). The response is paginated, and by default, returns 20 balances per page. Note: This endpoint is still under development and does not yet provide strong freshness guarantees. Specifically, balances of new tokens can, on occasion, take up to ~30 seconds to appear, while balances of tokens already belonging to an address will generally be close to chain tip. Freshness of new token balances will improve over the coming weeks.

Parameters:

• address (str) – The 0x-prefixed EVM address to get balances for. The address does not need to be checksummed. (required)

• network (ListEvmTokenBalancesNetwork) – The human-readable network name to get the balances for. (required)

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ListEvmTokenBalances200Response]

Returns:

Returns the result object.

async list_evm_token_balances_without_preload_content(address, network, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List EVM token balances

Lists the token balances of an EVM address on a given network. The balances include ERC-20 tokens and the native gas token (usually ETH). The response is paginated, and by default, returns 20 balances per page. Note: This endpoint is still under development and does not yet provide strong freshness guarantees. Specifically, balances of new tokens can, on occasion, take up to ~30 seconds to appear, while balances of tokens already belonging to an address will generally be close to chain tip. Freshness of new token balances will improve over the coming weeks.

Parameters:

• address (str) – The 0x-prefixed EVM address to get balances for. The address does not need to be checksummed. (required)

• network (ListEvmTokenBalancesNetwork) – The human-readable network name to get the balances for. (required)

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.faucets_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.faucets_api.FaucetsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async request_evm_faucet(request_evm_faucet_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Request funds on EVM test networks

Request funds from the CDP Faucet on supported EVM test networks. Faucets are available for ETH, USDC, EURC, and cbBTC on Base Sepolia and Ethereum Sepolia, and for ETH only on Ethereum Hoodi. To prevent abuse, we enforce rate limits within a rolling 24-hour window to control the amount of funds that can be requested. These limits are applied at both the CDP User level and the blockchain address level. A single blockchain address cannot exceed the specified limits, even if multiple users submit requests to the same address. | Token | Amount per Faucet Request |Rolling 24-hour window Rate Limits| |:-----:|:————————-:|:--------------------------------:| | ETH | 0.0001 ETH | 0.1 ETH | | USDC | 1 USDC | 10 USDC | | EURC | 1 EURC | 10 EURC | | cbBTC | 0.0001 cbBTC | 0.001 cbBTC |

Parameters:

• request_evm_faucet_request (RequestEvmFaucetRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

RequestEvmFaucet200Response

Returns:

Returns the result object.

async request_evm_faucet_with_http_info(request_evm_faucet_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Request funds on EVM test networks

Request funds from the CDP Faucet on supported EVM test networks. Faucets are available for ETH, USDC, EURC, and cbBTC on Base Sepolia and Ethereum Sepolia, and for ETH only on Ethereum Hoodi. To prevent abuse, we enforce rate limits within a rolling 24-hour window to control the amount of funds that can be requested. These limits are applied at both the CDP User level and the blockchain address level. A single blockchain address cannot exceed the specified limits, even if multiple users submit requests to the same address. | Token | Amount per Faucet Request |Rolling 24-hour window Rate Limits| |:-----:|:————————-:|:--------------------------------:| | ETH | 0.0001 ETH | 0.1 ETH | | USDC | 1 USDC | 10 USDC | | EURC | 1 EURC | 10 EURC | | cbBTC | 0.0001 cbBTC | 0.001 cbBTC |

Parameters:

• request_evm_faucet_request (RequestEvmFaucetRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[RequestEvmFaucet200Response]

Returns:

Returns the result object.

async request_evm_faucet_without_preload_content(request_evm_faucet_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Request funds on EVM test networks

Request funds from the CDP Faucet on supported EVM test networks. Faucets are available for ETH, USDC, EURC, and cbBTC on Base Sepolia and Ethereum Sepolia, and for ETH only on Ethereum Hoodi. To prevent abuse, we enforce rate limits within a rolling 24-hour window to control the amount of funds that can be requested. These limits are applied at both the CDP User level and the blockchain address level. A single blockchain address cannot exceed the specified limits, even if multiple users submit requests to the same address. | Token | Amount per Faucet Request |Rolling 24-hour window Rate Limits| |:-----:|:————————-:|:--------------------------------:| | ETH | 0.0001 ETH | 0.1 ETH | | USDC | 1 USDC | 10 USDC | | EURC | 1 EURC | 10 EURC | | cbBTC | 0.0001 cbBTC | 0.001 cbBTC |

Parameters:

• request_evm_faucet_request (RequestEvmFaucetRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async request_solana_faucet(request_solana_faucet_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Request funds on Solana devnet

Request funds from the CDP Faucet on Solana devnet. Faucets are available for SOL. To prevent abuse, we enforce rate limits within a rolling 24-hour window to control the amount of funds that can be requested. These limits are applied at both the CDP Project level and the blockchain address level. A single blockchain address cannot exceed the specified limits, even if multiple users submit requests to the same address. | Token | Amount per Faucet Request |Rolling 24-hour window Rate Limits| |:-----:|:————————-:|:--------------------------------:| | SOL | 0.00125 SOL | 0.0125 SOL | | USDC | 1 USDC | 10 USDC |

Parameters:

• request_solana_faucet_request (RequestSolanaFaucetRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

RequestSolanaFaucet200Response

Returns:

Returns the result object.

async request_solana_faucet_with_http_info(request_solana_faucet_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Request funds on Solana devnet

Request funds from the CDP Faucet on Solana devnet. Faucets are available for SOL. To prevent abuse, we enforce rate limits within a rolling 24-hour window to control the amount of funds that can be requested. These limits are applied at both the CDP Project level and the blockchain address level. A single blockchain address cannot exceed the specified limits, even if multiple users submit requests to the same address. | Token | Amount per Faucet Request |Rolling 24-hour window Rate Limits| |:-----:|:————————-:|:--------------------------------:| | SOL | 0.00125 SOL | 0.0125 SOL | | USDC | 1 USDC | 10 USDC |

Parameters:

• request_solana_faucet_request (RequestSolanaFaucetRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[RequestSolanaFaucet200Response]

Returns:

Returns the result object.

async request_solana_faucet_without_preload_content(request_solana_faucet_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Request funds on Solana devnet

Request funds from the CDP Faucet on Solana devnet. Faucets are available for SOL. To prevent abuse, we enforce rate limits within a rolling 24-hour window to control the amount of funds that can be requested. These limits are applied at both the CDP Project level and the blockchain address level. A single blockchain address cannot exceed the specified limits, even if multiple users submit requests to the same address. | Token | Amount per Faucet Request |Rolling 24-hour window Rate Limits| |:-----:|:————————-:|:--------------------------------:| | SOL | 0.00125 SOL | 0.0125 SOL | | USDC | 1 USDC | 10 USDC |

Parameters:

• request_solana_faucet_request (RequestSolanaFaucetRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.onchain_data_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.onchain_data_api.OnchainDataApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async list_data_token_balances(address, network, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List EVM token balances

Lists the token balances of an EVM address on a given network. The balances include ERC-20 tokens and the native gas token (usually ETH). The response is paginated, and by default, returns 20 balances per page. Note: This endpoint provides <1 second freshness from chain tip, <500ms response latency for wallets with reasonable token history, and 99.9% uptime for production use.

Parameters:

• address (str) – The 0x-prefixed EVM address to get balances for. The address does not need to be checksummed. (required)

• network (ListEvmTokenBalancesNetwork) – The human-readable network name to get the balances for. (required)

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListEvmTokenBalances200Response

Returns:

Returns the result object.

async list_data_token_balances_with_http_info(address, network, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List EVM token balances

Lists the token balances of an EVM address on a given network. The balances include ERC-20 tokens and the native gas token (usually ETH). The response is paginated, and by default, returns 20 balances per page. Note: This endpoint provides <1 second freshness from chain tip, <500ms response latency for wallets with reasonable token history, and 99.9% uptime for production use.

Parameters:

• address (str) – The 0x-prefixed EVM address to get balances for. The address does not need to be checksummed. (required)

• network (ListEvmTokenBalancesNetwork) – The human-readable network name to get the balances for. (required)

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ListEvmTokenBalances200Response]

Returns:

Returns the result object.

async list_data_token_balances_without_preload_content(address, network, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List EVM token balances

Lists the token balances of an EVM address on a given network. The balances include ERC-20 tokens and the native gas token (usually ETH). The response is paginated, and by default, returns 20 balances per page. Note: This endpoint provides <1 second freshness from chain tip, <500ms response latency for wallets with reasonable token history, and 99.9% uptime for production use.

Parameters:

• address (str) – The 0x-prefixed EVM address to get balances for. The address does not need to be checksummed. (required)

• network (ListEvmTokenBalancesNetwork) – The human-readable network name to get the balances for. (required)

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async list_tokens_for_account(network, address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List token addresses for account

Retrieve all ERC-20 token contract addresses that an account has ever received tokens from. Analyzes transaction history to discover token interactions.

Parameters:

• network (str) – The blockchain network to query. (required)

• address (str) – The account address to analyze for token interactions. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

AccountTokenAddressesResponse

Returns:

Returns the result object.

async list_tokens_for_account_with_http_info(network, address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List token addresses for account

Retrieve all ERC-20 token contract addresses that an account has ever received tokens from. Analyzes transaction history to discover token interactions.

Parameters:

• network (str) – The blockchain network to query. (required)

• address (str) – The account address to analyze for token interactions. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[AccountTokenAddressesResponse]

Returns:

Returns the result object.

async list_tokens_for_account_without_preload_content(network, address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List token addresses for account

Retrieve all ERC-20 token contract addresses that an account has ever received tokens from. Analyzes transaction history to discover token interactions.

Parameters:

• network (str) – The blockchain network to query. (required)

• address (str) – The account address to analyze for token interactions. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.onramp_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.onramp_api.OnrampApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async create_onramp_order(create_onramp_order_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an onramp order

Create a new Onramp order or get a quote for an Onramp order. Either paymentAmount or purchaseAmount must be provided. This API currently only supports the payment method GUEST_CHECKOUT_APPLE_PAY. For detailed integration instructions and to get access to this API, refer to the [Apple Pay Onramp API docs](https://docs.cdp.coinbase.com/onramp-&-offramp/onramp-apis/apple-pay-onramp-api).

Parameters:

• create_onramp_order_request (CreateOnrampOrderRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

CreateOnrampOrder201Response

Returns:

Returns the result object.

async create_onramp_order_with_http_info(create_onramp_order_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an onramp order

Create a new Onramp order or get a quote for an Onramp order. Either paymentAmount or purchaseAmount must be provided. This API currently only supports the payment method GUEST_CHECKOUT_APPLE_PAY. For detailed integration instructions and to get access to this API, refer to the [Apple Pay Onramp API docs](https://docs.cdp.coinbase.com/onramp-&-offramp/onramp-apis/apple-pay-onramp-api).

Parameters:

• create_onramp_order_request (CreateOnrampOrderRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[CreateOnrampOrder201Response]

Returns:

Returns the result object.

async create_onramp_order_without_preload_content(create_onramp_order_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an onramp order

Create a new Onramp order or get a quote for an Onramp order. Either paymentAmount or purchaseAmount must be provided. This API currently only supports the payment method GUEST_CHECKOUT_APPLE_PAY. For detailed integration instructions and to get access to this API, refer to the [Apple Pay Onramp API docs](https://docs.cdp.coinbase.com/onramp-&-offramp/onramp-apis/apple-pay-onramp-api).

Parameters:

• create_onramp_order_request (CreateOnrampOrderRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async create_onramp_session(create_onramp_session_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an onramp session

Returns a single-use URL for an Onramp session. This API provides flexible functionality based on the parameters provided, supporting three cases: Important: The returned URL is single-use only. Once a user visits the URL, no one else can access it. ## Use Cases ### 1. Basic Session (Minimum Parameters) Required: destinationAddress, purchaseCurrency, destinationNetwork Returns: Basic single-use onramp URL. The quote object will not be included in the response. ### 2. One-Click Onramp URL Required: Basic parameters + paymentAmount, paymentCurrency Returns: One-click onramp URL for streamlined checkout. The quote object will not be included in the response. ### 3. One-Click Onramp URL with Quote Required: One-Click Onramp parameters + paymentMethod, country, subdivision Returns: Complete pricing quote and one-click onramp URL. Both session and quote objects will be included in the response.

Parameters:

• create_onramp_session_request (CreateOnrampSessionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

CreateOnrampSession201Response

Returns:

Returns the result object.

async create_onramp_session_with_http_info(create_onramp_session_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an onramp session

Returns a single-use URL for an Onramp session. This API provides flexible functionality based on the parameters provided, supporting three cases: Important: The returned URL is single-use only. Once a user visits the URL, no one else can access it. ## Use Cases ### 1. Basic Session (Minimum Parameters) Required: destinationAddress, purchaseCurrency, destinationNetwork Returns: Basic single-use onramp URL. The quote object will not be included in the response. ### 2. One-Click Onramp URL Required: Basic parameters + paymentAmount, paymentCurrency Returns: One-click onramp URL for streamlined checkout. The quote object will not be included in the response. ### 3. One-Click Onramp URL with Quote Required: One-Click Onramp parameters + paymentMethod, country, subdivision Returns: Complete pricing quote and one-click onramp URL. Both session and quote objects will be included in the response.

Parameters:

• create_onramp_session_request (CreateOnrampSessionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[CreateOnrampSession201Response]

Returns:

Returns the result object.

async create_onramp_session_without_preload_content(create_onramp_session_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create an onramp session

Returns a single-use URL for an Onramp session. This API provides flexible functionality based on the parameters provided, supporting three cases: Important: The returned URL is single-use only. Once a user visits the URL, no one else can access it. ## Use Cases ### 1. Basic Session (Minimum Parameters) Required: destinationAddress, purchaseCurrency, destinationNetwork Returns: Basic single-use onramp URL. The quote object will not be included in the response. ### 2. One-Click Onramp URL Required: Basic parameters + paymentAmount, paymentCurrency Returns: One-click onramp URL for streamlined checkout. The quote object will not be included in the response. ### 3. One-Click Onramp URL with Quote Required: One-Click Onramp parameters + paymentMethod, country, subdivision Returns: Complete pricing quote and one-click onramp URL. Both session and quote objects will be included in the response.

Parameters:

• create_onramp_session_request (CreateOnrampSessionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_onramp_order_by_id(order_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an onramp order by ID

Get an onramp order by ID.

Parameters:

• order_id (str) – The ID of the onramp order to retrieve. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

GetOnrampOrderById200Response

Returns:

Returns the result object.

async get_onramp_order_by_id_with_http_info(order_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an onramp order by ID

Get an onramp order by ID.

Parameters:

• order_id (str) – The ID of the onramp order to retrieve. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[GetOnrampOrderById200Response]

Returns:

Returns the result object.

async get_onramp_order_by_id_without_preload_content(order_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get an onramp order by ID

Get an onramp order by ID.

Parameters:

• order_id (str) – The ID of the onramp order to retrieve. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.policy_engine_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.policy_engine_api.PolicyEngineApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async create_policy(create_policy_request, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a policy

Create a policy that can be used to govern the behavior of accounts.

Parameters:

• create_policy_request (CreatePolicyRequest) – (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

Policy

Returns:

Returns the result object.

async create_policy_with_http_info(create_policy_request, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a policy

Create a policy that can be used to govern the behavior of accounts.

Parameters:

• create_policy_request (CreatePolicyRequest) – (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[Policy]

Returns:

Returns the result object.

async create_policy_without_preload_content(create_policy_request, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a policy

Create a policy that can be used to govern the behavior of accounts.

Parameters:

• create_policy_request (CreatePolicyRequest) – (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async delete_policy(policy_id, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete a policy

Delete a policy by its ID. This will have the effect of removing the policy from all accounts that are currently using it.

Parameters:

• policy_id (str) – The ID of the policy to delete. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

None

Returns:

Returns the result object.

async delete_policy_with_http_info(policy_id, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete a policy

Delete a policy by its ID. This will have the effect of removing the policy from all accounts that are currently using it.

Parameters:

• policy_id (str) – The ID of the policy to delete. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[NoneType]

Returns:

Returns the result object.

async delete_policy_without_preload_content(policy_id, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete a policy

Delete a policy by its ID. This will have the effect of removing the policy from all accounts that are currently using it.

Parameters:

• policy_id (str) – The ID of the policy to delete. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_policy_by_id(policy_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a policy by ID

Get a policy by its ID.

Parameters:

• policy_id (str) – The ID of the policy to get. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

Policy

Returns:

Returns the result object.

async get_policy_by_id_with_http_info(policy_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a policy by ID

Get a policy by its ID.

Parameters:

• policy_id (str) – The ID of the policy to get. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[Policy]

Returns:

Returns the result object.

async get_policy_by_id_without_preload_content(policy_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a policy by ID

Get a policy by its ID.

Parameters:

• policy_id (str) – The ID of the policy to get. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async list_policies(page_size=None, page_token=None, scope=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List policies

Lists the policies belonging to the developer’s CDP Project. Use the scope parameter to filter the policies by scope. The response is paginated, and by default, returns 20 policies per page.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• scope (str) – The scope of the policies to return. If project, the response will include exactly one policy, which is the project-level policy. If account, the response will include all account-level policies for the developer’s CDP Project.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListPolicies200Response

Returns:

Returns the result object.

async list_policies_with_http_info(page_size=None, page_token=None, scope=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List policies

Lists the policies belonging to the developer’s CDP Project. Use the scope parameter to filter the policies by scope. The response is paginated, and by default, returns 20 policies per page.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• scope (str) – The scope of the policies to return. If project, the response will include exactly one policy, which is the project-level policy. If account, the response will include all account-level policies for the developer’s CDP Project.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ListPolicies200Response]

Returns:

Returns the result object.

async list_policies_without_preload_content(page_size=None, page_token=None, scope=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List policies

Lists the policies belonging to the developer’s CDP Project. Use the scope parameter to filter the policies by scope. The response is paginated, and by default, returns 20 policies per page.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• scope (str) – The scope of the policies to return. If project, the response will include exactly one policy, which is the project-level policy. If account, the response will include all account-level policies for the developer’s CDP Project.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async update_policy(policy_id, update_policy_request, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update a policy

Updates a policy by its ID. This will have the effect of applying the updated policy to all accounts that are currently using it.

Parameters:

• policy_id (str) – The ID of the policy to update. (required)

• update_policy_request (UpdatePolicyRequest) – (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

Policy

Returns:

Returns the result object.

async update_policy_with_http_info(policy_id, update_policy_request, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update a policy

Updates a policy by its ID. This will have the effect of applying the updated policy to all accounts that are currently using it.

Parameters:

• policy_id (str) – The ID of the policy to update. (required)

• update_policy_request (UpdatePolicyRequest) – (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[Policy]

Returns:

Returns the result object.

async update_policy_without_preload_content(policy_id, update_policy_request, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update a policy

Updates a policy by its ID. This will have the effect of applying the updated policy to all accounts that are currently using it.

Parameters:

• policy_id (str) – The ID of the policy to update. (required)

• update_policy_request (UpdatePolicyRequest) – (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.solana_accounts_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.solana_accounts_api.SolanaAccountsApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async create_solana_account(x_wallet_auth=None, x_idempotency_key=None, create_solana_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a Solana account

Creates a new Solana account.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_solana_account_request (CreateSolanaAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SolanaAccount

Returns:

Returns the result object.

async create_solana_account_with_http_info(x_wallet_auth=None, x_idempotency_key=None, create_solana_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a Solana account

Creates a new Solana account.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_solana_account_request (CreateSolanaAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SolanaAccount]

Returns:

Returns the result object.

async create_solana_account_without_preload_content(x_wallet_auth=None, x_idempotency_key=None, create_solana_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create a Solana account

Creates a new Solana account.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• create_solana_account_request (CreateSolanaAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async export_solana_account(address, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export an Solana account

Export an existing Solana account’s private key. It is important to store the private key in a secure place after it’s exported.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ExportSolanaAccount200Response

Returns:

Returns the result object.

async export_solana_account_by_name(name, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export a Solana account by name

Export an existing Solana account’s private key by its name. It is important to store the private key in a secure place after it’s exported.

Parameters:

• name (str) – The name of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ExportSolanaAccount200Response

Returns:

Returns the result object.

async export_solana_account_by_name_with_http_info(name, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export a Solana account by name

Export an existing Solana account’s private key by its name. It is important to store the private key in a secure place after it’s exported.

Parameters:

• name (str) – The name of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ExportSolanaAccount200Response]

Returns:

Returns the result object.

async export_solana_account_by_name_without_preload_content(name, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export a Solana account by name

Export an existing Solana account’s private key by its name. It is important to store the private key in a secure place after it’s exported.

Parameters:

• name (str) – The name of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async export_solana_account_with_http_info(address, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export an Solana account

Export an existing Solana account’s private key. It is important to store the private key in a secure place after it’s exported.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ExportSolanaAccount200Response]

Returns:

Returns the result object.

async export_solana_account_without_preload_content(address, x_wallet_auth=None, x_idempotency_key=None, export_evm_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Export an Solana account

Export an existing Solana account’s private key. It is important to store the private key in a secure place after it’s exported.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• export_evm_account_request (ExportEvmAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_solana_account(address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Solana account by address

Gets a Solana account by its address.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SolanaAccount

Returns:

Returns the result object.

async get_solana_account_by_name(name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Solana account by name

Gets a Solana account by its name.

Parameters:

• name (str) – The name of the Solana account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SolanaAccount

Returns:

Returns the result object.

async get_solana_account_by_name_with_http_info(name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Solana account by name

Gets a Solana account by its name.

Parameters:

• name (str) – The name of the Solana account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SolanaAccount]

Returns:

Returns the result object.

async get_solana_account_by_name_without_preload_content(name, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Solana account by name

Gets a Solana account by its name.

Parameters:

• name (str) – The name of the Solana account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_solana_account_with_http_info(address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Solana account by address

Gets a Solana account by its address.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SolanaAccount]

Returns:

Returns the result object.

async get_solana_account_without_preload_content(address, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get a Solana account by address

Gets a Solana account by its address.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async import_solana_account(x_wallet_auth=None, x_idempotency_key=None, import_solana_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Import a Solana account

Import an existing Solana account into the developer’s CDP Project. This API should be called from the [CDP SDK](https://github.com/coinbase/cdp-sdk) to ensure that the associated private key is properly encrypted.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• import_solana_account_request (ImportSolanaAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SolanaAccount

Returns:

Returns the result object.

async import_solana_account_with_http_info(x_wallet_auth=None, x_idempotency_key=None, import_solana_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Import a Solana account

Import an existing Solana account into the developer’s CDP Project. This API should be called from the [CDP SDK](https://github.com/coinbase/cdp-sdk) to ensure that the associated private key is properly encrypted.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• import_solana_account_request (ImportSolanaAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SolanaAccount]

Returns:

Returns the result object.

async import_solana_account_without_preload_content(x_wallet_auth=None, x_idempotency_key=None, import_solana_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Import a Solana account

Import an existing Solana account into the developer’s CDP Project. This API should be called from the [CDP SDK](https://github.com/coinbase/cdp-sdk) to ensure that the associated private key is properly encrypted.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• import_solana_account_request (ImportSolanaAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async list_solana_accounts(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Solana accounts or get account by name

Lists the Solana accounts belonging to the developer. The response is paginated, and by default, returns 20 accounts per page. If a name is provided, the response will contain only the account with that name.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListSolanaAccounts200Response

Returns:

Returns the result object.

async list_solana_accounts_with_http_info(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Solana accounts or get account by name

Lists the Solana accounts belonging to the developer. The response is paginated, and by default, returns 20 accounts per page. If a name is provided, the response will contain only the account with that name.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ListSolanaAccounts200Response]

Returns:

Returns the result object.

async list_solana_accounts_without_preload_content(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Solana accounts or get account by name

Lists the Solana accounts belonging to the developer. The response is paginated, and by default, returns 20 accounts per page. If a name is provided, the response will contain only the account with that name.

Parameters:

• page_size (int) – The number of resources to return per page.

• page_token (str) – The token for the next page of resources, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async send_solana_transaction(x_wallet_auth=None, x_idempotency_key=None, send_solana_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Send a Solana transaction

Signs and sends a single Solana transaction using multiple Solana accounts. The transaction may contain contain several instructions, each of which may require signatures from different account keys. The transaction should be serialized into a byte array and base64 encoded. The API handles recent blockhash management and fee estimation, leaving the developer to provide only the minimal set of fields necessary to send the transaction. Transaction types The following transaction types are supported: * [Legacy transactions](https://solana.com/developers/guides/advanced/versions#current-transaction-versions) * [Versioned transactions](https://solana.com/developers/guides/advanced/versions) Instruction Batching To batch multiple operations, include multiple instructions within a single transaction. All instructions within a transaction are executed atomically - if any instruction fails, the entire transaction fails and is rolled back. Network Support The following Solana networks are supported: * solana - Solana Mainnet * solana-devnet - Solana Devnet The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• send_solana_transaction_request (SendSolanaTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SendSolanaTransaction200Response

Returns:

Returns the result object.

async send_solana_transaction_with_http_info(x_wallet_auth=None, x_idempotency_key=None, send_solana_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Send a Solana transaction

Signs and sends a single Solana transaction using multiple Solana accounts. The transaction may contain contain several instructions, each of which may require signatures from different account keys. The transaction should be serialized into a byte array and base64 encoded. The API handles recent blockhash management and fee estimation, leaving the developer to provide only the minimal set of fields necessary to send the transaction. Transaction types The following transaction types are supported: * [Legacy transactions](https://solana.com/developers/guides/advanced/versions#current-transaction-versions) * [Versioned transactions](https://solana.com/developers/guides/advanced/versions) Instruction Batching To batch multiple operations, include multiple instructions within a single transaction. All instructions within a transaction are executed atomically - if any instruction fails, the entire transaction fails and is rolled back. Network Support The following Solana networks are supported: * solana - Solana Mainnet * solana-devnet - Solana Devnet The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• send_solana_transaction_request (SendSolanaTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SendSolanaTransaction200Response]

Returns:

Returns the result object.

async send_solana_transaction_without_preload_content(x_wallet_auth=None, x_idempotency_key=None, send_solana_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Send a Solana transaction

Signs and sends a single Solana transaction using multiple Solana accounts. The transaction may contain contain several instructions, each of which may require signatures from different account keys. The transaction should be serialized into a byte array and base64 encoded. The API handles recent blockhash management and fee estimation, leaving the developer to provide only the minimal set of fields necessary to send the transaction. Transaction types The following transaction types are supported: * [Legacy transactions](https://solana.com/developers/guides/advanced/versions#current-transaction-versions) * [Versioned transactions](https://solana.com/developers/guides/advanced/versions) Instruction Batching To batch multiple operations, include multiple instructions within a single transaction. All instructions within a transaction are executed atomically - if any instruction fails, the entire transaction fails and is rolled back. Network Support The following Solana networks are supported: * solana - Solana Mainnet * solana-devnet - Solana Devnet The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.

Parameters:

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• send_solana_transaction_request (SendSolanaTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async sign_solana_message(address, x_wallet_auth=None, x_idempotency_key=None, sign_solana_message_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a message

Signs an arbitrary message with the given Solana account. WARNING: Never sign a message that you didn’t generate, as it can be an arbitrary transaction. For example, it might send all of your funds to an attacker.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_solana_message_request (SignSolanaMessageRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SignSolanaMessage200Response

Returns:

Returns the result object.

async sign_solana_message_with_http_info(address, x_wallet_auth=None, x_idempotency_key=None, sign_solana_message_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a message

Signs an arbitrary message with the given Solana account. WARNING: Never sign a message that you didn’t generate, as it can be an arbitrary transaction. For example, it might send all of your funds to an attacker.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_solana_message_request (SignSolanaMessageRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SignSolanaMessage200Response]

Returns:

Returns the result object.

async sign_solana_message_without_preload_content(address, x_wallet_auth=None, x_idempotency_key=None, sign_solana_message_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a message

Signs an arbitrary message with the given Solana account. WARNING: Never sign a message that you didn’t generate, as it can be an arbitrary transaction. For example, it might send all of your funds to an attacker.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_solana_message_request (SignSolanaMessageRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async sign_solana_transaction(address, x_wallet_auth=None, x_idempotency_key=None, sign_solana_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a transaction

Signs a transaction with the given Solana account. The unsigned transaction should be serialized into a byte array and then encoded as base64. Transaction types The following transaction types are supported: * [Legacy transactions](https://solana-labs.github.io/solana-web3.js/classes/Transaction.html) * [Versioned transactions](https://solana-labs.github.io/solana-web3.js/classes/VersionedTransaction.html) The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_solana_transaction_request (SignSolanaTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SignSolanaTransaction200Response

Returns:

Returns the result object.

async sign_solana_transaction_with_http_info(address, x_wallet_auth=None, x_idempotency_key=None, sign_solana_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a transaction

Signs a transaction with the given Solana account. The unsigned transaction should be serialized into a byte array and then encoded as base64. Transaction types The following transaction types are supported: * [Legacy transactions](https://solana-labs.github.io/solana-web3.js/classes/Transaction.html) * [Versioned transactions](https://solana-labs.github.io/solana-web3.js/classes/VersionedTransaction.html) The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_solana_transaction_request (SignSolanaTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SignSolanaTransaction200Response]

Returns:

Returns the result object.

async sign_solana_transaction_without_preload_content(address, x_wallet_auth=None, x_idempotency_key=None, sign_solana_transaction_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Sign a transaction

Signs a transaction with the given Solana account. The unsigned transaction should be serialized into a byte array and then encoded as base64. Transaction types The following transaction types are supported: * [Legacy transactions](https://solana-labs.github.io/solana-web3.js/classes/Transaction.html) * [Versioned transactions](https://solana-labs.github.io/solana-web3.js/classes/VersionedTransaction.html) The developer is responsible for ensuring that the unsigned transaction is valid, as the API will not validate the transaction.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_wallet_auth (str) – A JWT signed using your Wallet Secret, encoded in base64. Refer to the [Generate Wallet Token](https://docs.cdp.coinbase.com/api-reference/v2/authentication#2-generate-wallet-token) section of our Authentication docs for more details on how to generate your Wallet Token.

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• sign_solana_transaction_request (SignSolanaTransactionRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async update_solana_account(address, x_idempotency_key=None, update_solana_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update a Solana account

Updates an existing Solana account. Use this to update the account’s name or account-level policy.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• update_solana_account_request (UpdateSolanaAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

SolanaAccount

Returns:

Returns the result object.

async update_solana_account_with_http_info(address, x_idempotency_key=None, update_solana_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update a Solana account

Updates an existing Solana account. Use this to update the account’s name or account-level policy.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• update_solana_account_request (UpdateSolanaAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[SolanaAccount]

Returns:

Returns the result object.

async update_solana_account_without_preload_content(address, x_idempotency_key=None, update_solana_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update a Solana account

Updates an existing Solana account. Use this to update the account’s name or account-level policy.

Parameters:

• address (str) – The base58 encoded address of the Solana account. (required)

• x_idempotency_key (str) – An optional [UUID v4](https://www.uuidgenerator.net/version4) 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.

• update_solana_account_request (UpdateSolanaAccountRequest)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.solana_token_balances_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.solana_token_balances_api.SolanaTokenBalancesApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async list_solana_token_balances(address, network, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Solana token balances

Lists the token balances of a Solana address on a given network. The balances include SPL tokens and the native SOL token. The response is paginated, and by default, returns 20 balances per page. Note: This endpoint is still under development and does not yet provide strong availability or freshness guarantees. Freshness and availability of new token balances will improve over the coming weeks.

Parameters:

• address (str) – The base58 encoded Solana address to get balances for. (required)

• network (ListSolanaTokenBalancesNetwork) – The human-readable network name to get the balances for. (required)

• page_size (int) – The number of balances to return per page.

• page_token (str) – The token for the next page of balances. Will be empty if there are no more balances to fetch.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ListSolanaTokenBalances200Response

Returns:

Returns the result object.

async list_solana_token_balances_with_http_info(address, network, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Solana token balances

Lists the token balances of a Solana address on a given network. The balances include SPL tokens and the native SOL token. The response is paginated, and by default, returns 20 balances per page. Note: This endpoint is still under development and does not yet provide strong availability or freshness guarantees. Freshness and availability of new token balances will improve over the coming weeks.

Parameters:

• address (str) – The base58 encoded Solana address to get balances for. (required)

• network (ListSolanaTokenBalancesNetwork) – The human-readable network name to get the balances for. (required)

• page_size (int) – The number of balances to return per page.

• page_token (str) – The token for the next page of balances. Will be empty if there are no more balances to fetch.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[ListSolanaTokenBalances200Response]

Returns:

Returns the result object.

async list_solana_token_balances_without_preload_content(address, network, page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Solana token balances

Lists the token balances of a Solana address on a given network. The balances include SPL tokens and the native SOL token. The response is paginated, and by default, returns 20 balances per page. Note: This endpoint is still under development and does not yet provide strong availability or freshness guarantees. Freshness and availability of new token balances will improve over the coming weeks.

Parameters:

• address (str) – The base58 encoded Solana address to get balances for. (required)

• network (ListSolanaTokenBalancesNetwork) – The human-readable network name to get the balances for. (required)

• page_size (int) – The number of balances to return per page.

• page_token (str) – The token for the next page of balances. Will be empty if there are no more balances to fetch.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.sqlapi_alpha_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.sqlapi_alpha_api.SQLAPIAlphaApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async get_sql_grammar(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get SQL grammar

Retrieve the SQL grammar for the SQL API. The SQL queries that are supported by the SQL API are defined via an ANTLR4 grammar which is evaluated by server before executing the query. This ensures the safety and soundness of the SQL API. This endpoint returns the ANTLR4 grammar that is used to evaluate the SQL queries so that developers can understand the SQL API and build SQL queries with high confidence and correctness. LLMs interact well with ANTLR4 grammar as well.

Parameters:

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

str

Returns:

Returns the result object.

async get_sql_grammar_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get SQL grammar

Retrieve the SQL grammar for the SQL API. The SQL queries that are supported by the SQL API are defined via an ANTLR4 grammar which is evaluated by server before executing the query. This ensures the safety and soundness of the SQL API. This endpoint returns the ANTLR4 grammar that is used to evaluate the SQL queries so that developers can understand the SQL API and build SQL queries with high confidence and correctness. LLMs interact well with ANTLR4 grammar as well.

Parameters:

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[str]

Returns:

Returns the result object.

async get_sql_grammar_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get SQL grammar

Retrieve the SQL grammar for the SQL API. The SQL queries that are supported by the SQL API are defined via an ANTLR4 grammar which is evaluated by server before executing the query. This ensures the safety and soundness of the SQL API. This endpoint returns the ANTLR4 grammar that is used to evaluate the SQL queries so that developers can understand the SQL API and build SQL queries with high confidence and correctness. LLMs interact well with ANTLR4 grammar as well.

Parameters:

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async run_sql_query(onchain_data_query, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Run SQL Query

Run a read-only SQL query against indexed blockchain data including transactions, events, and decoded logs. This endpoint provides direct SQL access to comprehensive blockchain data across supported networks. Queries are executed against optimized data structures for high-performance analytics. ### Allowed Queries - Standard SQL syntax (ClickHouse dialect) - Read-only queries (SELECT statements) - No DDL or DML operations - No cartesian products ### Supported Tables - base.events - Base mainnet decoded event logs with parameters, event signature, topics, and more. - base.transactions - Base mainnet transaction data including hash, block number, gas usage. - base.blocks - Base mainnet block information. - base.encoded_logs - Encoded log data of event logs that aren’t able to be decoded by our event decoder (ex: log0 opcode). - base.transfers - All event logs with event signature Transfer(address,address,uint256). ERC-20, ERC-721, and ERC-1155 transfers are all included. ### Query Limits - Maximum result set: 100,000 rows - Query timeout: 30 seconds

Parameters:

• onchain_data_query (OnchainDataQuery) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

OnchainDataResult

Returns:

Returns the result object.

async run_sql_query_with_http_info(onchain_data_query, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Run SQL Query

Run a read-only SQL query against indexed blockchain data including transactions, events, and decoded logs. This endpoint provides direct SQL access to comprehensive blockchain data across supported networks. Queries are executed against optimized data structures for high-performance analytics. ### Allowed Queries - Standard SQL syntax (ClickHouse dialect) - Read-only queries (SELECT statements) - No DDL or DML operations - No cartesian products ### Supported Tables - base.events - Base mainnet decoded event logs with parameters, event signature, topics, and more. - base.transactions - Base mainnet transaction data including hash, block number, gas usage. - base.blocks - Base mainnet block information. - base.encoded_logs - Encoded log data of event logs that aren’t able to be decoded by our event decoder (ex: log0 opcode). - base.transfers - All event logs with event signature Transfer(address,address,uint256). ERC-20, ERC-721, and ERC-1155 transfers are all included. ### Query Limits - Maximum result set: 100,000 rows - Query timeout: 30 seconds

Parameters:

• onchain_data_query (OnchainDataQuery) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[OnchainDataResult]

Returns:

Returns the result object.

async run_sql_query_without_preload_content(onchain_data_query, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Run SQL Query

Run a read-only SQL query against indexed blockchain data including transactions, events, and decoded logs. This endpoint provides direct SQL access to comprehensive blockchain data across supported networks. Queries are executed against optimized data structures for high-performance analytics. ### Allowed Queries - Standard SQL syntax (ClickHouse dialect) - Read-only queries (SELECT statements) - No DDL or DML operations - No cartesian products ### Supported Tables - base.events - Base mainnet decoded event logs with parameters, event signature, topics, and more. - base.transactions - Base mainnet transaction data including hash, block number, gas usage. - base.blocks - Base mainnet block information. - base.encoded_logs - Encoded log data of event logs that aren’t able to be decoded by our event decoder (ex: log0 opcode). - base.transfers - All event logs with event signature Transfer(address,address,uint256). ERC-20, ERC-721, and ERC-1155 transfers are all included. ### Query Limits - Maximum result set: 100,000 rows - Query timeout: 30 seconds

Parameters:

• onchain_data_query (OnchainDataQuery) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.webhooks_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.webhooks_api.WebhooksApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async create_webhook_subscription(webhook_subscription_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create webhook subscription

Subscribe to real-time events across CDP products using flexible filtering. ### Event Types Onchain Events - Monitor Base mainnet with microsecond precision: - onchain.activity.detected - Smart contract events, transfers, swaps, NFT activity - Requires labels for filtering (e.g., contract_address, event_name) Onramp/Offramp Events - Transaction lifecycle notifications: - onramp.transaction.created, onramp.transaction.updated - onramp.transaction.success, onramp.transaction.failed - offramp.transaction.created, offramp.transaction.updated - offramp.transaction.success, offramp.transaction.failed - No labels required - maximum simplicity for transaction monitoring Wallet Events - Wallet activity notifications: - wallet.activity.detected ### Webhook Signature Verification All webhooks include cryptographic signatures for security. The signature secret is returned in metadata.secret when creating a subscription. Note: Webhooks are in beta and this interface is subject to change. See the [verification guide](https://docs.cdp.coinbase.com/onramp-&-offramp/webhooks#webhook-signature-verification) for implementation details. ### Onchain Label Filtering For onchain.activity.detected events, use labels for precise filtering with AND logic (max 20 labels per webhook). Allowed labels (all in snake_case format): - network (required) - Blockchain network - contract_address - Smart contract address - event_name - Event name (e.g., “Transfer”, “Burn”) - event_signature - Event signature hash - transaction_from - Transaction sender address - transaction_to - Transaction recipient address - params.* - Any event parameter (e.g., params.from, params.to, params.sender, params.tokenId) Examples: - Liquidity Pool Monitor: {“network”: “base-mainnet”, “contract_address”: “0xcd1f9777571493aeacb7eae45cd30a226d3e612d”, “event_name”: “Burn”} - Price Oracle Tracker: {“network”: “base-mainnet”, “contract_address”: “0xbac4a9428ea707c51f171ed9890c3c2fa810305d”, “event_name”: “PriceUpdated”} - DeFi Protocol Activity: {“network”: “base-mainnet”, “contract_address”: “0x45c6e6a47a711b14d8357d5243f46704904578e3”, “event_name”: “Deposit”}

Parameters:

• webhook_subscription_request (WebhookSubscriptionRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

WebhookSubscriptionResponse

Returns:

Returns the result object.

async create_webhook_subscription_with_http_info(webhook_subscription_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create webhook subscription

Subscribe to real-time events across CDP products using flexible filtering. ### Event Types Onchain Events - Monitor Base mainnet with microsecond precision: - onchain.activity.detected - Smart contract events, transfers, swaps, NFT activity - Requires labels for filtering (e.g., contract_address, event_name) Onramp/Offramp Events - Transaction lifecycle notifications: - onramp.transaction.created, onramp.transaction.updated - onramp.transaction.success, onramp.transaction.failed - offramp.transaction.created, offramp.transaction.updated - offramp.transaction.success, offramp.transaction.failed - No labels required - maximum simplicity for transaction monitoring Wallet Events - Wallet activity notifications: - wallet.activity.detected ### Webhook Signature Verification All webhooks include cryptographic signatures for security. The signature secret is returned in metadata.secret when creating a subscription. Note: Webhooks are in beta and this interface is subject to change. See the [verification guide](https://docs.cdp.coinbase.com/onramp-&-offramp/webhooks#webhook-signature-verification) for implementation details. ### Onchain Label Filtering For onchain.activity.detected events, use labels for precise filtering with AND logic (max 20 labels per webhook). Allowed labels (all in snake_case format): - network (required) - Blockchain network - contract_address - Smart contract address - event_name - Event name (e.g., “Transfer”, “Burn”) - event_signature - Event signature hash - transaction_from - Transaction sender address - transaction_to - Transaction recipient address - params.* - Any event parameter (e.g., params.from, params.to, params.sender, params.tokenId) Examples: - Liquidity Pool Monitor: {“network”: “base-mainnet”, “contract_address”: “0xcd1f9777571493aeacb7eae45cd30a226d3e612d”, “event_name”: “Burn”} - Price Oracle Tracker: {“network”: “base-mainnet”, “contract_address”: “0xbac4a9428ea707c51f171ed9890c3c2fa810305d”, “event_name”: “PriceUpdated”} - DeFi Protocol Activity: {“network”: “base-mainnet”, “contract_address”: “0x45c6e6a47a711b14d8357d5243f46704904578e3”, “event_name”: “Deposit”}

Parameters:

• webhook_subscription_request (WebhookSubscriptionRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[WebhookSubscriptionResponse]

Returns:

Returns the result object.

async create_webhook_subscription_without_preload_content(webhook_subscription_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Create webhook subscription

Subscribe to real-time events across CDP products using flexible filtering. ### Event Types Onchain Events - Monitor Base mainnet with microsecond precision: - onchain.activity.detected - Smart contract events, transfers, swaps, NFT activity - Requires labels for filtering (e.g., contract_address, event_name) Onramp/Offramp Events - Transaction lifecycle notifications: - onramp.transaction.created, onramp.transaction.updated - onramp.transaction.success, onramp.transaction.failed - offramp.transaction.created, offramp.transaction.updated - offramp.transaction.success, offramp.transaction.failed - No labels required - maximum simplicity for transaction monitoring Wallet Events - Wallet activity notifications: - wallet.activity.detected ### Webhook Signature Verification All webhooks include cryptographic signatures for security. The signature secret is returned in metadata.secret when creating a subscription. Note: Webhooks are in beta and this interface is subject to change. See the [verification guide](https://docs.cdp.coinbase.com/onramp-&-offramp/webhooks#webhook-signature-verification) for implementation details. ### Onchain Label Filtering For onchain.activity.detected events, use labels for precise filtering with AND logic (max 20 labels per webhook). Allowed labels (all in snake_case format): - network (required) - Blockchain network - contract_address - Smart contract address - event_name - Event name (e.g., “Transfer”, “Burn”) - event_signature - Event signature hash - transaction_from - Transaction sender address - transaction_to - Transaction recipient address - params.* - Any event parameter (e.g., params.from, params.to, params.sender, params.tokenId) Examples: - Liquidity Pool Monitor: {“network”: “base-mainnet”, “contract_address”: “0xcd1f9777571493aeacb7eae45cd30a226d3e612d”, “event_name”: “Burn”} - Price Oracle Tracker: {“network”: “base-mainnet”, “contract_address”: “0xbac4a9428ea707c51f171ed9890c3c2fa810305d”, “event_name”: “PriceUpdated”} - DeFi Protocol Activity: {“network”: “base-mainnet”, “contract_address”: “0x45c6e6a47a711b14d8357d5243f46704904578e3”, “event_name”: “Deposit”}

Parameters:

• webhook_subscription_request (WebhookSubscriptionRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async delete_webhook_subscription(subscription_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete webhook subscription

Permanently delete a webhook subscription and stop all event deliveries. This action cannot be undone. ### Important Notes - All webhook deliveries will cease immediately - Subscription cannot be recovered after deletion - Consider disabling instead of deleting for temporary pauses

Parameters:

• subscription_id (str) – Unique identifier for the webhook subscription. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

None

Returns:

Returns the result object.

async delete_webhook_subscription_with_http_info(subscription_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete webhook subscription

Permanently delete a webhook subscription and stop all event deliveries. This action cannot be undone. ### Important Notes - All webhook deliveries will cease immediately - Subscription cannot be recovered after deletion - Consider disabling instead of deleting for temporary pauses

Parameters:

• subscription_id (str) – Unique identifier for the webhook subscription. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[NoneType]

Returns:

Returns the result object.

async delete_webhook_subscription_without_preload_content(subscription_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete webhook subscription

Permanently delete a webhook subscription and stop all event deliveries. This action cannot be undone. ### Important Notes - All webhook deliveries will cease immediately - Subscription cannot be recovered after deletion - Consider disabling instead of deleting for temporary pauses

Parameters:

• subscription_id (str) – Unique identifier for the webhook subscription. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async get_webhook_subscription(subscription_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get webhook subscription details

Retrieve detailed information about a specific webhook subscription including configuration, status, creation timestamp, and webhook signature secret. ### Response Includes - Subscription configuration and filters - Target URL and custom headers - Webhook signature secret for verification - Creation timestamp and status

Parameters:

• subscription_id (str) – Unique identifier for the webhook subscription. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

WebhookSubscriptionResponse

Returns:

Returns the result object.

async get_webhook_subscription_with_http_info(subscription_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get webhook subscription details

Retrieve detailed information about a specific webhook subscription including configuration, status, creation timestamp, and webhook signature secret. ### Response Includes - Subscription configuration and filters - Target URL and custom headers - Webhook signature secret for verification - Creation timestamp and status

Parameters:

• subscription_id (str) – Unique identifier for the webhook subscription. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[WebhookSubscriptionResponse]

Returns:

Returns the result object.

async get_webhook_subscription_without_preload_content(subscription_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get webhook subscription details

Retrieve detailed information about a specific webhook subscription including configuration, status, creation timestamp, and webhook signature secret. ### Response Includes - Subscription configuration and filters - Target URL and custom headers - Webhook signature secret for verification - Creation timestamp and status

Parameters:

• subscription_id (str) – Unique identifier for the webhook subscription. (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async list_webhook_subscriptions(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List webhook subscriptions

Retrieve a paginated list of webhook subscriptions for the authenticated project. Returns subscriptions for all CDP product events (onchain, onramp/offramp, wallet, etc.) in descending order by creation time. ### Use Cases - Monitor all active webhook subscriptions across CDP products - Audit webhook configurations - Manage subscription lifecycle

Parameters:

• page_size (int) – The number of subscriptions to return per page.

• page_token (str) – The token for the next page of subscriptions, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

WebhookSubscriptionListResponse

Returns:

Returns the result object.

async list_webhook_subscriptions_with_http_info(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List webhook subscriptions

Retrieve a paginated list of webhook subscriptions for the authenticated project. Returns subscriptions for all CDP product events (onchain, onramp/offramp, wallet, etc.) in descending order by creation time. ### Use Cases - Monitor all active webhook subscriptions across CDP products - Audit webhook configurations - Manage subscription lifecycle

Parameters:

• page_size (int) – The number of subscriptions to return per page.

• page_token (str) – The token for the next page of subscriptions, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[WebhookSubscriptionListResponse]

Returns:

Returns the result object.

async list_webhook_subscriptions_without_preload_content(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List webhook subscriptions

Retrieve a paginated list of webhook subscriptions for the authenticated project. Returns subscriptions for all CDP product events (onchain, onramp/offramp, wallet, etc.) in descending order by creation time. ### Use Cases - Monitor all active webhook subscriptions across CDP products - Audit webhook configurations - Manage subscription lifecycle

Parameters:

• page_size (int) – The number of subscriptions to return per page.

• page_token (str) – The token for the next page of subscriptions, if any.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async update_webhook_subscription(subscription_id, webhook_subscription_update_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update webhook subscription

Update an existing webhook subscription’s configuration including event types, target URL, filtering criteria, and enabled status. All required fields must be provided, even if they are not being changed. ### Common Updates - Change target URL or headers - Add/remove event type filters - Update multi-label filtering criteria - Enable/disable subscription

Parameters:

• subscription_id (str) – Unique identifier for the webhook subscription. (required)

• webhook_subscription_update_request (WebhookSubscriptionUpdateRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

WebhookSubscriptionResponse

Returns:

Returns the result object.

async update_webhook_subscription_with_http_info(subscription_id, webhook_subscription_update_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update webhook subscription

Update an existing webhook subscription’s configuration including event types, target URL, filtering criteria, and enabled status. All required fields must be provided, even if they are not being changed. ### Common Updates - Change target URL or headers - Add/remove event type filters - Update multi-label filtering criteria - Enable/disable subscription

Parameters:

• subscription_id (str) – Unique identifier for the webhook subscription. (required)

• webhook_subscription_update_request (WebhookSubscriptionUpdateRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[WebhookSubscriptionResponse]

Returns:

Returns the result object.

async update_webhook_subscription_without_preload_content(subscription_id, webhook_subscription_update_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update webhook subscription

Update an existing webhook subscription’s configuration including event types, target URL, filtering criteria, and enabled status. All required fields must be provided, even if they are not being changed. ### Common Updates - Change target URL or headers - Add/remove event type filters - Update multi-label filtering criteria - Enable/disable subscription

Parameters:

• subscription_id (str) – Unique identifier for the webhook subscription. (required)

• webhook_subscription_update_request (WebhookSubscriptionUpdateRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

cdp.openapi_client.api.x402_facilitator_api module

Coinbase Developer Platform APIs

The Coinbase Developer Platform APIs - leading the world’s transition onchain.

The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.openapi_client.api.x402_facilitator_api.X402FacilitatorApi(api_client=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

async settle_x402_payment(verify_x402_payment_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Settle a payment

Settle an x402 protocol payment with a specific scheme and network.

Parameters:

• verify_x402_payment_request (VerifyX402PaymentRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

InlineObject1

Returns:

Returns the result object.

async settle_x402_payment_with_http_info(verify_x402_payment_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Settle a payment

Settle an x402 protocol payment with a specific scheme and network.

Parameters:

• verify_x402_payment_request (VerifyX402PaymentRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[InlineObject1]

Returns:

Returns the result object.

async settle_x402_payment_without_preload_content(verify_x402_payment_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Settle a payment

Settle an x402 protocol payment with a specific scheme and network.

Parameters:

• verify_x402_payment_request (VerifyX402PaymentRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async supported_x402_payment_kinds(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get supported payment schemes and networks

Get the supported x402 protocol payment schemes and networks that the facilitator is able to verify and settle payments for.

Parameters:

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

InlineObject2

Returns:

Returns the result object.

async supported_x402_payment_kinds_with_http_info(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get supported payment schemes and networks

Get the supported x402 protocol payment schemes and networks that the facilitator is able to verify and settle payments for.

Parameters:

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[InlineObject2]

Returns:

Returns the result object.

async supported_x402_payment_kinds_without_preload_content(_request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get supported payment schemes and networks

Get the supported x402 protocol payment schemes and networks that the facilitator is able to verify and settle payments for.

Parameters:

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

async verify_x402_payment(verify_x402_payment_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Verify a payment

Verify an x402 protocol payment with a specific scheme and network.

Parameters:

• verify_x402_payment_request (VerifyX402PaymentRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

InlineObject

Returns:

Returns the result object.

async verify_x402_payment_with_http_info(verify_x402_payment_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Verify a payment

Verify an x402 protocol payment with a specific scheme and network.

Parameters:

• verify_x402_payment_request (VerifyX402PaymentRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ApiResponse[InlineObject]

Returns:

Returns the result object.

async verify_x402_payment_without_preload_content(verify_x402_payment_request, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Verify a payment

Verify an x402 protocol payment with a specific scheme and network.

Parameters:

• verify_x402_payment_request (VerifyX402PaymentRequest) – (required)

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ClientResponse

Returns:

Returns the result object.

Module contents