cdp.openapi_client.api package¶

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

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 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 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 import_end_user(x_wallet_auth=None, x_idempotency_key=None, import_end_user_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Import end user private key

Imports an existing private key for an end user into the developer’s CDP Project. The private key must be encrypted using the CDP SDK’s encryption scheme before being sent to this endpoint. 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. This endpoint allows developers to import existing keys for their end users, supporting both EVM and Solana key types. The end user must have at least one authentication method configured.

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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
import_end_user_request (ImportEndUserRequest)
_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 import_end_user_with_http_info(x_wallet_auth=None, x_idempotency_key=None, import_end_user_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Import end user private key

Imports an existing private key for an end user into the developer’s CDP Project. The private key must be encrypted using the CDP SDK’s encryption scheme before being sent to this endpoint. 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. This endpoint allows developers to import existing keys for their end users, supporting both EVM and Solana key types. The end user must have at least one authentication method configured.

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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
import_end_user_request (ImportEndUserRequest)
_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 import_end_user_without_preload_content(x_wallet_auth=None, x_idempotency_key=None, import_end_user_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Import end user private key

Imports an existing private key for an end user into the developer’s CDP Project. The private key must be encrypted using the CDP SDK’s encryption scheme before being sent to this endpoint. 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. This endpoint allows developers to import existing keys for their end users, supporting both EVM and Solana key types. The end user must have at least one authentication method configured.

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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
import_end_user_request (ImportEndUserRequest)
_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:

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 lookup_end_user(email=None, oauth_provider=None, oauth_subject=None, phone_number=None, siwe_address=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Look up end users by identity

Looks up end users. Exactly one lookup type must be provided per request: - email: searches across all email-based authentication methods (email, Google, Apple, GitHub). May return multiple end users if the same email address appears across different auth methods. - oauthProvider + oauthSubject: looks up a user by their OAuth provider and subject (the sub claim from the provider’s ID token). Both params must be provided together. - phoneNumber: looks up a user by their SMS-verified phone number. - siweAddress: looks up a user by the Ethereum address they authenticated with via Sign In With Ethereum (EIP-4361). Returns all matching end users. If no end users match, an empty array is returned. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

email (str) – The email address to search for across all email-based authentication methods.
oauth_provider (OAuth2ProviderType) – The OAuth provider to search by. Must be provided together with oauthSubject.
oauth_subject (str) – The OAuth subject (the sub claim from the provider’s ID token). Must be provided together with oauthProvider.
phone_number (str) – The E.164-formatted phone number to search for. Must be URL-encoded when passed as a query parameter (e.g. +14155552671 → %2B14155552671).
siwe_address (str) – The ERC-55 checksummed Ethereum address to search for. Looks up a user by the address they authenticated with via Sign In With Ethereum (EIP-4361).
_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:

LookupEndUser200Response

Returns:

Returns the result object.

async lookup_end_user_with_http_info(email=None, oauth_provider=None, oauth_subject=None, phone_number=None, siwe_address=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Look up end users by identity

Looks up end users. Exactly one lookup type must be provided per request: - email: searches across all email-based authentication methods (email, Google, Apple, GitHub). May return multiple end users if the same email address appears across different auth methods. - oauthProvider + oauthSubject: looks up a user by their OAuth provider and subject (the sub claim from the provider’s ID token). Both params must be provided together. - phoneNumber: looks up a user by their SMS-verified phone number. - siweAddress: looks up a user by the Ethereum address they authenticated with via Sign In With Ethereum (EIP-4361). Returns all matching end users. If no end users match, an empty array is returned. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

email (str) – The email address to search for across all email-based authentication methods.
oauth_provider (OAuth2ProviderType) – The OAuth provider to search by. Must be provided together with oauthSubject.
oauth_subject (str) – The OAuth subject (the sub claim from the provider’s ID token). Must be provided together with oauthProvider.
phone_number (str) – The E.164-formatted phone number to search for. Must be URL-encoded when passed as a query parameter (e.g. +14155552671 → %2B14155552671).
siwe_address (str) – The ERC-55 checksummed Ethereum address to search for. Looks up a user by the address they authenticated with via Sign In With Ethereum (EIP-4361).
_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[LookupEndUser200Response]

Returns:

Returns the result object.

async lookup_end_user_without_preload_content(email=None, oauth_provider=None, oauth_subject=None, phone_number=None, siwe_address=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Look up end users by identity

Looks up end users. Exactly one lookup type must be provided per request: - email: searches across all email-based authentication methods (email, Google, Apple, GitHub). May return multiple end users if the same email address appears across different auth methods. - oauthProvider + oauthSubject: looks up a user by their OAuth provider and subject (the sub claim from the provider’s ID token). Both params must be provided together. - phoneNumber: looks up a user by their SMS-verified phone number. - siweAddress: looks up a user by the Ethereum address they authenticated with via Sign In With Ethereum (EIP-4361). Returns all matching end users. If no end users match, an empty array is returned. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key.

Parameters:

email (str) – The email address to search for across all email-based authentication methods.
oauth_provider (OAuth2ProviderType) – The OAuth provider to search by. Must be provided together with oauthSubject.
oauth_subject (str) – The OAuth subject (the sub claim from the provider’s ID token). Must be provided together with oauthProvider.
phone_number (str) – The E.164-formatted phone number to search for. Must be URL-encoded when passed as a query parameter (e.g. +14155552671 → %2B14155552671).
siwe_address (str) – The ERC-55 checksummed Ethereum address to search for. Looks up a user by the address they authenticated with via Sign In With Ethereum (EIP-4361).
_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:

GetDelegationForEndUser200Response

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.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_delegation_for_end_user_account(user_id, address, create_delegation_for_end_user_account_request, x_wallet_auth=None, x_idempotency_key=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Create account-scoped delegation for end user

Creates an account-scoped delegation that allows a developer to sign on behalf of an end user for a single blockchain account (identified by its address) for the specified duration. The end user must be authenticated to authorize this delegation. Multiple account-scoped delegations may exist concurrently for a single end user (one per canonical account address). Account-scoped and user-scoped delegations cannot coexist for the same user. When the address corresponds to an EVM Smart Account, the delegation is scoped to the Smart Account’s owner EOA rather than the Smart Account address itself. This means /address/{smartAccountAddress}/delegation and /address/{ownerEoaAddress}/delegation resolve to the same delegation, and the 409 account_scoped_delegation_active error may be returned when creating via either address if one already exists for the canonical owner.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The blockchain address of the end user account to scope this delegation to. Format varies by network (e.g., 0x-prefixed for EVM, base58 for Solana). For EVM addresses, matching is case-insensitive. (required)
create_delegation_for_end_user_account_request (CreateDelegationForEndUserAccountRequest) – (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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:

Returns:

Returns the result object.

async create_delegation_for_end_user_account_with_http_info(user_id, address, create_delegation_for_end_user_account_request, x_wallet_auth=None, x_idempotency_key=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Create account-scoped delegation for end user

Creates an account-scoped delegation that allows a developer to sign on behalf of an end user for a single blockchain account (identified by its address) for the specified duration. The end user must be authenticated to authorize this delegation. Multiple account-scoped delegations may exist concurrently for a single end user (one per canonical account address). Account-scoped and user-scoped delegations cannot coexist for the same user. When the address corresponds to an EVM Smart Account, the delegation is scoped to the Smart Account’s owner EOA rather than the Smart Account address itself. This means /address/{smartAccountAddress}/delegation and /address/{ownerEoaAddress}/delegation resolve to the same delegation, and the 409 account_scoped_delegation_active error may be returned when creating via either address if one already exists for the canonical owner.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The blockchain address of the end user account to scope this delegation to. Format varies by network (e.g., 0x-prefixed for EVM, base58 for Solana). For EVM addresses, matching is case-insensitive. (required)
create_delegation_for_end_user_account_request (CreateDelegationForEndUserAccountRequest) – (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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[GetDelegationForEndUser200Response]

Returns:

Returns the result object.

async create_delegation_for_end_user_account_without_preload_content(user_id, address, create_delegation_for_end_user_account_request, x_wallet_auth=None, x_idempotency_key=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Create account-scoped delegation for end user

Creates an account-scoped delegation that allows a developer to sign on behalf of an end user for a single blockchain account (identified by its address) for the specified duration. The end user must be authenticated to authorize this delegation. Multiple account-scoped delegations may exist concurrently for a single end user (one per canonical account address). Account-scoped and user-scoped delegations cannot coexist for the same user. When the address corresponds to an EVM Smart Account, the delegation is scoped to the Smart Account’s owner EOA rather than the Smart Account address itself. This means /address/{smartAccountAddress}/delegation and /address/{ownerEoaAddress}/delegation resolve to the same delegation, and the 409 account_scoped_delegation_active error may be returned when creating via either address if one already exists for the canonical owner.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The blockchain address of the end user account to scope this delegation to. Format varies by network (e.g., 0x-prefixed for EVM, base58 for Solana). For EVM addresses, matching is case-insensitive. (required)
create_delegation_for_end_user_account_request (CreateDelegationForEndUserAccountRequest) – (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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_evm_eip7702_delegation_with_end_user_account(user_id, create_evm_eip7702_delegation_with_end_user_account_request, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Create EIP-7702 delegation for end user EVM account

Creates an EIP-7702 delegation for an end user’s EVM EOA account, upgrading it with smart account capabilities. This endpoint: - Retrieves delegation artifacts from onchain - Signs the EIP-7702 authorization for delegation - Assembles and submits a Type 4 transaction - Creates an associated smart account object The delegation allows the EVM EOA to be used as a smart account, which enables batched transactions and gas sponsorship via paymaster.

Parameters:

user_id (str) – The ID of the end user. (required)
create_evm_eip7702_delegation_with_end_user_account_request (CreateEvmEip7702DelegationWithEndUserAccountRequest) – (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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:

CreateEvmEip7702DelegationWithEndUserAccount201Response

Returns:

Returns the result object.

async create_evm_eip7702_delegation_with_end_user_account_with_http_info(user_id, create_evm_eip7702_delegation_with_end_user_account_request, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Create EIP-7702 delegation for end user EVM account

Creates an EIP-7702 delegation for an end user’s EVM EOA account, upgrading it with smart account capabilities. This endpoint: - Retrieves delegation artifacts from onchain - Signs the EIP-7702 authorization for delegation - Assembles and submits a Type 4 transaction - Creates an associated smart account object The delegation allows the EVM EOA to be used as a smart account, which enables batched transactions and gas sponsorship via paymaster.

Parameters:

user_id (str) – The ID of the end user. (required)
create_evm_eip7702_delegation_with_end_user_account_request (CreateEvmEip7702DelegationWithEndUserAccountRequest) – (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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[CreateEvmEip7702DelegationWithEndUserAccount201Response]

Returns:

Returns the result object.

async create_evm_eip7702_delegation_with_end_user_account_without_preload_content(user_id, create_evm_eip7702_delegation_with_end_user_account_request, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Create EIP-7702 delegation for end user EVM account

Creates an EIP-7702 delegation for an end user’s EVM EOA account, upgrading it with smart account capabilities. This endpoint: - Retrieves delegation artifacts from onchain - Signs the EIP-7702 authorization for delegation - Assembles and submits a Type 4 transaction - Creates an associated smart account object The delegation allows the EVM EOA to be used as a smart account, which enables batched transactions and gas sponsorship via paymaster.

Parameters:

user_id (str) – The ID of the end user. (required)
create_evm_eip7702_delegation_with_end_user_account_request (CreateEvmEip7702DelegationWithEndUserAccountRequest) – (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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_delegation_for_end_user(user_id, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get delegation for end user

Returns the active delegation for the specified end user, if one exists. This operation can be performed by the end user themselves or by a developer using their API key.

Parameters:

user_id (str) – The ID of the end user. (required)
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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:

GetDelegationForEndUser200Response

Returns:

Returns the result object.

async get_delegation_for_end_user_account(user_id, address, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get account-scoped delegation for end user

Returns the active account-scoped delegation for the specified end user account, if one exists. Useful for showing delegation status in a UI. When the address corresponds to an EVM Smart Account, this returns the delegation for the Smart Account’s owner EOA.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The blockchain address of the end user account to query. For EVM addresses, matching is case-insensitive. (required)
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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:

GetDelegationForEndUser200Response

Returns:

Returns the result object.

async get_delegation_for_end_user_account_with_http_info(user_id, address, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get account-scoped delegation for end user

Returns the active account-scoped delegation for the specified end user account, if one exists. Useful for showing delegation status in a UI. When the address corresponds to an EVM Smart Account, this returns the delegation for the Smart Account’s owner EOA.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The blockchain address of the end user account to query. For EVM addresses, matching is case-insensitive. (required)
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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[GetDelegationForEndUser200Response]

Returns:

Returns the result object.

async get_delegation_for_end_user_account_without_preload_content(user_id, address, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get account-scoped delegation for end user

Returns the active account-scoped delegation for the specified end user account, if one exists. Useful for showing delegation status in a UI. When the address corresponds to an EVM Smart Account, this returns the delegation for the Smart Account’s owner EOA.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The blockchain address of the end user account to query. For EVM addresses, matching is case-insensitive. (required)
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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_delegation_for_end_user_with_http_info(user_id, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get delegation for end user

Returns the active delegation for the specified end user, if one exists. This operation can be performed by the end user themselves or by a developer using their API key.

Parameters:

user_id (str) – The ID of the end user. (required)
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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[GetDelegationForEndUser200Response]

Returns:

Returns the result object.

async get_delegation_for_end_user_without_preload_content(user_id, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get delegation for end user

Returns the active delegation for the specified end user, if one exists. This operation can be performed by the end user themselves or by a developer using their API key.

Parameters:

user_id (str) – The ID of the end user. (required)
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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_delegation_for_end_user(user_id, revoke_delegation_for_end_user_request, x_wallet_auth=None, x_developer_auth=None, x_idempotency_key=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Revoke delegation for end user

Revokes all active delegations for the specified end user. This operation can be performed by the end user themselves or by a developer using their API key.

Parameters:

user_id (str) – The ID of the end user. (required)
revoke_delegation_for_end_user_request (RevokeDelegationForEndUserRequest) – (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_developer_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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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 revoke_delegation_for_end_user_account(user_id, address, revoke_delegation_for_end_user_request, x_wallet_auth=None, x_developer_auth=None, x_idempotency_key=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Revoke account-scoped delegation for end user

Revokes the active account-scoped delegation for the specified end user account. Other account-scoped delegations for the same user are unaffected. This operation can be performed by the end user themselves or by a developer using their API key. When the address corresponds to an EVM Smart Account, this revokes the delegation for the Smart Account’s owner EOA.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The blockchain address of the end user account whose delegation should be revoked. For EVM addresses, matching is case-insensitive. (required)
revoke_delegation_for_end_user_request (RevokeDelegationForEndUserRequest) – (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_developer_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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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 revoke_delegation_for_end_user_account_with_http_info(user_id, address, revoke_delegation_for_end_user_request, x_wallet_auth=None, x_developer_auth=None, x_idempotency_key=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Revoke account-scoped delegation for end user

Revokes the active account-scoped delegation for the specified end user account. Other account-scoped delegations for the same user are unaffected. This operation can be performed by the end user themselves or by a developer using their API key. When the address corresponds to an EVM Smart Account, this revokes the delegation for the Smart Account’s owner EOA.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The blockchain address of the end user account whose delegation should be revoked. For EVM addresses, matching is case-insensitive. (required)
revoke_delegation_for_end_user_request (RevokeDelegationForEndUserRequest) – (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_developer_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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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 revoke_delegation_for_end_user_account_without_preload_content(user_id, address, revoke_delegation_for_end_user_request, x_wallet_auth=None, x_developer_auth=None, x_idempotency_key=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Revoke account-scoped delegation for end user

Revokes the active account-scoped delegation for the specified end user account. Other account-scoped delegations for the same user are unaffected. This operation can be performed by the end user themselves or by a developer using their API key. When the address corresponds to an EVM Smart Account, this revokes the delegation for the Smart Account’s owner EOA.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The blockchain address of the end user account whose delegation should be revoked. For EVM addresses, matching is case-insensitive. (required)
revoke_delegation_for_end_user_request (RevokeDelegationForEndUserRequest) – (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_developer_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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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_delegation_for_end_user_with_http_info(user_id, revoke_delegation_for_end_user_request, x_wallet_auth=None, x_developer_auth=None, x_idempotency_key=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Revoke delegation for end user

Revokes all active delegations for the specified end user. This operation can be performed by the end user themselves or by a developer using their API key.

Parameters:

user_id (str) – The ID of the end user. (required)
revoke_delegation_for_end_user_request (RevokeDelegationForEndUserRequest) – (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_developer_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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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 revoke_delegation_for_end_user_without_preload_content(user_id, revoke_delegation_for_end_user_request, x_wallet_auth=None, x_developer_auth=None, x_idempotency_key=None, project_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Revoke delegation for end user

Revokes all active delegations for the specified end user. This operation can be performed by the end user themselves or by a developer using their API key.

Parameters:

user_id (str) – The ID of the end user. (required)
revoke_delegation_for_end_user_request (RevokeDelegationForEndUserRequest) – (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_developer_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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
_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_asset_with_end_user_account(user_id, address, asset, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_evm_asset_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send USDC on EVM

Sends USDC from an end user’s EVM account (EOA or Smart Account) to a recipient address on a supported EVM network. This endpoint simplifies USDC transfers by automatically handling contract resolution, decimal conversion, gas estimation, and transaction encoding. The amount field accepts human-readable amounts as decimal strings (e.g., “1.5”, “25.50”).

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The 0x-prefixed address of the EVM account (EOA or Smart Account) to send USDC from. The address does not need to be checksummed. (required)
asset (str) – The asset to send. Currently only “usdc” is supported. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_evm_asset_with_end_user_account_request (SendEvmAssetWithEndUserAccountRequest)
_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:

SendEvmAssetWithEndUserAccount200Response

Returns:

Returns the result object.

async send_evm_asset_with_end_user_account_with_http_info(user_id, address, asset, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_evm_asset_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send USDC on EVM

Sends USDC from an end user’s EVM account (EOA or Smart Account) to a recipient address on a supported EVM network. This endpoint simplifies USDC transfers by automatically handling contract resolution, decimal conversion, gas estimation, and transaction encoding. The amount field accepts human-readable amounts as decimal strings (e.g., “1.5”, “25.50”).

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The 0x-prefixed address of the EVM account (EOA or Smart Account) to send USDC from. The address does not need to be checksummed. (required)
asset (str) – The asset to send. Currently only “usdc” is supported. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_evm_asset_with_end_user_account_request (SendEvmAssetWithEndUserAccountRequest)
_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[SendEvmAssetWithEndUserAccount200Response]

Returns:

Returns the result object.

async send_evm_asset_with_end_user_account_without_preload_content(user_id, address, asset, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_evm_asset_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send USDC on EVM

Sends USDC from an end user’s EVM account (EOA or Smart Account) to a recipient address on a supported EVM network. This endpoint simplifies USDC transfers by automatically handling contract resolution, decimal conversion, gas estimation, and transaction encoding. The amount field accepts human-readable amounts as decimal strings (e.g., “1.5”, “25.50”).

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The 0x-prefixed address of the EVM account (EOA or Smart Account) to send USDC from. The address does not need to be checksummed. (required)
asset (str) – The asset to send. Currently only “usdc” is supported. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_evm_asset_with_end_user_account_request (SendEvmAssetWithEndUserAccountRequest)
_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_with_end_user_account(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_evm_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send transaction via end user EVM account

Signs a transaction with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_evm_transaction_with_end_user_account_request (SendEvmTransactionWithEndUserAccountRequest)
_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:

SendEvmTransactionWithEndUserAccount200Response

Returns:

Returns the result object.

async send_evm_transaction_with_end_user_account_with_http_info(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_evm_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send transaction via end user EVM account

Signs a transaction with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_evm_transaction_with_end_user_account_request (SendEvmTransactionWithEndUserAccountRequest)
_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[SendEvmTransactionWithEndUserAccount200Response]

Returns:

Returns the result object.

async send_evm_transaction_with_end_user_account_without_preload_content(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_evm_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send transaction via end user EVM account

Signs a transaction with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_evm_transaction_with_end_user_account_request (SendEvmTransactionWithEndUserAccountRequest)
_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_asset_with_end_user_account(user_id, address, asset, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_solana_asset_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send USDC on Solana

Sends USDC from an end user’s Solana account to a recipient address on the Solana network. This endpoint simplifies USDC transfers by automatically handling mint resolution, Associated Token Account (ATA) creation, decimal conversion, and transaction encoding. The amount field accepts human-readable amounts as decimal strings (e.g., “1.5”, “25.50”). Use the optional createRecipientAta parameter to control whether the sender pays for creating the recipient’s Associated Token Account if it doesn’t exist.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The base58 encoded address of the Solana account to send USDC from. (required)
asset (str) – The asset to send. Currently only “usdc” is supported. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_solana_asset_with_end_user_account_request (SendSolanaAssetWithEndUserAccountRequest)
_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:

SendSolanaTransactionWithEndUserAccount200Response

Returns:

Returns the result object.

async send_solana_asset_with_end_user_account_with_http_info(user_id, address, asset, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_solana_asset_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send USDC on Solana

Sends USDC from an end user’s Solana account to a recipient address on the Solana network. This endpoint simplifies USDC transfers by automatically handling mint resolution, Associated Token Account (ATA) creation, decimal conversion, and transaction encoding. The amount field accepts human-readable amounts as decimal strings (e.g., “1.5”, “25.50”). Use the optional createRecipientAta parameter to control whether the sender pays for creating the recipient’s Associated Token Account if it doesn’t exist.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The base58 encoded address of the Solana account to send USDC from. (required)
asset (str) – The asset to send. Currently only “usdc” is supported. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_solana_asset_with_end_user_account_request (SendSolanaAssetWithEndUserAccountRequest)
_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[SendSolanaTransactionWithEndUserAccount200Response]

Returns:

Returns the result object.

async send_solana_asset_with_end_user_account_without_preload_content(user_id, address, asset, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_solana_asset_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send USDC on Solana

Sends USDC from an end user’s Solana account to a recipient address on the Solana network. This endpoint simplifies USDC transfers by automatically handling mint resolution, Associated Token Account (ATA) creation, decimal conversion, and transaction encoding. The amount field accepts human-readable amounts as decimal strings (e.g., “1.5”, “25.50”). Use the optional createRecipientAta parameter to control whether the sender pays for creating the recipient’s Associated Token Account if it doesn’t exist.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The base58 encoded address of the Solana account to send USDC from. (required)
asset (str) – The asset to send. Currently only “usdc” is supported. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_solana_asset_with_end_user_account_request (SendSolanaAssetWithEndUserAccountRequest)
_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_with_end_user_account(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_solana_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send transaction via end user Solana account

Signs a transaction with the given end user Solana account and sends it to the indicated supported network. 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. 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.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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_solana_transaction_with_end_user_account_request (SendSolanaTransactionWithEndUserAccountRequest)
_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:

SendSolanaTransactionWithEndUserAccount200Response

Returns:

Returns the result object.

async send_solana_transaction_with_end_user_account_with_http_info(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_solana_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send transaction via end user Solana account

Signs a transaction with the given end user Solana account and sends it to the indicated supported network. 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. 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.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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_solana_transaction_with_end_user_account_request (SendSolanaTransactionWithEndUserAccountRequest)
_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[SendSolanaTransactionWithEndUserAccount200Response]

Returns:

Returns the result object.

async send_solana_transaction_with_end_user_account_without_preload_content(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, send_solana_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send transaction via end user Solana account

Signs a transaction with the given end user Solana account and sends it to the indicated supported network. 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. 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.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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_solana_transaction_with_end_user_account_request (SendSolanaTransactionWithEndUserAccountRequest)
_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_with_end_user_account(user_id, address, x_idempotency_key=None, x_wallet_auth=None, x_developer_auth=None, project_id=None, send_user_operation_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send user operation for end user Smart Account

Prepares, signs, and sends a user operation for an end user’s Smart Account.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The address of the EVM Smart Account to execute the user operation from. (required)
x_idempotency_key (str) – An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_user_operation_with_end_user_account_request (SendUserOperationWithEndUserAccountRequest)
_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:

SignEvmMessageWithEndUserAccount200Response

Returns:

Returns the result object.

async send_user_operation_with_end_user_account_with_http_info(user_id, address, x_idempotency_key=None, x_wallet_auth=None, x_developer_auth=None, project_id=None, send_user_operation_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send user operation for end user Smart Account

Prepares, signs, and sends a user operation for an end user’s Smart Account.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The address of the EVM Smart Account to execute the user operation from. (required)
x_idempotency_key (str) – An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_user_operation_with_end_user_account_request (SendUserOperationWithEndUserAccountRequest)
_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_with_end_user_account_without_preload_content(user_id, address, x_idempotency_key=None, x_wallet_auth=None, x_developer_auth=None, project_id=None, send_user_operation_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Send user operation for end user Smart Account

Prepares, signs, and sends a user operation for an end user’s Smart Account.

Parameters:

user_id (str) – The ID of the end user. (required)
address (str) – The address of the EVM Smart Account to execute the user operation from. (required)
x_idempotency_key (str) – An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
send_user_operation_with_end_user_account_request (SendUserOperationWithEndUserAccountRequest)
_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_with_end_user_account(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_evm_message_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign EIP-191 message via end user EVM account

Signs an [EIP-191](https://eips.ethereum.org/EIPS/eip-191) message with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_evm_message_with_end_user_account_request (SignEvmMessageWithEndUserAccountRequest)
_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:

Returns:

Returns the result object.

async sign_evm_message_with_end_user_account_with_http_info(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_evm_message_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign EIP-191 message via end user EVM account

Signs an [EIP-191](https://eips.ethereum.org/EIPS/eip-191) message with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_evm_message_with_end_user_account_request (SignEvmMessageWithEndUserAccountRequest)
_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[SignEvmMessageWithEndUserAccount200Response]

Returns:

Returns the result object.

async sign_evm_message_with_end_user_account_without_preload_content(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_evm_message_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign EIP-191 message via end user EVM account

Signs an [EIP-191](https://eips.ethereum.org/EIPS/eip-191) message with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_evm_message_with_end_user_account_request (SignEvmMessageWithEndUserAccountRequest)
_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_with_end_user_account(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_evm_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign transaction via end user EVM account

Signs a transaction with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_evm_transaction_with_end_user_account_request (SignEvmTransactionWithEndUserAccountRequest)
_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:

SignEvmTransactionWithEndUserAccount200Response

Returns:

Returns the result object.

async sign_evm_transaction_with_end_user_account_with_http_info(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_evm_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign transaction via end user EVM account

Signs a transaction with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_evm_transaction_with_end_user_account_request (SignEvmTransactionWithEndUserAccountRequest)
_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[SignEvmTransactionWithEndUserAccount200Response]

Returns:

Returns the result object.

async sign_evm_transaction_with_end_user_account_without_preload_content(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_evm_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign transaction via end user EVM account

Signs a transaction with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_evm_transaction_with_end_user_account_request (SignEvmTransactionWithEndUserAccountRequest)
_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_with_end_user_account(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_evm_typed_data_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign EIP-712 typed data via end user EVM account

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

Parameters:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_evm_typed_data_with_end_user_account_request (SignEvmTypedDataWithEndUserAccountRequest)
_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:

SignEvmTypedDataWithEndUserAccount200Response

Returns:

Returns the result object.

async sign_evm_typed_data_with_end_user_account_with_http_info(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_evm_typed_data_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign EIP-712 typed data via end user EVM account

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

Parameters:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_evm_typed_data_with_end_user_account_request (SignEvmTypedDataWithEndUserAccountRequest)
_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[SignEvmTypedDataWithEndUserAccount200Response]

Returns:

Returns the result object.

async sign_evm_typed_data_with_end_user_account_without_preload_content(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_evm_typed_data_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign EIP-712 typed data via end user EVM account

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

Parameters:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_evm_typed_data_with_end_user_account_request (SignEvmTypedDataWithEndUserAccountRequest)
_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_with_end_user_account(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_solana_message_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign Base64-encoded message

Signs an arbitrary Base64 encoded message with the given Solana account. WARNING: Never sign a message that you didn’t generate as it may put your funds at risk.

Parameters:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_solana_message_with_end_user_account_request (SignSolanaMessageWithEndUserAccountRequest)
_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:

SignSolanaMessageWithEndUserAccount200Response

Returns:

Returns the result object.

async sign_solana_message_with_end_user_account_with_http_info(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_solana_message_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign Base64-encoded message

Signs an arbitrary Base64 encoded message with the given Solana account. WARNING: Never sign a message that you didn’t generate as it may put your funds at risk.

Parameters:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_solana_message_with_end_user_account_request (SignSolanaMessageWithEndUserAccountRequest)
_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[SignSolanaMessageWithEndUserAccount200Response]

Returns:

Returns the result object.

async sign_solana_message_with_end_user_account_without_preload_content(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_solana_message_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign Base64-encoded message

Signs an arbitrary Base64 encoded message with the given Solana account. WARNING: Never sign a message that you didn’t generate as it may put your funds at risk.

Parameters:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_solana_message_with_end_user_account_request (SignSolanaMessageWithEndUserAccountRequest)
_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_with_end_user_account(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_solana_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign transaction via end user Solana account

Signs a transaction with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_solana_transaction_with_end_user_account_request (SignSolanaTransactionWithEndUserAccountRequest)
_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:

SignSolanaTransactionWithEndUserAccount200Response

Returns:

Returns the result object.

async sign_solana_transaction_with_end_user_account_with_http_info(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_solana_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign transaction via end user Solana account

Signs a transaction with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_solana_transaction_with_end_user_account_request (SignSolanaTransactionWithEndUserAccountRequest)
_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[SignSolanaTransactionWithEndUserAccount200Response]

Returns:

Returns the result object.

async sign_solana_transaction_with_end_user_account_without_preload_content(user_id, x_wallet_auth=None, x_idempotency_key=None, x_developer_auth=None, project_id=None, sign_solana_transaction_with_end_user_account_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Sign transaction via end user Solana account

Signs a transaction with the given end user 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:

user_id (str) – The ID of the end user. (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
x_developer_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.
project_id (str) – The ID of the CDP Project. Required for end users authenticated using custom auth (i.e. a non-CDP JWT provider).
sign_solana_transaction_with_end_user_account_request (SignSolanaTransactionWithEndUserAccountRequest)
_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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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:

CreateEvmEip7702DelegationWithEndUserAccount201Response

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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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 create_evm_eip7702_delegation(address, create_evm_eip7702_delegation_request, x_wallet_auth=None, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Create EIP-7702 delegation

Creates an EIP-7702 delegation for an EVM EOA account, upgrading it with smart account capabilities. This endpoint: - Retrieves delegation artifacts from onchain - Signs the EIP-7702 authorization for delegation - Assembles and submits a Type 4 transaction - Creates an associated smart account object The delegation allows the EVM EOA to be used as a smart account, which enables batched transactions and gas sponsorship via paymaster.

Parameters:

address (str) – The 0x-prefixed address of the EVM account to delegate. (required)
create_evm_eip7702_delegation_request (CreateEvmEip7702DelegationRequest) – (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
_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:

Returns:

Returns the result object.

async create_evm_eip7702_delegation_with_http_info(address, create_evm_eip7702_delegation_request, x_wallet_auth=None, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Create EIP-7702 delegation

Creates an EIP-7702 delegation for an EVM EOA account, upgrading it with smart account capabilities. This endpoint: - Retrieves delegation artifacts from onchain - Signs the EIP-7702 authorization for delegation - Assembles and submits a Type 4 transaction - Creates an associated smart account object The delegation allows the EVM EOA to be used as a smart account, which enables batched transactions and gas sponsorship via paymaster.

Parameters:

address (str) – The 0x-prefixed address of the EVM account to delegate. (required)
create_evm_eip7702_delegation_request (CreateEvmEip7702DelegationRequest) – (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
_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[CreateEvmEip7702DelegationWithEndUserAccount201Response]

Returns:

Returns the result object.

async create_evm_eip7702_delegation_without_preload_content(address, create_evm_eip7702_delegation_request, x_wallet_auth=None, x_idempotency_key=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Create EIP-7702 delegation

Creates an EIP-7702 delegation for an EVM EOA account, upgrading it with smart account capabilities. This endpoint: - Retrieves delegation artifacts from onchain - Signs the EIP-7702 authorization for delegation - Assembles and submits a Type 4 transaction - Creates an associated smart account object The delegation allows the EVM EOA to be used as a smart account, which enables batched transactions and gas sponsorship via paymaster.

Parameters:

address (str) – The 0x-prefixed address of the EVM account to delegate. (required)
create_evm_eip7702_delegation_request (CreateEvmEip7702DelegationRequest) – (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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
_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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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 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:

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 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:

EvmEip7702DelegationOperation

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 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 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 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 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 get_evm_eip7702_delegation_operation_by_id(delegation_operation_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get EIP-7702 delegation operation by ID

Returns the EIP-7702 delegation operation. Use the delegationOperationId returned by the Create EIP-7702 delegation endpoint to poll for operation completion.

Parameters:

delegation_operation_id (str) – The unique identifier for the delegation operation. (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:

Returns:

Returns the result object.

async get_evm_eip7702_delegation_operation_by_id_with_http_info(delegation_operation_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get EIP-7702 delegation operation by ID

Returns the EIP-7702 delegation operation. Use the delegationOperationId returned by the Create EIP-7702 delegation endpoint to poll for operation completion.

Parameters:

delegation_operation_id (str) – The unique identifier for the delegation operation. (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[EvmEip7702DelegationOperation]

Returns:

Returns the result object.

async get_evm_eip7702_delegation_operation_by_id_without_preload_content(delegation_operation_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get EIP-7702 delegation operation by ID

Returns the EIP-7702 delegation operation. Use the delegationOperationId returned by the Create EIP-7702 delegation endpoint to poll for operation completion.

Parameters:

delegation_operation_id (str) – The unique identifier for the delegation operation. (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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
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:

ListEvmAccounts200Response

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

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

SendEvmTransactionWithEndUserAccount200Response

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

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

SignEvmMessageWithEndUserAccount200Response

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

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

SignEvmTransactionWithEndUserAccount200Response

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

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

SignEvmTypedDataWithEndUserAccount200Response

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

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

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

Creates a new Smart Account.

Parameters:

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

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 Smart Account

Creates a new Smart Account.

Parameters:

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

Creates a new Smart Account.

Parameters:

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

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

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 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:

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 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 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 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 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 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:

ListEvmSmartAccounts200Response

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 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 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:

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 user operation

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

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 user operation

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

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

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

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

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 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 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 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:

CreateSwapQuoteResponseWrapper

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

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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
_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 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 string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
_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 swap price estimate

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 swap price estimate

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 swap price estimate

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

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

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

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

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

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

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(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 OR purchaseAmount), 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. Note: Only one of paymentAmount or purchaseAmount should be provided, not both. Providing both will result in an error. When paymentAmount is provided, the quote shows how much crypto the user will receive for the specified fiat amount (fee-inclusive). When purchaseAmount is provided, the quote shows how much fiat the user needs to pay for the specified crypto amount (fee-exclusive).

Parameters:

onramp_session_request (OnrampSessionRequest)
_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(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 OR purchaseAmount), 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. Note: Only one of paymentAmount or purchaseAmount should be provided, not both. Providing both will result in an error. When paymentAmount is provided, the quote shows how much crypto the user will receive for the specified fiat amount (fee-inclusive). When purchaseAmount is provided, the quote shows how much fiat the user needs to pay for the specified crypto amount (fee-exclusive).

Parameters:

onramp_session_request (OnrampSessionRequest)
_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(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 OR purchaseAmount), 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. Note: Only one of paymentAmount or purchaseAmount should be provided, not both. Providing both will result in an error. When paymentAmount is provided, the quote shows how much crypto the user will receive for the specified fiat amount (fee-inclusive). When purchaseAmount is provided, the quote shows how much fiat the user needs to pay for the specified crypto amount (fee-exclusive).

Parameters:

onramp_session_request (OnrampSessionRequest)
_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.

async get_onramp_user_limits(get_onramp_user_limits_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get onramp user limits

Returns the transaction limits for an onramp user based on their payment method and user identifier. Use this API to show users their remaining purchase capacity before initiating an onramp transaction. Currently supports GUEST_CHECKOUT_APPLE_PAY payment method with phone number identification. The phone number must have been previously verified via OTP.

Parameters:

get_onramp_user_limits_request (GetOnrampUserLimitsRequest)
_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:

GetOnrampUserLimits200Response

Returns:

Returns the result object.

async get_onramp_user_limits_with_http_info(get_onramp_user_limits_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get onramp user limits

Returns the transaction limits for an onramp user based on their payment method and user identifier. Use this API to show users their remaining purchase capacity before initiating an onramp transaction. Currently supports GUEST_CHECKOUT_APPLE_PAY payment method with phone number identification. The phone number must have been previously verified via OTP.

Parameters:

get_onramp_user_limits_request (GetOnrampUserLimitsRequest)
_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[GetOnrampUserLimits200Response]

Returns:

Returns the result object.

async get_onramp_user_limits_without_preload_content(get_onramp_user_limits_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get onramp user limits

Returns the transaction limits for an onramp user based on their payment method and user identifier. Use this API to show users their remaining purchase capacity before initiating an onramp transaction. Currently supports GUEST_CHECKOUT_APPLE_PAY payment method with phone number identification. The phone number must have been previously verified via OTP.

Parameters:

get_onramp_user_limits_request (GetOnrampUserLimitsRequest)
_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 initiate_onramp_verification(x_idempotency_key=None, initiate_onramp_verification_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Initiate onramp verification

Initiates OTP verification by sending a 6-digit code to the user via the specified channel (SMS or email). Returns a verificationId that must be passed to the Submit Onramp Verification endpoint along with the OTP code within 10 minutes. Access to this API requires allowlisting. During Onramp Headless API onboarding, contact the Onramp team to enable Onramp-managed verification for your application.

Parameters:

x_idempotency_key (str) – An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
initiate_onramp_verification_request (InitiateOnrampVerificationRequest)
_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:

OnrampVerificationInitiation

Returns:

Returns the result object.

async initiate_onramp_verification_with_http_info(x_idempotency_key=None, initiate_onramp_verification_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Initiate onramp verification

Initiates OTP verification by sending a 6-digit code to the user via the specified channel (SMS or email). Returns a verificationId that must be passed to the Submit Onramp Verification endpoint along with the OTP code within 10 minutes. Access to this API requires allowlisting. During Onramp Headless API onboarding, contact the Onramp team to enable Onramp-managed verification for your application.

Parameters:

x_idempotency_key (str) – An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
initiate_onramp_verification_request (InitiateOnrampVerificationRequest)
_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[OnrampVerificationInitiation]

Returns:

Returns the result object.

async initiate_onramp_verification_without_preload_content(x_idempotency_key=None, initiate_onramp_verification_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Initiate onramp verification

Initiates OTP verification by sending a 6-digit code to the user via the specified channel (SMS or email). Returns a verificationId that must be passed to the Submit Onramp Verification endpoint along with the OTP code within 10 minutes. Access to this API requires allowlisting. During Onramp Headless API onboarding, contact the Onramp team to enable Onramp-managed verification for your application.

Parameters:

x_idempotency_key (str) – An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
initiate_onramp_verification_request (InitiateOnrampVerificationRequest)
_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_limits_upgrade(onramp_limit_upgrade_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Request limit upgrade

Requests a limit upgrade for an onramp user by submitting identity information. Only phone number is currently supported as a userId. The verification process is asynchronous. After calling this endpoint, use the [Get Onramp User Limits](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/onramp/get-onramp-user-limits) endpoint to check the status in the limitUpgradeOptions array. Prerequisites: - The phone number must have been previously verified by your app via OTP. - Upgrades may not be available until a certain number of successful transactions by the user. Supported fields: - ssnLast4: Last 4 digits of the Social Security Number (no dashes or spaces). - dateOfBirth: Date of birth (day, month, year as zero-padded strings).

Parameters:

onramp_limit_upgrade_request (OnrampLimitUpgradeRequest)
_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 request_limits_upgrade_with_http_info(onramp_limit_upgrade_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Request limit upgrade

Requests a limit upgrade for an onramp user by submitting identity information. Only phone number is currently supported as a userId. The verification process is asynchronous. After calling this endpoint, use the [Get Onramp User Limits](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/onramp/get-onramp-user-limits) endpoint to check the status in the limitUpgradeOptions array. Prerequisites: - The phone number must have been previously verified by your app via OTP. - Upgrades may not be available until a certain number of successful transactions by the user. Supported fields: - ssnLast4: Last 4 digits of the Social Security Number (no dashes or spaces). - dateOfBirth: Date of birth (day, month, year as zero-padded strings).

Parameters:

onramp_limit_upgrade_request (OnrampLimitUpgradeRequest)
_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 request_limits_upgrade_without_preload_content(onramp_limit_upgrade_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Request limit upgrade

Requests a limit upgrade for an onramp user by submitting identity information. Only phone number is currently supported as a userId. The verification process is asynchronous. After calling this endpoint, use the [Get Onramp User Limits](https://docs.cdp.coinbase.com/api-reference/v2/rest-api/onramp/get-onramp-user-limits) endpoint to check the status in the limitUpgradeOptions array. Prerequisites: - The phone number must have been previously verified by your app via OTP. - Upgrades may not be available until a certain number of successful transactions by the user. Supported fields: - ssnLast4: Last 4 digits of the Social Security Number (no dashes or spaces). - dateOfBirth: Date of birth (day, month, year as zero-padded strings).

Parameters:

onramp_limit_upgrade_request (OnrampLimitUpgradeRequest)
_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 submit_onramp_verification(verification_id, x_idempotency_key=None, submit_onramp_verification_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Submit onramp verification

Submits the OTP code to complete verification. On success, marks the verification as verified and returns the same verificationId. The destination does not need to be re-sent. Onramp uses the value captured at initiation time. The returned verificationId should be stored on the user’s device and passed to the Create Onramp Order endpoint. It is valid for 60 days. Access to this API requires allowlisting. During Onramp Headless API onboarding, contact the Onramp team to enable Onramp-managed verification for your application.

Parameters:

verification_id (str) – The verification ID returned by the Initiate Onramp Verification endpoint. (required)
x_idempotency_key (str) – An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
submit_onramp_verification_request (SubmitOnrampVerificationRequest)
_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:

OnrampVerificationConfirmation

Returns:

Returns the result object.

async submit_onramp_verification_with_http_info(verification_id, x_idempotency_key=None, submit_onramp_verification_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Submit onramp verification

Submits the OTP code to complete verification. On success, marks the verification as verified and returns the same verificationId. The destination does not need to be re-sent. Onramp uses the value captured at initiation time. The returned verificationId should be stored on the user’s device and passed to the Create Onramp Order endpoint. It is valid for 60 days. Access to this API requires allowlisting. During Onramp Headless API onboarding, contact the Onramp team to enable Onramp-managed verification for your application.

Parameters:

verification_id (str) – The verification ID returned by the Initiate Onramp Verification endpoint. (required)
x_idempotency_key (str) – An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
submit_onramp_verification_request (SubmitOnrampVerificationRequest)
_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[OnrampVerificationConfirmation]

Returns:

Returns the result object.

async submit_onramp_verification_without_preload_content(verification_id, x_idempotency_key=None, submit_onramp_verification_request=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Submit onramp verification

Submits the OTP code to complete verification. On success, marks the verification as verified and returns the same verificationId. The destination does not need to be re-sent. Onramp uses the value captured at initiation time. The returned verificationId should be stored on the user’s device and passed to the Create Onramp Order endpoint. It is valid for 60 days. Access to this API requires allowlisting. During Onramp Headless API onboarding, contact the Onramp team to enable Onramp-managed verification for your application.

Parameters:

verification_id (str) – The verification ID returned by the Initiate Onramp Verification endpoint. (required)
x_idempotency_key (str) – An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.
submit_onramp_verification_request (SubmitOnrampVerificationRequest)
_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.payment_methods_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.payment_methods_api.PaymentMethodsApi(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_payment_method(payment_method_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get payment method

Get details of a specific payment method by its ID. Returns 404 if the payment method is not found or not owned by the requesting entity.

Parameters:

payment_method_id (str) – The unique identifier of the payment method. (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:

PaymentMethodsPaymentMethod

Returns:

Returns the result object.

async get_payment_method_with_http_info(payment_method_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get payment method

Get details of a specific payment method by its ID. Returns 404 if the payment method is not found or not owned by the requesting entity.

Parameters:

payment_method_id (str) – The unique identifier of the payment method. (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[PaymentMethodsPaymentMethod]

Returns:

Returns the result object.

async get_payment_method_without_preload_content(payment_method_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get payment method

Get details of a specific payment method by its ID. Returns 404 if the payment method is not found or not owned by the requesting entity.

Parameters:

payment_method_id (str) – The unique identifier of the payment method. (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_payment_methods(page_size=None, page_token=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

List payment methods

List payment methods linked to your entity. Payment methods represent external financial instruments that can be used as a target for transfers. The list will not include disabled or deleted payment methods. Currently Supported Types: - fedwire: Domestic USD wire transfers - swift: International wire transfers - sepa: SEPA EUR transfers Note: Payment methods are created and verified through your linked CDP entity. Currently, fetching payment methods is only supported for Prime investment vehicles linked to CDP.

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:

ListPaymentMethods200Response

Returns:

Returns the result object.

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

List payment methods

List payment methods linked to your entity. Payment methods represent external financial instruments that can be used as a target for transfers. The list will not include disabled or deleted payment methods. Currently Supported Types: - fedwire: Domestic USD wire transfers - swift: International wire transfers - sepa: SEPA EUR transfers Note: Payment methods are created and verified through your linked CDP entity. Currently, fetching payment methods is only supported for Prime investment vehicles linked to CDP.

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[ListPaymentMethods200Response]

Returns:

Returns the result object.

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

List payment methods

List payment methods linked to your entity. Payment methods represent external financial instruments that can be used as a target for transfers. The list will not include disabled or deleted payment methods. Currently Supported Types: - fedwire: Domestic USD wire transfers - swift: International wire transfers - sepa: SEPA EUR transfers Note: Payment methods are created and verified through your linked CDP entity. Currently, fetching payment methods is only supported for Prime investment vehicles linked to CDP.

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.

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

ExportSolanaAccount200Response

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

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

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 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:

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

ListSolanaAccounts200Response

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

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:

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

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

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

SendSolanaTransactionWithEndUserAccount200Response

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

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

SignSolanaMessageWithEndUserAccount200Response

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

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

SignSolanaTransactionWithEndUserAccount200Response

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

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