cdp.openapi_client.models package

Submodules

cdp.openapi_client.models.abi_function 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.models.abi_function.AbiFunction(**data)

Bases: BaseModel

ABI function type for contract functions.

constant: Optional[StrictBool]
classmethod from_dict(obj)

Create an instance of AbiFunction from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AbiFunction from a JSON string

Return type:

Optional[Self]

gas: Optional[StrictInt]
inputs: List[AbiParameter]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr
outputs: List[AbiParameter]
payable: Optional[StrictBool]
state_mutability: AbiStateMutability
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.abi_inner 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.models.abi_inner.AbiInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[AbiFunction, AbiInput]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[AbiFunction]
oneof_schema_2_validator: Optional[AbiInput]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], AbiFunction, AbiInput, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.abi_input 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.models.abi_input.AbiInput(**data)

Bases: BaseModel

Generic ABI item type encapsulating all other types besides function.

additional_properties: Optional[Any]
classmethod from_dict(obj)

Create an instance of AbiInput from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AbiInput from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.abi_parameter 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.models.abi_parameter.AbiParameter(**data)

Bases: BaseModel

Parameter definition for ABI functions, errors, and constructors.

components: Optional[List[AbiParameter]]
classmethod from_dict(obj)

Create an instance of AbiParameter from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AbiParameter from a JSON string

Return type:

Optional[Self]

internal_type: Optional[StrictStr]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr

cdp.openapi_client.models.abi_state_mutability 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.models.abi_state_mutability.AbiStateMutability(value)

Bases: str, Enum

State mutability of a function in Solidity.

NONPAYABLE = 'nonpayable'
PAYABLE = 'payable'
PURE = 'pure'
VIEW = 'view'
classmethod from_json(json_str)

Create an instance of AbiStateMutability from a JSON string

Return type:

Self

cdp.openapi_client.models.account 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.models.account.Account(**data)

Bases: BaseModel

account_id: Annotated[str, Field(strict=True)]
classmethod account_id_validate_regular_expression(value)

Validates the regular expression

created_at: datetime
classmethod from_dict(obj)

Create an instance of Account from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Account from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True, max_length=64)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

owner: Annotated[str, Field(strict=True)]
classmethod owner_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: AccountType
updated_at: datetime

cdp.openapi_client.models.account_token_addresses_response 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.models.account_token_addresses_response.AccountTokenAddressesResponse(**data)

Bases: BaseModel

Response containing token addresses that an account has received.

account_address: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of AccountTokenAddressesResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AccountTokenAddressesResponse from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token_addresses: Optional[List[Annotated[str, Field(strict=True)]]]
total_count: Optional[Annotated[int, Field(strict=True, ge=0)]]

cdp.openapi_client.models.account_type 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.models.account_type.AccountType(value)

Bases: str, Enum

The type of the Account.

BUSINESS = 'business'
CDP = 'cdp'
PRIME = 'prime'
classmethod from_json(json_str)

Create an instance of AccountType from a JSON string

Return type:

Self

cdp.openapi_client.models.add_end_user_evm_account201_response 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.models.add_end_user_evm_account201_response.AddEndUserEvmAccount201Response(**data)

Bases: BaseModel

evm_account: EndUserEvmAccount
classmethod from_dict(obj)

Create an instance of AddEndUserEvmAccount201Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddEndUserEvmAccount201Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.add_end_user_evm_smart_account201_response 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.models.add_end_user_evm_smart_account201_response.AddEndUserEvmSmartAccount201Response(**data)

Bases: BaseModel

evm_smart_account: EndUserEvmSmartAccount
classmethod from_dict(obj)

Create an instance of AddEndUserEvmSmartAccount201Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddEndUserEvmSmartAccount201Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.add_end_user_evm_smart_account_request 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.models.add_end_user_evm_smart_account_request.AddEndUserEvmSmartAccountRequest(**data)

Bases: BaseModel

enable_spend_permissions: Optional[StrictBool]
classmethod from_dict(obj)

Create an instance of AddEndUserEvmSmartAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddEndUserEvmSmartAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.add_end_user_solana_account201_response 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.models.add_end_user_solana_account201_response.AddEndUserSolanaAccount201Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of AddEndUserSolanaAccount201Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddEndUserSolanaAccount201Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

solana_account: EndUserSolanaAccount
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.amount_detail 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.models.amount_detail.AmountDetail(**data)

Bases: BaseModel

Available and total amounts for a specific currency.

available: StrictStr
classmethod from_dict(obj)

Create an instance of AmountDetail from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AmountDetail from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

total: StrictStr

cdp.openapi_client.models.api_key_wallet 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.models.api_key_wallet.APIKeyWallet(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of APIKeyWallet from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWallet from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
replaced_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.api_key_wallet1 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.models.api_key_wallet1.APIKeyWallet1(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of APIKeyWallet1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWallet1 from a JSON string

Return type:

Optional[Self]

max_fee_per_gas: StrictStr
max_priority_fee_per_gas: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
pending_since: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.api_key_wallet2 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.models.api_key_wallet2.APIKeyWallet2(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of APIKeyWallet2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWallet2 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.api_key_wallet_evm 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.models.api_key_wallet_evm.APIKeyWalletEVM(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
created_at: datetime
classmethod from_dict(obj)

Create an instance of APIKeyWalletEVM from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletEVM from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.api_key_wallet_evm1 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.models.api_key_wallet_evm1.APIKeyWalletEVM1(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of APIKeyWalletEVM1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletEVM1 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.api_key_wallet_evm2 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.models.api_key_wallet_evm2.APIKeyWalletEVM2(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
broadcast_at: datetime
classmethod from_dict(obj)

Create an instance of APIKeyWalletEVM2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletEVM2 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.api_key_wallet_evm3 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.models.api_key_wallet_evm3.APIKeyWalletEVM3(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
confirmed_at: datetime
classmethod from_dict(obj)

Create an instance of APIKeyWalletEVM3 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletEVM3 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.api_key_wallet_evm4 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.models.api_key_wallet_evm4.APIKeyWalletEVM4(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
failed_at: datetime
classmethod from_dict(obj)

Create an instance of APIKeyWalletEVM4 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletEVM4 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.api_key_wallet_solana 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.models.api_key_wallet_solana.APIKeyWalletSolana(**data)

Bases: BaseModel

created_at: datetime
classmethod from_dict(obj)

Create an instance of APIKeyWalletSolana from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletSolana from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.api_key_wallet_solana1 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.models.api_key_wallet_solana1.APIKeyWalletSolana1(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of APIKeyWalletSolana1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletSolana1 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.api_key_wallet_solana2 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.models.api_key_wallet_solana2.APIKeyWalletSolana2(**data)

Bases: BaseModel

broadcast_at: datetime
classmethod from_dict(obj)

Create an instance of APIKeyWalletSolana2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletSolana2 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr

cdp.openapi_client.models.api_key_wallet_solana3 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.models.api_key_wallet_solana3.APIKeyWalletSolana3(**data)

Bases: BaseModel

confirmed_at: datetime
classmethod from_dict(obj)

Create an instance of APIKeyWalletSolana3 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletSolana3 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr

cdp.openapi_client.models.api_key_wallet_solana4 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.models.api_key_wallet_solana4.APIKeyWalletSolana4(**data)

Bases: BaseModel

failed_at: datetime
classmethod from_dict(obj)

Create an instance of APIKeyWalletSolana4 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of APIKeyWalletSolana4 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr

cdp.openapi_client.models.asset_type 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.models.asset_type.AssetType(value)

Bases: str, Enum

The type of the asset.

CRYPTO = 'crypto'
FIAT = 'fiat'
classmethod from_json(json_str)

Create an instance of AssetType from a JSON string

Return type:

Self

cdp.openapi_client.models.authentication_method 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.models.authentication_method.AuthenticationMethod(*args, **kwargs)

Bases: BaseModel

Information about how the end user is authenticated.

actual_instance: Optional[Union[DeveloperJWTAuthentication, EmailAuthentication, OAuth2Authentication, SiweAuthentication, SmsAuthentication, TelegramAuthentication]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[EmailAuthentication]
oneof_schema_2_validator: Optional[SmsAuthentication]
oneof_schema_3_validator: Optional[DeveloperJWTAuthentication]
oneof_schema_4_validator: Optional[OAuth2Authentication]
oneof_schema_5_validator: Optional[TelegramAuthentication]
oneof_schema_6_validator: Optional[SiweAuthentication]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], DeveloperJWTAuthentication, EmailAuthentication, OAuth2Authentication, SiweAuthentication, SmsAuthentication, TelegramAuthentication, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.balance 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.models.balance.Balance(**data)

Bases: BaseModel

A balance of an asset.

amount: Dict[str, AmountDetail]
asset: BalancesAsset
classmethod from_dict(obj)

Create an instance of Balance from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Balance from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.balances 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.models.balances.Balances(**data)

Bases: BaseModel

A list of balances for an account.

balances: List[Balance]
classmethod from_dict(obj)

Create an instance of Balances from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Balances from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.balances_asset 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.models.balances_asset.BalancesAsset(**data)

Bases: BaseModel

An asset, e.g. fiat or crypto.

decimals: StrictInt
classmethod from_dict(obj)

Create an instance of BalancesAsset from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of BalancesAsset from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr
symbol: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: AssetType

cdp.openapi_client.models.capability_name 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.models.capability_name.CapabilityName(value)

Bases: str, Enum

The name of a capability. Capabilities represent granular functional permissions that determine what actions a customer can perform. Each capability must be explicitly requested before use.

CUSTODYCRYPTO = 'custodyCrypto'
CUSTODYFIAT = 'custodyFiat'
CUSTODYSTABLECOIN = 'custodyStablecoin'
TRADECRYPTO = 'tradeCrypto'
TRADESTABLECOIN = 'tradeStablecoin'
TRANSFERCRYPTO = 'transferCrypto'
TRANSFERFIAT = 'transferFiat'
TRANSFERSTABLECOIN = 'transferStablecoin'
classmethod from_json(json_str)

Create an instance of CapabilityName from a JSON string

Return type:

Self

cdp.openapi_client.models.common_swap_response 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.models.common_swap_response.CommonSwapResponse(**data)

Bases: BaseModel

block_number: Annotated[str, Field(strict=True)]
classmethod block_number_validate_regular_expression(value)

Validates the regular expression

fees: CommonSwapResponseFees
from_amount: Annotated[str, Field(strict=True)]
classmethod from_amount_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CommonSwapResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CommonSwapResponse from a JSON string

Return type:

Optional[Self]

from_token: Annotated[str, Field(strict=True)]
classmethod from_token_validate_regular_expression(value)

Validates the regular expression

issues: CommonSwapResponseIssues
liquidity_available: StrictBool
classmethod liquidity_available_validate_enum(value)

Validates the enum

min_to_amount: Annotated[str, Field(strict=True)]
classmethod min_to_amount_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_amount: Annotated[str, Field(strict=True)]
classmethod to_amount_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

to_token: Annotated[str, Field(strict=True)]
classmethod to_token_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.common_swap_response_fees 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.models.common_swap_response_fees.CommonSwapResponseFees(**data)

Bases: BaseModel

The estimated fees for the swap.

classmethod from_dict(obj)

Create an instance of CommonSwapResponseFees from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CommonSwapResponseFees from a JSON string

Return type:

Optional[Self]

gas_fee: TokenFee
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

protocol_fee: TokenFee
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.common_swap_response_issues 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.models.common_swap_response_issues.CommonSwapResponseIssues(**data)

Bases: BaseModel

An object containing potential issues discovered during validation that could prevent the swap from being executed successfully.

allowance: CommonSwapResponseIssuesAllowance
balance: CommonSwapResponseIssuesBalance
classmethod from_dict(obj)

Create an instance of CommonSwapResponseIssues from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CommonSwapResponseIssues from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

simulation_incomplete: StrictBool
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.common_swap_response_issues_allowance 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.models.common_swap_response_issues_allowance.CommonSwapResponseIssuesAllowance(**data)

Bases: BaseModel

Details of the allowances that the taker must set in order to execute the swap successfully. Null if no allowance is required.

current_allowance: Annotated[str, Field(strict=True)]
classmethod current_allowance_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CommonSwapResponseIssuesAllowance from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CommonSwapResponseIssuesAllowance from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

spender: Annotated[str, Field(strict=True)]
classmethod spender_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.common_swap_response_issues_balance 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.models.common_swap_response_issues_balance.CommonSwapResponseIssuesBalance(**data)

Bases: BaseModel

Details of the balance of the fromToken that the taker must hold. Null if the taker has a sufficient balance.

current_balance: Annotated[str, Field(strict=True)]
classmethod current_balance_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CommonSwapResponseIssuesBalance from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CommonSwapResponseIssuesBalance from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

required_balance: Annotated[str, Field(strict=True)]
classmethod required_balance_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: Annotated[str, Field(strict=True)]
classmethod token_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.create_account_request 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.models.create_account_request.CreateAccountRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of CreateAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True, max_length=64)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_crypto_deposit_destination_request 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.models.create_crypto_deposit_destination_request.CreateCryptoDepositDestinationRequest(**data)

Bases: BaseModel

account_id: Annotated[str, Field(strict=True)]
classmethod account_id_validate_regular_expression(value)

Validates the regular expression

crypto: CreateDepositDestinationCrypto
classmethod from_dict(obj)

Create an instance of CreateCryptoDepositDestinationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateCryptoDepositDestinationRequest from a JSON string

Return type:

Optional[Self]

metadata: Optional[Dict[str, Annotated[str, Field(min_length=0, strict=True, max_length=500)]]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

target: Optional[DepositDestinationTarget]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.create_delegation_for_end_user_account_request 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.models.create_delegation_for_end_user_account_request.CreateDelegationForEndUserAccountRequest(**data)

Bases: BaseModel

expires_at: datetime
classmethod from_dict(obj)

Create an instance of CreateDelegationForEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateDelegationForEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

wallet_secret_id: Annotated[str, Field(strict=True)]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.create_deposit_destination_crypto 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.models.create_deposit_destination_crypto.CreateDepositDestinationCrypto(**data)

Bases: BaseModel

Crypto-specific details for creating a deposit destination.

classmethod from_dict(obj)

Create an instance of CreateDepositDestinationCrypto from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateDepositDestinationCrypto from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_deposit_destination_request 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.models.create_deposit_destination_request.CreateDepositDestinationRequest(*args, **kwargs)

Bases: BaseModel

Request to create a new deposit destination. Provide the type-specific details matching the chosen type.

actual_instance: Optional[Union[CreateCryptoDepositDestinationRequest]]
classmethod actual_instance_must_validate_oneof(v)
discriminator_value_class_map: Dict[str, str]
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[CreateCryptoDepositDestinationRequest]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], CreateCryptoDepositDestinationRequest, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.create_deposit_destination_request_base 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.models.create_deposit_destination_request_base.CreateDepositDestinationRequestBase(**data)

Bases: BaseModel

Common fields for creating a deposit destination.

account_id: Annotated[str, Field(strict=True)]
classmethod account_id_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CreateDepositDestinationRequestBase from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateDepositDestinationRequestBase from a JSON string

Return type:

Optional[Self]

metadata: Optional[Dict[str, Annotated[str, Field(min_length=0, strict=True, max_length=500)]]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

target: Optional[DepositDestinationTarget]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr

cdp.openapi_client.models.create_end_user_evm_swap_rule 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.models.create_end_user_evm_swap_rule.CreateEndUserEvmSwapRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendEndUserEvmAssetCriteriaInner]
classmethod from_dict(obj)

Create an instance of CreateEndUserEvmSwapRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEndUserEvmSwapRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_end_user_request 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.models.create_end_user_request.CreateEndUserRequest(**data)

Bases: BaseModel

authentication_methods: List[AuthenticationMethod]
evm_account: Optional[CreateEndUserRequestEvmAccount]
classmethod from_dict(obj)

Create an instance of CreateEndUserRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEndUserRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

solana_account: Optional[CreateEndUserRequestSolanaAccount]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: Optional[Annotated[str, Field(strict=True)]]
classmethod user_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.create_end_user_request_evm_account 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.models.create_end_user_request_evm_account.CreateEndUserRequestEvmAccount(**data)

Bases: BaseModel

Configuration for creating an EVM account for the end user.

create_smart_account: Optional[StrictBool]
enable_spend_permissions: Optional[StrictBool]
classmethod from_dict(obj)

Create an instance of CreateEndUserRequestEvmAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEndUserRequestEvmAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_end_user_request_solana_account 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.models.create_end_user_request_solana_account.CreateEndUserRequestSolanaAccount(**data)

Bases: BaseModel

Configuration for creating a Solana account for the end user.

create_smart_account: Optional[StrictBool]
classmethod from_dict(obj)

Create an instance of CreateEndUserRequestSolanaAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEndUserRequestSolanaAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_evm_account_request 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.models.create_evm_account_request.CreateEvmAccountRequest(**data)

Bases: BaseModel

account_policy: Optional[Annotated[str, Field(strict=True)]]
classmethod account_policy_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CreateEvmAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEvmAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_evm_eip7702_delegation_request 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.models.create_evm_eip7702_delegation_request.CreateEvmEip7702DelegationRequest(**data)

Bases: BaseModel

enable_spend_permissions: Optional[StrictBool]
classmethod from_dict(obj)

Create an instance of CreateEvmEip7702DelegationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEvmEip7702DelegationRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: EvmEip7702DelegationNetwork
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_evm_eip7702_delegation_with_end_user_account201_response 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.models.create_evm_eip7702_delegation_with_end_user_account201_response.CreateEvmEip7702DelegationWithEndUserAccount201Response(**data)

Bases: BaseModel

delegation_operation_id: StrictStr
classmethod from_dict(obj)

Create an instance of CreateEvmEip7702DelegationWithEndUserAccount201Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEvmEip7702DelegationWithEndUserAccount201Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_evm_eip7702_delegation_with_end_user_account_request 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.models.create_evm_eip7702_delegation_with_end_user_account_request.CreateEvmEip7702DelegationWithEndUserAccountRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

enable_spend_permissions: Optional[StrictBool]
classmethod from_dict(obj)

Create an instance of CreateEvmEip7702DelegationWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEvmEip7702DelegationWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: EvmEip7702DelegationNetwork
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.create_evm_smart_account_request 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.models.create_evm_smart_account_request.CreateEvmSmartAccountRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of CreateEvmSmartAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEvmSmartAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

owners: List[Annotated[str, Field(strict=True)]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_evm_swap_quote_request 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.models.create_evm_swap_quote_request.CreateEvmSwapQuoteRequest(**data)

Bases: BaseModel

from_amount: Annotated[str, Field(strict=True)]
classmethod from_amount_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CreateEvmSwapQuoteRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateEvmSwapQuoteRequest from a JSON string

Return type:

Optional[Self]

from_token: Annotated[str, Field(strict=True)]
classmethod from_token_validate_regular_expression(value)

Validates the regular expression

gas_price: Optional[Annotated[str, Field(strict=True)]]
classmethod gas_price_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: EvmSwapsNetwork
signer_address: Optional[Annotated[str, Field(strict=True)]]
classmethod signer_address_validate_regular_expression(value)

Validates the regular expression

slippage_bps: Optional[Annotated[int, Field(le=10000, strict=True, ge=0)]]
taker: Annotated[str, Field(strict=True)]
classmethod taker_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

to_token: Annotated[str, Field(strict=True)]
classmethod to_token_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.create_onramp_order201_response 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.models.create_onramp_order201_response.CreateOnrampOrder201Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of CreateOnrampOrder201Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateOnrampOrder201Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order: OnrampOrder
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_onramp_order_request 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.models.create_onramp_order_request.CreateOnrampOrderRequest(**data)

Bases: BaseModel

agreement_accepted_at: datetime
client_ip: Optional[StrictStr]
destination_address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
destination_network: StrictStr
domain: Optional[StrictStr]
email: StrictStr
email_verification_id: Optional[Annotated[str, Field(strict=True)]]
classmethod email_verification_id_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CreateOnrampOrderRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateOnrampOrderRequest from a JSON string

Return type:

Optional[Self]

is_quote: Optional[StrictBool]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

partner_order_ref: Optional[StrictStr]
partner_user_ref: StrictStr
payment_amount: Optional[StrictStr]
payment_currency: StrictStr
payment_method: OnrampOrderPaymentMethodTypeId
phone_number: StrictStr
phone_number_verified_at: datetime
purchase_amount: Optional[StrictStr]
purchase_currency: StrictStr
sms_verification_id: Optional[Annotated[str, Field(strict=True)]]
classmethod sms_verification_id_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_onramp_session201_response 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.models.create_onramp_session201_response.CreateOnrampSession201Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of CreateOnrampSession201Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateOnrampSession201Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

quote: Optional[OnrampQuote]
session: OnrampSession
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_policy_request 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.models.create_policy_request.CreatePolicyRequest(**data)

Bases: BaseModel

description: Optional[Annotated[str, Field(strict=True)]]
classmethod description_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CreatePolicyRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreatePolicyRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rules: List[Rule]
scope: StrictStr
classmethod scope_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_solana_account_request 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.models.create_solana_account_request.CreateSolanaAccountRequest(**data)

Bases: BaseModel

account_policy: Optional[Annotated[str, Field(strict=True)]]
classmethod account_policy_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CreateSolanaAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateSolanaAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_spend_permission_request 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.models.create_spend_permission_request.CreateSpendPermissionRequest(**data)

Bases: BaseModel

Request parameters for creating a Spend Permission.

allowance: StrictStr
end: StrictStr
extra_data: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of CreateSpendPermissionRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateSpendPermissionRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: SpendPermissionNetwork
paymaster_url: Optional[Annotated[str, Field(min_length=11, strict=True, max_length=2048)]]
classmethod paymaster_url_validate_regular_expression(value)

Validates the regular expression

period: StrictStr
salt: Optional[StrictStr]
spender: Annotated[str, Field(strict=True)]
classmethod spender_validate_regular_expression(value)

Validates the regular expression

start: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: Annotated[str, Field(strict=True)]
classmethod token_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.create_swap_quote_response 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.models.create_swap_quote_response.CreateSwapQuoteResponse(**data)

Bases: BaseModel

block_number: Annotated[str, Field(strict=True)]
classmethod block_number_validate_regular_expression(value)

Validates the regular expression

fees: CommonSwapResponseFees
from_amount: Annotated[str, Field(strict=True)]
classmethod from_amount_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CreateSwapQuoteResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateSwapQuoteResponse from a JSON string

Return type:

Optional[Self]

from_token: Annotated[str, Field(strict=True)]
classmethod from_token_validate_regular_expression(value)

Validates the regular expression

issues: CommonSwapResponseIssues
liquidity_available: StrictBool
classmethod liquidity_available_validate_enum(value)

Validates the enum

min_to_amount: Annotated[str, Field(strict=True)]
classmethod min_to_amount_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

permit2: CreateSwapQuoteResponseAllOfPermit2
to_amount: Annotated[str, Field(strict=True)]
classmethod to_amount_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

to_token: Annotated[str, Field(strict=True)]
classmethod to_token_validate_regular_expression(value)

Validates the regular expression

transaction: CreateSwapQuoteResponseAllOfTransaction

cdp.openapi_client.models.create_swap_quote_response_all_of_permit2 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.models.create_swap_quote_response_all_of_permit2.CreateSwapQuoteResponseAllOfPermit2(**data)

Bases: BaseModel

The approval object which contains the necessary fields to submit an approval for this transaction. Null if the fromToken is the native token or the transaction is a native token wrap / unwrap.

eip712: EIP712Message
classmethod from_dict(obj)

Create an instance of CreateSwapQuoteResponseAllOfPermit2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateSwapQuoteResponseAllOfPermit2 from a JSON string

Return type:

Optional[Self]

hash: Annotated[str, Field(strict=True)]
classmethod hash_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.create_swap_quote_response_all_of_transaction 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.models.create_swap_quote_response_all_of_transaction.CreateSwapQuoteResponseAllOfTransaction(**data)

Bases: BaseModel

The details of the transaction to be signed and submitted to execute the swap.

data: StrictStr
classmethod from_dict(obj)

Create an instance of CreateSwapQuoteResponseAllOfTransaction from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateSwapQuoteResponseAllOfTransaction from a JSON string

Return type:

Optional[Self]

gas: Annotated[str, Field(strict=True)]
gas_price: Annotated[str, Field(strict=True)]
classmethod gas_price_validate_regular_expression(value)

Validates the regular expression

classmethod gas_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to: Annotated[str, Field(strict=True)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

classmethod to_validate_regular_expression(value)

Validates the regular expression

value: Annotated[str, Field(strict=True)]
classmethod value_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.create_swap_quote_response_wrapper 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.models.create_swap_quote_response_wrapper.CreateSwapQuoteResponseWrapper(*args, **kwargs)

Bases: BaseModel

A wrapper for the response of a swap quote operation.

actual_instance: Optional[Union[CreateSwapQuoteResponse, SwapUnavailableResponse]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[CreateSwapQuoteResponse]
oneof_schema_2_validator: Optional[SwapUnavailableResponse]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], CreateSwapQuoteResponse, SwapUnavailableResponse, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.create_transfer_source 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.models.create_transfer_source.CreateTransferSource(*args, **kwargs)

Bases: BaseModel

The source of the transfer.

actual_instance: Optional[Union[PaymentMethod, TransfersAccount]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[TransfersAccount]
oneof_schema_2_validator: Optional[PaymentMethod]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], PaymentMethod, TransfersAccount, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.crypto_deposit_destination 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.models.crypto_deposit_destination.CryptoDepositDestination(**data)

Bases: BaseModel

A cryptocurrency deposit destination.

account_id: Annotated[str, Field(strict=True)]
classmethod account_id_validate_regular_expression(value)

Validates the regular expression

created_at: datetime
crypto: DepositDestinationCrypto
deposit_destination_id: Annotated[str, Field(strict=True)]
classmethod deposit_destination_id_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of CryptoDepositDestination from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CryptoDepositDestination from a JSON string

Return type:

Optional[Self]

metadata: Optional[Dict[str, Annotated[str, Field(min_length=0, strict=True, max_length=500)]]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: DepositDestinationStatus
target: Optional[DepositDestinationTarget]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

updated_at: datetime

cdp.openapi_client.models.date_of_birth 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.models.date_of_birth.DateOfBirth(**data)

Bases: BaseModel

Date of birth.

day: Optional[Annotated[str, Field(min_length=2, strict=True, max_length=2)]]
classmethod day_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of DateOfBirth from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DateOfBirth from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

month: Optional[Annotated[str, Field(min_length=2, strict=True, max_length=2)]]
classmethod month_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

year: Optional[Annotated[str, Field(min_length=4, strict=True, max_length=4)]]
classmethod year_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.deposit_destination 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.models.deposit_destination.DepositDestination(*args, **kwargs)

Bases: BaseModel

A deposit destination for receiving funds to an account.

actual_instance: Optional[Union[CryptoDepositDestination]]
classmethod actual_instance_must_validate_oneof(v)
discriminator_value_class_map: Dict[str, str]
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[CryptoDepositDestination]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], CryptoDepositDestination, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.deposit_destination_crypto 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.models.deposit_destination_crypto.DepositDestinationCrypto(**data)

Bases: BaseModel

Crypto-specific deposit destination details. In responses, this object is always present. Contains the network and address for the deposit destination.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of DepositDestinationCrypto from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DepositDestinationCrypto from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.deposit_destination_reference 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.models.deposit_destination_reference.DepositDestinationReference(**data)

Bases: BaseModel

A reference to the deposit destination associated with the transfer.

classmethod from_dict(obj)

Create an instance of DepositDestinationReference from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DepositDestinationReference from a JSON string

Return type:

Optional[Self]

id: Annotated[str, Field(strict=True)]
classmethod id_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.deposit_destination_status 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.models.deposit_destination_status.DepositDestinationStatus(value)

Bases: str, Enum

The status of the deposit destination.

ACTIVE = 'active'
INACTIVE = 'inactive'
PENDING = 'pending'
classmethod from_json(json_str)

Create an instance of DepositDestinationStatus from a JSON string

Return type:

Self

cdp.openapi_client.models.deposit_destination_target 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.models.deposit_destination_target.DepositDestinationTarget(*args, **kwargs)

Bases: BaseModel

The intended target for deposited funds.

actual_instance: Optional[Union[DepositDestinationTargetAccount]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[DepositDestinationTargetAccount]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], DepositDestinationTargetAccount, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.deposit_destination_target_account 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.models.deposit_destination_target_account.DepositDestinationTargetAccount(**data)

Bases: BaseModel

The account and asset where incoming deposits should be credited.

account_id: Optional[Annotated[str, Field(strict=True)]]
classmethod account_id_validate_regular_expression(value)

Validates the regular expression

asset: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
classmethod from_dict(obj)

Create an instance of DepositDestinationTargetAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DepositDestinationTargetAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.deposit_travel_rule_beneficiary 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.models.deposit_travel_rule_beneficiary.DepositTravelRuleBeneficiary(**data)

Bases: BaseModel

Beneficiary information for a deposit travel rule submission.

classmethod from_dict(obj)

Create an instance of DepositTravelRuleBeneficiary from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DepositTravelRuleBeneficiary from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.deposit_travel_rule_originator 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.models.deposit_travel_rule_originator.DepositTravelRuleOriginator(**data)

Bases: BaseModel

Originator information for a deposit travel rule submission.

address: Optional[PhysicalAddress]
date_of_birth: Optional[DateOfBirth]
classmethod from_dict(obj)

Create an instance of DepositTravelRuleOriginator from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DepositTravelRuleOriginator from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
personal_id: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

virtual_asset_service_provider: Optional[DepositTravelRuleVasp]
wallet_type: Optional[StrictStr]
classmethod wallet_type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.deposit_travel_rule_request 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.models.deposit_travel_rule_request.DepositTravelRuleRequest(**data)

Bases: BaseModel

Request body for submitting travel rule information for a deposit transfer. Required fields vary by jurisdiction.

beneficiary: Optional[DepositTravelRuleBeneficiary]
classmethod from_dict(obj)

Create an instance of DepositTravelRuleRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DepositTravelRuleRequest from a JSON string

Return type:

Optional[Self]

is_self: Optional[StrictBool]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

originator: Optional[DepositTravelRuleOriginator]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.deposit_travel_rule_response 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.models.deposit_travel_rule_response.DepositTravelRuleResponse(**data)

Bases: BaseModel

Response from submitting travel rule information for a deposit transfer.

classmethod from_dict(obj)

Create an instance of DepositTravelRuleResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DepositTravelRuleResponse from a JSON string

Return type:

Optional[Self]

missing_fields: Optional[List[StrictStr]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

reason: Optional[StrictStr]
status: TravelRuleStatus
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.deposit_travel_rule_vasp 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.models.deposit_travel_rule_vasp.DepositTravelRuleVasp(**data)

Bases: BaseModel

Information about the Virtual Asset Service Provider (VASP) for a deposit travel rule submission.

classmethod from_dict(obj)

Create an instance of DepositTravelRuleVasp from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DepositTravelRuleVasp from a JSON string

Return type:

Optional[Self]

identifier: Optional[StrictStr]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.developer_jwt_authentication 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.models.developer_jwt_authentication.DeveloperJWTAuthentication(**data)

Bases: BaseModel

Information about an end user who authenticates using a JWT issued by the developer.

classmethod from_dict(obj)

Create an instance of DeveloperJWTAuthentication from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DeveloperJWTAuthentication from a JSON string

Return type:

Optional[Self]

kid: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sub: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.eip712_domain 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.models.eip712_domain.EIP712Domain(**data)

Bases: BaseModel

The domain of the EIP-712 typed data.

chain_id: Optional[StrictInt]
classmethod from_dict(obj)

Create an instance of EIP712Domain from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EIP712Domain from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
salt: Optional[Annotated[str, Field(strict=True)]]
classmethod salt_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

verifying_contract: Optional[Annotated[str, Field(strict=True)]]
classmethod verifying_contract_validate_regular_expression(value)

Validates the regular expression

version: Optional[StrictStr]

cdp.openapi_client.models.eip712_message 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.models.eip712_message.EIP712Message(**data)

Bases: BaseModel

The message to sign using EIP-712.

domain: EIP712Domain
classmethod from_dict(obj)

Create an instance of EIP712Message from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EIP712Message from a JSON string

Return type:

Optional[Self]

message: Dict[str, Any]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

primary_type: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

types: Dict[str, Any]

cdp.openapi_client.models.email_address 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.models.email_address.EmailAddress(**data)

Bases: BaseModel

The target of the payment is an email address.

email: Annotated[str, Field(strict=True, max_length=254)]
classmethod email_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of EmailAddress from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EmailAddress from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.email_authentication 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.models.email_authentication.EmailAuthentication(**data)

Bases: BaseModel

Information about an end user who authenticates using a one-time password sent to their email address.

email: Annotated[str, Field(strict=True, max_length=254)]
classmethod email_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of EmailAuthentication from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EmailAuthentication from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.email_instrument 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.models.email_instrument.EmailInstrument(**data)

Bases: BaseModel

The target of the payment is an email address.

asset: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
email: Annotated[str, Field(strict=True, max_length=254)]
classmethod email_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of EmailInstrument from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EmailInstrument from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.end_user 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.models.end_user.EndUser(**data)

Bases: BaseModel

Information about the end user.

authentication_methods: List[AuthenticationMethod]
created_at: datetime
evm_account_objects: List[EndUserEvmAccount]
evm_accounts: List[Annotated[str, Field(strict=True)]]
evm_smart_account_objects: List[EndUserEvmSmartAccount]
evm_smart_accounts: List[Annotated[str, Field(strict=True)]]
classmethod from_dict(obj)

Create an instance of EndUser from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EndUser from a JSON string

Return type:

Optional[Self]

mfa_methods: Optional[MFAMethods]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

solana_account_objects: List[EndUserSolanaAccount]
solana_accounts: List[Annotated[str, Field(strict=True)]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: Annotated[str, Field(strict=True)]
classmethod user_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.end_user_evm_account 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.models.end_user_evm_account.EndUserEvmAccount(**data)

Bases: BaseModel

Information about an EVM account associated with an end user.

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

created_at: datetime
classmethod from_dict(obj)

Create an instance of EndUserEvmAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EndUserEvmAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.end_user_evm_smart_account 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.models.end_user_evm_smart_account.EndUserEvmSmartAccount(**data)

Bases: BaseModel

Information about an EVM smart account associated with an end user.

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

created_at: datetime
classmethod from_dict(obj)

Create an instance of EndUserEvmSmartAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EndUserEvmSmartAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

owner_addresses: List[Annotated[str, Field(strict=True)]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.end_user_solana_account 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.models.end_user_solana_account.EndUserSolanaAccount(**data)

Bases: BaseModel

Information about a Solana account associated with an end user.

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

created_at: datetime
classmethod from_dict(obj)

Create an instance of EndUserSolanaAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EndUserSolanaAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.error 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.models.error.Error(**data)

Bases: BaseModel

An error response including the code for the type of error and a human-readable message describing the error.

correlation_id: Optional[StrictStr]

Validates the regular expression

error_message: StrictStr
error_type: ErrorType
classmethod from_dict(obj)

Create an instance of Error from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Error from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

unauthorized_capabilities: Optional[List[CapabilityName]]

cdp.openapi_client.models.error_type 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.models.error_type.ErrorType(value)

Bases: str, Enum

The code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.

ACCOUNT_LIMIT_EXCEEDED = 'account_limit_exceeded'
ACCOUNT_NOT_READY = 'account_not_ready'
ALREADY_ENABLED = 'already_enabled'
ALREADY_EXISTS = 'already_exists'
ASSET_MISMATCH = 'asset_mismatch'
AUTHORIZATION_EXPIRED = 'authorization_expired'
BAD_GATEWAY = 'bad_gateway'
CAPTURE_EXPIRED = 'capture_expired'
CLIENT_CLOSED_REQUEST = 'client_closed_request'
CUSTOMER_NOT_AUTHORIZED = 'customer_not_authorized'
DAILY_AMOUNT_LIMIT_EXCEEDED = 'daily_amount_limit_exceeded'
DAILY_TRANSACTION_LIMIT_EXCEEDED = 'daily_transaction_limit_exceeded'
DELEGATION_EXPIRED = 'delegation_expired'
DELEGATION_NOT_AUTHORIZED = 'delegation_not_authorized'
DELEGATION_NOT_ENABLED = 'delegation_not_enabled'
DELEGATION_NOT_FOUND = 'delegation_not_found'
DELEGATION_REVOKED = 'delegation_revoked'
DOCUMENT_VERIFICATION_FAILED = 'document_verification_failed'
ENDPOINT_UNAVAILABLE = 'endpoint_unavailable'
ENTITY_NOT_CONFIGURED_FOR_PAYMENT_ACCEPTANCE = 'entity_not_configured_for_payment_acceptance'
FAUCET_LIMIT_EXCEEDED = 'faucet_limit_exceeded'
FORBIDDEN = 'forbidden'
GUEST_PERMISSION_DENIED = 'guest_permission_denied'
GUEST_REGION_FORBIDDEN = 'guest_region_forbidden'
GUEST_TRANSACTION_COUNT = 'guest_transaction_count'
GUEST_TRANSACTION_LIMIT = 'guest_transaction_limit'
IDEMPOTENCY_ERROR = 'idempotency_error'
INSUFFICIENT_ALLOWANCE = 'insufficient_allowance'
INSUFFICIENT_BALANCE = 'insufficient_balance'
INSUFFICIENT_LIQUIDITY = 'insufficient_liquidity'
INTERNAL_SERVER_ERROR = 'internal_server_error'
INVALID_REQUEST = 'invalid_request'
INVALID_SIGNATURE = 'invalid_signature'
INVALID_SQL_QUERY = 'invalid_sql_query'
MALFORMED_TRANSACTION = 'malformed_transaction'
METADATA_KEY_TOO_LONG = 'metadata_key_too_long'
METADATA_TOO_MANY_ENTRIES = 'metadata_too_many_entries'
METADATA_VALUE_TOO_LONG = 'metadata_value_too_long'
MFA_ALREADY_ENROLLED = 'mfa_already_enrolled'
MFA_FLOW_EXPIRED = 'mfa_flow_expired'
MFA_INVALID_CODE = 'mfa_invalid_code'
MFA_NOT_ENROLLED = 'mfa_not_enrolled'
MFA_REQUIRED = 'mfa_required'
MODERATION_REJECTED = 'moderation_rejected'
NETWORK_MISMATCH = 'network_mismatch'
NETWORK_NOT_TRADABLE = 'network_not_tradable'
NOT_FOUND = 'not_found'
NO_CAPTURABLE_BALANCE = 'no_capturable_balance'
NO_REFUNDABLE_BALANCE = 'no_refundable_balance'
NO_VOIDABLE_BALANCE = 'no_voidable_balance'
ORDER_ALREADY_CANCELED = 'order_already_canceled'
ORDER_ALREADY_FILLED = 'order_already_filled'
ORDER_QUOTE_EXPIRED = 'order_quote_expired'
OTP_VERIFICATION_CODE_INVALID = 'otp_verification_code_invalid'
OTP_VERIFICATION_DESTINATION_MISMATCH = 'otp_verification_destination_mismatch'
OTP_VERIFICATION_EXPIRED = 'otp_verification_expired'
OTP_VERIFICATION_INVALID = 'otp_verification_invalid'
OTP_VERIFICATION_NOT_FOUND = 'otp_verification_not_found'
OTP_VERIFICATION_REQUIRED = 'otp_verification_required'
PAYMENT_METHOD_REQUIRED = 'payment_method_required'
PAYMENT_REQUIRED = 'payment_required'
PAYMENT_SESSION_ACTION_PENDING = 'payment_session_action_pending'
PAYMENT_SESSION_ALREADY_AUTHORIZED = 'payment_session_already_authorized'
PAYMENT_SESSION_ALREADY_CANCELED = 'payment_session_already_canceled'
PHONE_NUMBER_VERIFICATION_EXPIRED = 'phone_number_verification_expired'
POLICY_IN_USE = 'policy_in_use'
POLICY_VIOLATION = 'policy_violation'
RATE_LIMIT_EXCEEDED = 'rate_limit_exceeded'
RECIPIENT_ALLOWLIST_PENDING = 'recipient_allowlist_pending'
RECIPIENT_ALLOWLIST_VIOLATION = 'recipient_allowlist_violation'
REFUND_EXPIRED = 'refund_expired'
REQUEST_CANCELED = 'request_canceled'
SERVICE_UNAVAILABLE = 'service_unavailable'
SETTLEMENT_FAILED = 'settlement_failed'
SOURCE_ACCOUNT_INVALID = 'source_account_invalid'
SOURCE_ACCOUNT_NOT_FOUND = 'source_account_not_found'
SOURCE_ASSET_NOT_SUPPORTED = 'source_asset_not_supported'
STALE_ATTESTATION = 'stale_attestation'
TARGET_ACCOUNT_INVALID = 'target_account_invalid'
TARGET_ACCOUNT_NOT_FOUND = 'target_account_not_found'
TARGET_ASSET_NOT_SUPPORTED = 'target_asset_not_supported'
TARGET_EMAIL_INVALID = 'target_email_invalid'
TARGET_ONCHAIN_ADDRESS_INVALID = 'target_onchain_address_invalid'
TIMED_OUT = 'timed_out'
TRANSACTION_SIMULATION_FAILED = 'transaction_simulation_failed'
TRANSFER_AMOUNT_INVALID = 'transfer_amount_invalid'
TRANSFER_ASSET_NOT_SUPPORTED = 'transfer_asset_not_supported'
TRANSFER_QUOTE_EXPIRED = 'transfer_quote_expired'
TRAVEL_RULES_FIELD_MISSING = 'travel_rules_field_missing'
TRAVEL_RULES_RECIPIENT_VIOLATION = 'travel_rules_recipient_violation'
UNAUTHORIZED = 'unauthorized'
UNSUPPORTED_TOS_LANGUAGE = 'unsupported_tos_language'
classmethod from_json(json_str)

Create an instance of ErrorType from a JSON string

Return type:

Self

cdp.openapi_client.models.eth_value_criterion 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.models.eth_value_criterion.EthValueCriterion(**data)

Bases: BaseModel

A schema for specifying a criterion for the value field of an EVM transaction.

eth_value: Annotated[str, Field(strict=True, max_length=78)]
classmethod eth_value_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of EthValueCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EthValueCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.event_type 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.models.event_type.EventType(value)

Bases: str, Enum

A webhook event type identifier following dot-separated format: <domain>.<entity>.<verb> (e.g., “onchain.activity.detected”).

OFFRAMP_DOT_TRANSACTION_DOT_CREATED = 'offramp.transaction.created'
OFFRAMP_DOT_TRANSACTION_DOT_FAILED = 'offramp.transaction.failed'
OFFRAMP_DOT_TRANSACTION_DOT_SUCCESS = 'offramp.transaction.success'
OFFRAMP_DOT_TRANSACTION_DOT_UPDATED = 'offramp.transaction.updated'
ONCHAIN_DOT_ACTIVITY_DOT_DETECTED = 'onchain.activity.detected'
ONRAMP_DOT_TRANSACTION_DOT_CREATED = 'onramp.transaction.created'
ONRAMP_DOT_TRANSACTION_DOT_FAILED = 'onramp.transaction.failed'
ONRAMP_DOT_TRANSACTION_DOT_SUCCESS = 'onramp.transaction.success'
ONRAMP_DOT_TRANSACTION_DOT_UPDATED = 'onramp.transaction.updated'
WALLET_DOT_ACTIVITY_DOT_DETECTED = 'wallet.activity.detected'
WALLET_DOT_ACTIVITY_DOT_MULTI = 'wallet.activity.multi'
WALLET_DOT_DELEGATION_DOT_CREATED = 'wallet.delegation.created'
WALLET_DOT_DELEGATION_DOT_REVOKED = 'wallet.delegation.revoked'
WALLET_DOT_HASH_DOT_SIGNED = 'wallet.hash.signed'
WALLET_DOT_MESSAGE_DOT_SIGNED = 'wallet.message.signed'
WALLET_DOT_TRANSACTION_DOT_BROADCAST = 'wallet.transaction.broadcast'
WALLET_DOT_TRANSACTION_DOT_CONFIRMED = 'wallet.transaction.confirmed'
WALLET_DOT_TRANSACTION_DOT_CREATED = 'wallet.transaction.created'
WALLET_DOT_TRANSACTION_DOT_FAILED = 'wallet.transaction.failed'
WALLET_DOT_TRANSACTION_DOT_PENDING = 'wallet.transaction.pending'
WALLET_DOT_TRANSACTION_DOT_REPLACED = 'wallet.transaction.replaced'
WALLET_DOT_TRANSACTION_DOT_SIGNED = 'wallet.transaction.signed'
WALLET_DOT_TYPED_DATA_DOT_SIGNED = 'wallet.typed_data.signed'
classmethod from_json(json_str)

Create an instance of EventType from a JSON string

Return type:

Self

cdp.openapi_client.models.evm_account 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.models.evm_account.EvmAccount(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

created_at: Optional[datetime]
classmethod from_dict(obj)

Create an instance of EvmAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

policies: Optional[List[Annotated[str, Field(strict=True)]]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: Optional[datetime]

cdp.openapi_client.models.evm_address_criterion 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.models.evm_address_criterion.EvmAddressCriterion(**data)

Bases: BaseModel

A schema for specifying a criterion for the to field of an EVM transaction.

addresses: List[Annotated[str, Field(strict=True)]]
classmethod from_dict(obj)

Create an instance of EvmAddressCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmAddressCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.evm_call 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.models.evm_call.EvmCall(**data)

Bases: BaseModel

data: Annotated[str, Field(strict=True)]
classmethod data_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of EvmCall from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmCall from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

override_gas_limit: Optional[StrictStr]
to: Annotated[str, Field(strict=True)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

classmethod to_validate_regular_expression(value)

Validates the regular expression

value: StrictStr

cdp.openapi_client.models.evm_data_condition 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.models.evm_data_condition.EvmDataCondition(**data)

Bases: BaseModel

A single condition to apply against the function and encoded arguments in the transaction’s data field. Each parameter configuration must be successfully evaluated against the corresponding function argument in order for a policy to be accepted.

classmethod from_dict(obj)

Create an instance of EvmDataCondition from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmDataCondition from a JSON string

Return type:

Optional[Self]

function: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

params: Optional[List[EvmDataConditionParamsInner]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.evm_data_condition_params_inner 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.models.evm_data_condition_params_inner.EvmDataConditionParamsInner(*args, **kwargs)

Bases: BaseModel

A list of parameter conditions to apply against encoded arguments in the transaction’s data field.

actual_instance: Optional[Union[EvmDataParameterCondition, EvmDataParameterConditionList]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[EvmDataParameterCondition]
oneof_schema_2_validator: Optional[EvmDataParameterConditionList]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], EvmDataParameterCondition, EvmDataParameterConditionList, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.evm_data_criterion 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.models.evm_data_criterion.EvmDataCriterion(**data)

Bases: BaseModel

A schema for specifying a criterion for the data field of an EVM transaction.

abi: EvmDataCriterionAbi
conditions: List[EvmDataCondition]
classmethod from_dict(obj)

Create an instance of EvmDataCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmDataCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.evm_data_criterion_abi 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.models.evm_data_criterion_abi.EvmDataCriterionAbi(*args, **kwargs)

Bases: BaseModel

The ABI of the smart contract being called. This can be a partial structure with only specific functions.

actual_instance: Optional[Union[KnownAbiType, List[AbiInner]]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[KnownAbiType]
oneof_schema_2_validator: Optional[List[AbiInner]]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], KnownAbiType, List[AbiInner], None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.evm_data_parameter_condition 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.models.evm_data_parameter_condition.EvmDataParameterCondition(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of EvmDataParameterCondition from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmDataParameterCondition from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr
operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

value: StrictStr

cdp.openapi_client.models.evm_data_parameter_condition_list 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.models.evm_data_parameter_condition_list.EvmDataParameterConditionList(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of EvmDataParameterConditionList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmDataParameterConditionList from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr
operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

values: List[StrictStr]

cdp.openapi_client.models.evm_eip7702_delegation_network 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.models.evm_eip7702_delegation_network.EvmEip7702DelegationNetwork(value)

Bases: str, Enum

The network for the EIP-7702 delegation.

ARBITRUM = 'arbitrum'
BASE = 'base'
BASE_MINUS_SEPOLIA = 'base-sepolia'
ETHEREUM = 'ethereum'
ETHEREUM_MINUS_SEPOLIA = 'ethereum-sepolia'
OPTIMISM = 'optimism'
POLYGON = 'polygon'
classmethod from_json(json_str)

Create an instance of EvmEip7702DelegationNetwork from a JSON string

Return type:

Self

cdp.openapi_client.models.evm_eip7702_delegation_operation 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.models.evm_eip7702_delegation_operation.EvmEip7702DelegationOperation(**data)

Bases: BaseModel

The status of an EIP-7702 delegation operation.

delegate_address: Optional[Annotated[str, Field(strict=True)]]
classmethod delegate_address_validate_regular_expression(value)

Validates the regular expression

delegation_operation_id: StrictStr
classmethod from_dict(obj)

Create an instance of EvmEip7702DelegationOperation from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmEip7702DelegationOperation from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: EvmEip7702DelegationNetwork
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: Optional[Annotated[str, Field(strict=True)]]
classmethod transaction_hash_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.evm_message_criterion 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.models.evm_message_criterion.EvmMessageCriterion(**data)

Bases: BaseModel

A schema for specifying a criterion for the message being signed.

classmethod from_dict(obj)

Create an instance of EvmMessageCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmMessageCriterion from a JSON string

Return type:

Optional[Self]

match: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.evm_network_criterion 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.models.evm_network_criterion.EvmNetworkCriterion(**data)

Bases: BaseModel

A schema for specifying a criterion for the intended network of an EVM transaction.

classmethod from_dict(obj)

Create an instance of EvmNetworkCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmNetworkCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

networks: List[StrictStr]
classmethod networks_validate_enum(value)

Validates the enum

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.evm_smart_account 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.models.evm_smart_account.EvmSmartAccount(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

created_at: Optional[datetime]
classmethod from_dict(obj)

Create an instance of EvmSmartAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmSmartAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

owners: List[Annotated[str, Field(strict=True)]]
policies: Optional[List[Annotated[str, Field(strict=True)]]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: Optional[datetime]

cdp.openapi_client.models.evm_swaps_network 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.models.evm_swaps_network.EvmSwapsNetwork(value)

Bases: str, Enum

The network on which to perform the swap.

ARBITRUM = 'arbitrum'
BASE = 'base'
ETHEREUM = 'ethereum'
OPTIMISM = 'optimism'
POLYGON = 'polygon'
classmethod from_json(json_str)

Create an instance of EvmSwapsNetwork from a JSON string

Return type:

Self

cdp.openapi_client.models.evm_typed_address_condition 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.models.evm_typed_address_condition.EvmTypedAddressCondition(**data)

Bases: BaseModel

A schema for specifying criterion for an address field of an EVM typed message. The address can be deeply nested within the typed data’s message.

addresses: List[Annotated[str, Field(strict=True)]]
classmethod from_dict(obj)

Create an instance of EvmTypedAddressCondition from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmTypedAddressCondition from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

path: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.evm_typed_numerical_condition 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.models.evm_typed_numerical_condition.EvmTypedNumericalCondition(**data)

Bases: BaseModel

A schema for specifying criterion for a numerical field of an EVM typed message. The value can be deeply nested within the typed data’s message.

classmethod from_dict(obj)

Create an instance of EvmTypedNumericalCondition from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmTypedNumericalCondition from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

path: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

value: Annotated[str, Field(strict=True)]
classmethod value_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.evm_typed_string_condition 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.models.evm_typed_string_condition.EvmTypedStringCondition(**data)

Bases: BaseModel

A schema for specifying criterion for a string field of an EVM typed message. The value can be deeply nested within the typed data’s message.

classmethod from_dict(obj)

Create an instance of EvmTypedStringCondition from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmTypedStringCondition from a JSON string

Return type:

Optional[Self]

match: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.evm_user_operation 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.models.evm_user_operation.EvmUserOperation(**data)

Bases: BaseModel

calls: List[EvmCall]
expires_at: Optional[datetime]
classmethod from_dict(obj)

Create an instance of EvmUserOperation from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EvmUserOperation from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: EvmUserOperationNetwork
receipts: Optional[List[UserOperationReceipt]]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: Optional[Annotated[str, Field(strict=True)]]
classmethod transaction_hash_validate_regular_expression(value)

Validates the regular expression

user_op_hash: Annotated[str, Field(strict=True)]
classmethod user_op_hash_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.evm_user_operation_network 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.models.evm_user_operation_network.EvmUserOperationNetwork(value)

Bases: str, Enum

The network the user operation is for.

ARBITRUM = 'arbitrum'
AVALANCHE = 'avalanche'
BASE = 'base'
BASE_MINUS_SEPOLIA = 'base-sepolia'
BNB = 'bnb'
ETHEREUM = 'ethereum'
ETHEREUM_MINUS_SEPOLIA = 'ethereum-sepolia'
OPTIMISM = 'optimism'
POLYGON = 'polygon'
ZORA = 'zora'
classmethod from_json(json_str)

Create an instance of EvmUserOperationNetwork from a JSON string

Return type:

Self

cdp.openapi_client.models.export_evm_account200_response 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.models.export_evm_account200_response.ExportEvmAccount200Response(**data)

Bases: BaseModel

encrypted_private_key: StrictStr
classmethod from_dict(obj)

Create an instance of ExportEvmAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ExportEvmAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.export_evm_account_request 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.models.export_evm_account_request.ExportEvmAccountRequest(**data)

Bases: BaseModel

export_encryption_key: StrictStr
classmethod from_dict(obj)

Create an instance of ExportEvmAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ExportEvmAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.export_solana_account200_response 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.models.export_solana_account200_response.ExportSolanaAccount200Response(**data)

Bases: BaseModel

encrypted_private_key: StrictStr
classmethod from_dict(obj)

Create an instance of ExportSolanaAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ExportSolanaAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.fedwire_details 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.models.fedwire_details.FedwireDetails(**data)

Bases: BaseModel

Details specific to Fedwire (domestic USD wire) payment methods.

account_last4: Annotated[str, Field(strict=True)]
classmethod account_last4_validate_regular_expression(value)

Validates the regular expression

asset: StrictStr
bank_name: StrictStr
classmethod from_dict(obj)

Create an instance of FedwireDetails from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FedwireDetails from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

routing_number: Annotated[str, Field(strict=True)]
classmethod routing_number_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.fedwire_payment_method 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.models.fedwire_payment_method.FedwirePaymentMethod(**data)

Bases: BaseModel

A Fedwire (domestic USD wire) payment method linked to your entity.

active: StrictBool
created_at: datetime
fedwire: FedwireDetails
classmethod from_dict(obj)

Create an instance of FedwirePaymentMethod from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FedwirePaymentMethod from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_method_id: Annotated[str, Field(strict=True)]
classmethod payment_method_id_validate_regular_expression(value)

Validates the regular expression

payment_rail: StrictStr
classmethod payment_rail_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: datetime

cdp.openapi_client.models.get_delegation_for_end_user200_response 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.models.get_delegation_for_end_user200_response.GetDelegationForEndUser200Response(**data)

Bases: BaseModel

expires_at: datetime
classmethod from_dict(obj)

Create an instance of GetDelegationForEndUser200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of GetDelegationForEndUser200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.get_onramp_order_by_id200_response 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.models.get_onramp_order_by_id200_response.GetOnrampOrderById200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of GetOnrampOrderById200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of GetOnrampOrderById200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order: OnrampOrder
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.get_onramp_user_limits200_response 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.models.get_onramp_user_limits200_response.GetOnrampUserLimits200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of GetOnrampUserLimits200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of GetOnrampUserLimits200Response from a JSON string

Return type:

Optional[Self]

limits: List[OnrampUserLimit]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.get_onramp_user_limits_request 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.models.get_onramp_user_limits_request.GetOnrampUserLimitsRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of GetOnrampUserLimitsRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of GetOnrampUserLimitsRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_method_type: OnrampOrderPaymentMethodTypeId
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr
user_id_type: OnrampUserIdType

cdp.openapi_client.models.get_swap_price_response 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.models.get_swap_price_response.GetSwapPriceResponse(**data)

Bases: BaseModel

block_number: Annotated[str, Field(strict=True)]
classmethod block_number_validate_regular_expression(value)

Validates the regular expression

fees: CommonSwapResponseFees
from_amount: Annotated[str, Field(strict=True)]
classmethod from_amount_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of GetSwapPriceResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of GetSwapPriceResponse from a JSON string

Return type:

Optional[Self]

from_token: Annotated[str, Field(strict=True)]
classmethod from_token_validate_regular_expression(value)

Validates the regular expression

gas: Annotated[str, Field(strict=True)]
gas_price: Annotated[str, Field(strict=True)]
classmethod gas_price_validate_regular_expression(value)

Validates the regular expression

classmethod gas_validate_regular_expression(value)

Validates the regular expression

issues: CommonSwapResponseIssues
liquidity_available: StrictBool
classmethod liquidity_available_validate_enum(value)

Validates the enum

min_to_amount: Annotated[str, Field(strict=True)]
classmethod min_to_amount_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_amount: Annotated[str, Field(strict=True)]
classmethod to_amount_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

to_token: Annotated[str, Field(strict=True)]
classmethod to_token_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.get_swap_price_response_wrapper 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.models.get_swap_price_response_wrapper.GetSwapPriceResponseWrapper(*args, **kwargs)

Bases: BaseModel

A wrapper for the response of a swap price operation.

actual_instance: Optional[Union[GetSwapPriceResponse, SwapUnavailableResponse]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[GetSwapPriceResponse]
oneof_schema_2_validator: Optional[SwapUnavailableResponse]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], GetSwapPriceResponse, SwapUnavailableResponse, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.idl 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.models.idl.Idl(**data)

Bases: BaseModel

IDL Specification following Anchor’s IDL format v0.30+.

address: StrictStr
classmethod from_dict(obj)

Create an instance of Idl from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Idl from a JSON string

Return type:

Optional[Self]

instructions: List[IdlInstructionsInner]
metadata: Optional[IdlMetadata]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

types: Optional[List[Dict[str, Any]]]

cdp.openapi_client.models.idl_instructions_inner 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.models.idl_instructions_inner.IdlInstructionsInner(**data)

Bases: BaseModel

accounts: Optional[List[IdlInstructionsInnerAccountsInner]]
args: List[IdlInstructionsInnerArgsInner]
discriminator: Annotated[List[Annotated[int, Field(le=255, strict=True, ge=0)]], Field(min_length=8, max_length=8)]
classmethod from_dict(obj)

Create an instance of IdlInstructionsInner from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of IdlInstructionsInner from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.idl_instructions_inner_accounts_inner 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.models.idl_instructions_inner_accounts_inner.IdlInstructionsInnerAccountsInner(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of IdlInstructionsInnerAccountsInner from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of IdlInstructionsInnerAccountsInner from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr
signer: Optional[StrictBool]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

writable: Optional[StrictBool]

cdp.openapi_client.models.idl_instructions_inner_args_inner 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.models.idl_instructions_inner_args_inner.IdlInstructionsInnerArgsInner(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of IdlInstructionsInnerArgsInner from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of IdlInstructionsInnerArgsInner from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr

cdp.openapi_client.models.idl_metadata 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.models.idl_metadata.IdlMetadata(**data)

Bases: BaseModel

Optional metadata about the IDL.

classmethod from_dict(obj)

Create an instance of IdlMetadata from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of IdlMetadata from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
spec: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

version: Optional[StrictStr]

cdp.openapi_client.models.import_end_user_request 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.models.import_end_user_request.ImportEndUserRequest(**data)

Bases: BaseModel

authentication_methods: List[AuthenticationMethod]
encrypted_private_key: StrictStr
classmethod from_dict(obj)

Create an instance of ImportEndUserRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ImportEndUserRequest from a JSON string

Return type:

Optional[Self]

key_type: StrictStr
classmethod key_type_validate_enum(value)

Validates the enum

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: Annotated[str, Field(strict=True)]
classmethod user_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.import_evm_account_request 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.models.import_evm_account_request.ImportEvmAccountRequest(**data)

Bases: BaseModel

account_policy: Optional[Annotated[str, Field(strict=True)]]
classmethod account_policy_validate_regular_expression(value)

Validates the regular expression

encrypted_private_key: StrictStr
classmethod from_dict(obj)

Create an instance of ImportEvmAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ImportEvmAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.import_solana_account_request 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.models.import_solana_account_request.ImportSolanaAccountRequest(**data)

Bases: BaseModel

encrypted_private_key: StrictStr
classmethod from_dict(obj)

Create an instance of ImportSolanaAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ImportSolanaAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.initiate_onramp_verification_request 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.models.initiate_onramp_verification_request.InitiateOnrampVerificationRequest(**data)

Bases: BaseModel

Request body for initiating an onramp OTP verification.

channel: StrictStr
classmethod channel_validate_enum(value)

Validates the enum

destination: InitiateOnrampVerificationRequestDestination
classmethod from_dict(obj)

Create an instance of InitiateOnrampVerificationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of InitiateOnrampVerificationRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.initiate_onramp_verification_request_destination 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.models.initiate_onramp_verification_request_destination.InitiateOnrampVerificationRequestDestination(*args, **kwargs)

Bases: BaseModel

The phone number or email address to send the OTP to.

actual_instance: Optional[Union[str]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[Annotated[str, Field(strict=True)]]
oneof_schema_2_validator: Optional[Annotated[str, Field(strict=True, max_length=254)]]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], str, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.inline_object 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.models.inline_object.InlineObject(**data)

Bases: BaseModel

extra: Optional[Dict[str, Any]]
classmethod from_dict(obj)

Create an instance of InlineObject from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of InlineObject from a JSON string

Return type:

Optional[Self]

invalid_message: Optional[StrictStr]
invalid_reason: Optional[X402VerifyInvalidReason]
is_valid: StrictBool
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payer: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.inline_object1 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.models.inline_object1.InlineObject1(**data)

Bases: BaseModel

amount: Optional[StrictStr]
error_message: Optional[StrictStr]
error_reason: Optional[X402SettleErrorReason]
extra: Optional[Dict[str, Any]]
classmethod from_dict(obj)

Create an instance of InlineObject1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of InlineObject1 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
payer: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
success: StrictBool
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: Annotated[str, Field(strict=True)]
classmethod transaction_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.inline_object2 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.models.inline_object2.InlineObject2(**data)

Bases: BaseModel

extensions: List[StrictStr]
classmethod from_dict(obj)

Create an instance of InlineObject2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of InlineObject2 from a JSON string

Return type:

Optional[Self]

kinds: List[X402SupportedPaymentKind]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signers: Dict[str, List[StrictStr]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.known_abi_type 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.models.known_abi_type.KnownAbiType(value)

Bases: str, Enum

A reference to an established EIP standard. When referencing a KnownAbiType within a policy rule configuring an EvmDataCriterion, criteria will only decode function data officially documented in the standard. For more information on supported token standards, see the links below. - [erc20 - Token Standard](https://eips.ethereum.org/EIPS/eip-20). - [erc721 - Non-Fungible Token Standard](https://eips.ethereum.org/EIPS/eip-721). - [erc1155 - Multi Token Standard](https://eips.ethereum.org/EIPS/eip-1155).

ERC1155 = 'erc1155'
ERC20 = 'erc20'
ERC721 = 'erc721'
classmethod from_json(json_str)

Create an instance of KnownAbiType from a JSON string

Return type:

Self

cdp.openapi_client.models.known_idl_type 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.models.known_idl_type.KnownIdlType(value)

Bases: str, Enum

A reference to an established Solana program. When referencing a KnownIdlType within a policy rule configuring an SolDataCriterion, criteria will decode instruction data as documented in the programs. For more information on supported programs, see the links below. - [SystemProgram](https://docs.rs/solana-program/latest/solana_program/system_instruction/enum.SystemInstruction.html). - [TokenProgram](https://docs.rs/spl-token/latest/spl_token/instruction/enum.TokenInstruction.html). - [AssociatedTokenProgram](https://docs.rs/spl-associated-token-account/latest/spl_associated_token_account/instruction/index.html).

ASSOCIATEDTOKENPROGRAM = 'AssociatedTokenProgram'
SYSTEMPROGRAM = 'SystemProgram'
TOKENPROGRAM = 'TokenProgram'
classmethod from_json(json_str)

Create an instance of KnownIdlType from a JSON string

Return type:

Self

cdp.openapi_client.models.list_balances200_response 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.models.list_balances200_response.ListBalances200Response(**data)

Bases: BaseModel

balances: List[Balance]
classmethod from_dict(obj)

Create an instance of ListBalances200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListBalances200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_deposit_destinations200_response 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.models.list_deposit_destinations200_response.ListDepositDestinations200Response(**data)

Bases: BaseModel

deposit_destinations: List[DepositDestination]
classmethod from_dict(obj)

Create an instance of ListDepositDestinations200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListDepositDestinations200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_end_users200_response 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.models.list_end_users200_response.ListEndUsers200Response(**data)

Bases: BaseModel

end_users: List[EndUser]
classmethod from_dict(obj)

Create an instance of ListEndUsers200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListEndUsers200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_evm_accounts200_response 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.models.list_evm_accounts200_response.ListEvmAccounts200Response(**data)

Bases: BaseModel

accounts: List[EvmAccount]
classmethod from_dict(obj)

Create an instance of ListEvmAccounts200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListEvmAccounts200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_evm_smart_accounts200_response 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.models.list_evm_smart_accounts200_response.ListEvmSmartAccounts200Response(**data)

Bases: BaseModel

accounts: List[EvmSmartAccount]
classmethod from_dict(obj)

Create an instance of ListEvmSmartAccounts200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListEvmSmartAccounts200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_evm_token_balances200_response 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.models.list_evm_token_balances200_response.ListEvmTokenBalances200Response(**data)

Bases: BaseModel

balances: List[TokenBalance]
classmethod from_dict(obj)

Create an instance of ListEvmTokenBalances200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListEvmTokenBalances200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_evm_token_balances_network 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.models.list_evm_token_balances_network.ListEvmTokenBalancesNetwork(value)

Bases: str, Enum

The name of the supported EVM networks in human-readable format.

BASE = 'base'
BASE_MINUS_SEPOLIA = 'base-sepolia'
ETHEREUM = 'ethereum'
classmethod from_json(json_str)

Create an instance of ListEvmTokenBalancesNetwork from a JSON string

Return type:

Self

cdp.openapi_client.models.list_foundation_accounts200_response 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.models.list_foundation_accounts200_response.ListFoundationAccounts200Response(**data)

Bases: BaseModel

accounts: List[Account]
classmethod from_dict(obj)

Create an instance of ListFoundationAccounts200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListFoundationAccounts200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_payment_methods200_response 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.models.list_payment_methods200_response.ListPaymentMethods200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of ListPaymentMethods200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListPaymentMethods200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
payment_methods: List[PaymentMethodsPaymentMethod]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_policies200_response 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.models.list_policies200_response.ListPolicies200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of ListPolicies200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListPolicies200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
policies: List[Policy]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_response 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.models.list_response.ListResponse(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of ListResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListResponse from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_solana_accounts200_response 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.models.list_solana_accounts200_response.ListSolanaAccounts200Response(**data)

Bases: BaseModel

accounts: List[SolanaAccount]
classmethod from_dict(obj)

Create an instance of ListSolanaAccounts200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListSolanaAccounts200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_solana_token_balances200_response 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.models.list_solana_token_balances200_response.ListSolanaTokenBalances200Response(**data)

Bases: BaseModel

balances: List[SolanaTokenBalance]
classmethod from_dict(obj)

Create an instance of ListSolanaTokenBalances200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListSolanaTokenBalances200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_solana_token_balances_network 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.models.list_solana_token_balances_network.ListSolanaTokenBalancesNetwork(value)

Bases: str, Enum

The name of the supported Solana networks in human-readable format.

SOLANA = 'solana'
SOLANA_MINUS_DEVNET = 'solana-devnet'
classmethod from_json(json_str)

Create an instance of ListSolanaTokenBalancesNetwork from a JSON string

Return type:

Self

cdp.openapi_client.models.list_spend_permissions200_response 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.models.list_spend_permissions200_response.ListSpendPermissions200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of ListSpendPermissions200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListSpendPermissions200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
spend_permissions: List[SpendPermissionResponseObject]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.list_transfers200_response 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.models.list_transfers200_response.ListTransfers200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of ListTransfers200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ListTransfers200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transfers: List[Transfer]

cdp.openapi_client.models.lookup_end_user200_response 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.models.lookup_end_user200_response.LookupEndUser200Response(**data)

Bases: BaseModel

end_users: List[EndUser]
classmethod from_dict(obj)

Create an instance of LookupEndUser200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of LookupEndUser200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.mfa_methods 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.models.mfa_methods.MFAMethods(**data)

Bases: BaseModel

Information about the end user’s MFA enrollments.

enrollment_prompted_at: Optional[datetime]
classmethod from_dict(obj)

Create an instance of MFAMethods from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of MFAMethods from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sms: Optional[MFAMethodsSms]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

totp: Optional[MFAMethodsTotp]

cdp.openapi_client.models.mfa_methods_sms 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.models.mfa_methods_sms.MFAMethodsSms(**data)

Bases: BaseModel

An object containing information about the end user’s SMS MFA enrollment.

enrolled_at: datetime
classmethod from_dict(obj)

Create an instance of MFAMethodsSms from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of MFAMethodsSms from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.mfa_methods_totp 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.models.mfa_methods_totp.MFAMethodsTotp(**data)

Bases: BaseModel

An object containing information about the end user’s TOTP enrollment.

enrolled_at: datetime
classmethod from_dict(obj)

Create an instance of MFAMethodsTotp from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of MFAMethodsTotp from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.mint_address_criterion 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.models.mint_address_criterion.MintAddressCriterion(**data)

Bases: BaseModel

The criterion for the token mint addresses of a Solana transaction’s SPL token transfer instructions.

addresses: List[Annotated[str, Field(strict=True)]]
classmethod from_dict(obj)

Create an instance of MintAddressCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of MintAddressCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.money_amount 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.models.money_amount.MoneyAmount(**data)

Bases: BaseModel

A monetary amount with currency.

currency: StrictStr
classmethod from_dict(obj)

Create an instance of MoneyAmount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of MoneyAmount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

value: StrictStr

cdp.openapi_client.models.net_usd_change_criterion 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.models.net_usd_change_criterion.NetUSDChangeCriterion(**data)

Bases: BaseModel

A schema for specifying a criterion for the USD denominated asset transfer or exposure for a transaction. This includes native transfers, as well as token transfers.

change_cents: StrictInt
classmethod from_dict(obj)

Create an instance of NetUSDChangeCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of NetUSDChangeCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.network 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.models.network.Network(value)

Bases: str, Enum

The blockchain network for the payment. Supported networks depend on the account type. See [API and Network Support](https://docs.cdp.coinbase.com/api-reference/payment-apis/supported-networks-assets#by-asset-and-network) for more details.

APTOS = 'aptos'
ARBITRUM = 'arbitrum'
ARBITRUM_MINUS_SEPOLIA = 'arbitrum-sepolia'
BASE = 'base'
ETHEREUM = 'ethereum'
OPTIMISM = 'optimism'
POLYGON = 'polygon'
SOLANA = 'solana'
WORLD = 'world'
WORLD_MINUS_SEPOLIA = 'world-sepolia'
classmethod from_json(json_str)

Create an instance of Network from a JSON string

Return type:

Self

cdp.openapi_client.models.o_auth2_authentication 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.models.o_auth2_authentication.OAuth2Authentication(**data)

Bases: BaseModel

Information about an end user who authenticates using a third-party provider.

email: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OAuth2Authentication from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OAuth2Authentication from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
sub: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: OAuth2ProviderType
username: Optional[StrictStr]

cdp.openapi_client.models.o_auth2_provider_type 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.models.o_auth2_provider_type.OAuth2ProviderType(value)

Bases: str, Enum

The type of OAuth2 provider.

APPLE = 'apple'
GITHUB = 'github'
GOOGLE = 'google'
TELEGRAM = 'telegram'
X = 'x'
classmethod from_json(json_str)

Create an instance of OAuth2ProviderType from a JSON string

Return type:

Self

cdp.openapi_client.models.offramp_transaction_created_event 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.models.offramp_transaction_created_event.OfframpTransactionCreatedEvent(**data)

Bases: BaseModel

asset: Optional[StrictStr]
coinbase_fee: Optional[MoneyAmount]
created_at: Optional[datetime]
event_type: StrictStr
exchange_rate: Optional[MoneyAmount]
from_address: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OfframpTransactionCreatedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OfframpTransactionCreatedEvent from a JSON string

Return type:

Optional[Self]

minimum_total: Optional[MoneyAmount]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

redirect_url: Optional[StrictStr]
sell_amount: Optional[MoneyAmount]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

subtotal: Optional[MoneyAmount]
to_address: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

total: Optional[MoneyAmount]
transaction_id: StrictStr
tx_hash: Optional[StrictStr]
unit_price: Optional[MoneyAmount]
updated_at: Optional[datetime]

cdp.openapi_client.models.offramp_transaction_failed_event 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.models.offramp_transaction_failed_event.OfframpTransactionFailedEvent(**data)

Bases: BaseModel

asset: Optional[StrictStr]
coinbase_fee: Optional[MoneyAmount]
created_at: Optional[datetime]
event_type: StrictStr
exchange_rate: Optional[MoneyAmount]
from_address: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OfframpTransactionFailedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OfframpTransactionFailedEvent from a JSON string

Return type:

Optional[Self]

minimum_total: Optional[MoneyAmount]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

redirect_url: Optional[StrictStr]
sell_amount: Optional[MoneyAmount]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

subtotal: Optional[MoneyAmount]
to_address: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

total: Optional[MoneyAmount]
transaction_id: StrictStr
tx_hash: Optional[StrictStr]
unit_price: Optional[MoneyAmount]
updated_at: Optional[datetime]

cdp.openapi_client.models.offramp_transaction_payload 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.models.offramp_transaction_payload.OfframpTransactionPayload(**data)

Bases: BaseModel

Webhook payload for offramp transactions. Serialized from the OfframpTransaction proto via protojson with eventType appended.

asset: Optional[StrictStr]
coinbase_fee: Optional[MoneyAmount]
created_at: Optional[datetime]
event_type: StrictStr
exchange_rate: Optional[MoneyAmount]
from_address: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OfframpTransactionPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OfframpTransactionPayload from a JSON string

Return type:

Optional[Self]

minimum_total: Optional[MoneyAmount]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

redirect_url: Optional[StrictStr]
sell_amount: Optional[MoneyAmount]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

subtotal: Optional[MoneyAmount]
to_address: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

total: Optional[MoneyAmount]
transaction_id: StrictStr
tx_hash: Optional[StrictStr]
unit_price: Optional[MoneyAmount]
updated_at: Optional[datetime]

cdp.openapi_client.models.offramp_transaction_success_event 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.models.offramp_transaction_success_event.OfframpTransactionSuccessEvent(**data)

Bases: BaseModel

asset: Optional[StrictStr]
coinbase_fee: Optional[MoneyAmount]
created_at: Optional[datetime]
event_type: StrictStr
exchange_rate: Optional[MoneyAmount]
from_address: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OfframpTransactionSuccessEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OfframpTransactionSuccessEvent from a JSON string

Return type:

Optional[Self]

minimum_total: Optional[MoneyAmount]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

redirect_url: Optional[StrictStr]
sell_amount: Optional[MoneyAmount]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

subtotal: Optional[MoneyAmount]
to_address: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

total: Optional[MoneyAmount]
transaction_id: StrictStr
tx_hash: Optional[StrictStr]
unit_price: Optional[MoneyAmount]
updated_at: Optional[datetime]

cdp.openapi_client.models.offramp_transaction_updated_event 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.models.offramp_transaction_updated_event.OfframpTransactionUpdatedEvent(**data)

Bases: BaseModel

asset: Optional[StrictStr]
coinbase_fee: Optional[MoneyAmount]
created_at: Optional[datetime]
event_type: StrictStr
exchange_rate: Optional[MoneyAmount]
from_address: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OfframpTransactionUpdatedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OfframpTransactionUpdatedEvent from a JSON string

Return type:

Optional[Self]

minimum_total: Optional[MoneyAmount]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

redirect_url: Optional[StrictStr]
sell_amount: Optional[MoneyAmount]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

subtotal: Optional[MoneyAmount]
to_address: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

total: Optional[MoneyAmount]
transaction_id: StrictStr
tx_hash: Optional[StrictStr]
unit_price: Optional[MoneyAmount]
updated_at: Optional[datetime]

cdp.openapi_client.models.onchain_activity_detected_event 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.models.onchain_activity_detected_event.OnchainActivityDetectedEvent(**data)

Bases: BaseModel

The payload delivered when onchain activity matching your subscription filters is detected. Each event corresponds to a single decoded contract log emitted onchain. The set of keys in parameters varies by the contract event being decoded (e.g., Transfer(address,address,uint256)).

block_number: StrictInt
contract_address: StrictStr
event_name: StrictStr
event_signature: StrictStr
classmethod from_dict(obj)

Create an instance of OnchainActivityDetectedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainActivityDetectedEvent from a JSON string

Return type:

Optional[Self]

log_index: StrictInt
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
parameters: Dict[str, StrictStr]
timestamp: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_from: StrictStr
transaction_hash: StrictStr
transaction_to: StrictStr

cdp.openapi_client.models.onchain_activity_event_data 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.models.onchain_activity_event_data.OnchainActivityEventData(**data)

Bases: BaseModel

Decoded blockchain event data for the wallet activity webhook. The exact fields depend on the type of onchain activity detected. Common fields include network, block info, and transaction hash. Additional fields are event-specific (e.g., from, to, value for transfers).

additional_properties: Dict[str, Any]
block_number: Optional[StrictStr]
block_timestamp: Optional[datetime]
contract_address: Optional[StrictStr]
event_name: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OnchainActivityEventData from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainActivityEventData from a JSON string

Return type:

Optional[Self]

log_index: Optional[StrictStr]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

  • Fields in self.additional_properties are added to the output dict.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.onchain_address 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.models.onchain_address.OnchainAddress(**data)

Bases: BaseModel

The target of the payment is an onchain address.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
asset: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
destination_tag: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OnchainAddress from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainAddress from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onchain_data_column_schema 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.models.onchain_data_column_schema.OnchainDataColumnSchema(**data)

Bases: BaseModel

Schema definition for a table column.

description: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]]
classmethod from_dict(obj)

Create an instance of OnchainDataColumnSchema from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainDataColumnSchema from a JSON string

Return type:

Optional[Self]

index_order: Optional[StrictInt]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
nullable: Optional[StrictBool]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: Optional[StrictStr]

cdp.openapi_client.models.onchain_data_query 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.models.onchain_data_query.OnchainDataQuery(**data)

Bases: BaseModel

Request to execute a SQL query against indexed blockchain data.

cache: Optional[QueryResultCacheConfiguration]
classmethod from_dict(obj)

Create an instance of OnchainDataQuery from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainDataQuery from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sql: Annotated[str, Field(min_length=1, strict=True, max_length=100000)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onchain_data_result 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.models.onchain_data_result.OnchainDataResult(**data)

Bases: BaseModel

Result of executing a SQL query.

classmethod from_dict(obj)

Create an instance of OnchainDataResult from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainDataResult from a JSON string

Return type:

Optional[Self]

metadata: Optional[OnchainDataResultMetadata]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[List[Dict[str, Any]]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

var_schema: Optional[OnchainDataResultSchema]

cdp.openapi_client.models.onchain_data_result_metadata 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.models.onchain_data_result_metadata.OnchainDataResultMetadata(**data)

Bases: BaseModel

Metadata about query execution.

cached: Optional[StrictBool]
execution_time_ms: Optional[StrictInt]
execution_timestamp: Optional[datetime]
classmethod from_dict(obj)

Create an instance of OnchainDataResultMetadata from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainDataResultMetadata from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

row_count: Optional[StrictInt]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onchain_data_result_schema 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.models.onchain_data_result_schema.OnchainDataResultSchema(**data)

Bases: BaseModel

Schema information for the query result. This is a derived schema from the query result, so types may not match the underlying table.

columns: Optional[List[OnchainDataResultSchemaColumnsInner]]
classmethod from_dict(obj)

Create an instance of OnchainDataResultSchema from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainDataResultSchema from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onchain_data_result_schema_columns_inner 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.models.onchain_data_result_schema_columns_inner.OnchainDataResultSchemaColumnsInner(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of OnchainDataResultSchemaColumnsInner from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainDataResultSchemaColumnsInner from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: Optional[StrictStr]
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.onchain_data_schema_response 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.models.onchain_data_schema_response.OnchainDataSchemaResponse(**data)

Bases: BaseModel

Schema information for available blockchain data tables.

classmethod from_dict(obj)

Create an instance of OnchainDataSchemaResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainDataSchemaResponse from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tables: Optional[List[OnchainDataTableSchema]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onchain_data_table_schema 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.models.onchain_data_table_schema.OnchainDataTableSchema(**data)

Bases: BaseModel

Schema definition for a data table.

columns: Optional[List[OnchainDataColumnSchema]]
database: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OnchainDataTableSchema from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainDataTableSchema from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

table: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onramp_limit_type 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.models.onramp_limit_type.OnrampLimitType(value)

Bases: str, Enum

The type of limit: - weekly_spending: Rolling 7-day spending limit. The limit applies to the sum of all completed transactions within a sliding 168-hour (7-day) window. As time passes, older transactions naturally expire from the window. $500 is the default limit. - lifetime_transactions: All-time transaction count limit. Tracks the total number of completed transactions across the user’s entire history with no time-based expiration. Once the limit is reached, no further transactions are allowed. 15 is the default limit.

LIFETIME_TRANSACTIONS = 'lifetime_transactions'
WEEKLY_SPENDING = 'weekly_spending'
classmethod from_json(json_str)

Create an instance of OnrampLimitType from a JSON string

Return type:

Self

cdp.openapi_client.models.onramp_limit_upgrade_identity_fields 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.models.onramp_limit_upgrade_identity_fields.OnrampLimitUpgradeIdentityFields(**data)

Bases: BaseModel

Populate the properties that correspond to the fields array from the user’s OnrampLimitUpgradeOption.

date_of_birth: Optional[DateOfBirth]
classmethod from_dict(obj)

Create an instance of OnrampLimitUpgradeIdentityFields from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampLimitUpgradeIdentityFields from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

ssn_last4: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onramp_limit_upgrade_request 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.models.onramp_limit_upgrade_request.OnrampLimitUpgradeRequest(**data)

Bases: BaseModel

Request to request a limits upgrade for a user.

fields: Optional[OnrampLimitUpgradeIdentityFields]
classmethod from_dict(obj)

Create an instance of OnrampLimitUpgradeRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampLimitUpgradeRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr
user_id_type: OnrampUserIdType

cdp.openapi_client.models.onramp_order 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.models.onramp_order.OnrampOrder(**data)

Bases: BaseModel

An Onramp order.

created_at: StrictStr
destination_address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
destination_network: StrictStr
exchange_rate: StrictStr
fees: List[OnrampOrderFee]
classmethod from_dict(obj)

Create an instance of OnrampOrder from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampOrder from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order_id: StrictStr
partner_user_ref: Optional[StrictStr]
payment_currency: StrictStr
payment_method: OnrampOrderPaymentMethodTypeId
payment_subtotal: StrictStr
payment_total: StrictStr
purchase_amount: StrictStr
purchase_currency: StrictStr
status: OnrampOrderStatus
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

tx_hash: Optional[StrictStr]
updated_at: StrictStr

cdp.openapi_client.models.onramp_order_fee 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.models.onramp_order_fee.OnrampOrderFee(**data)

Bases: BaseModel

A fee associated with an order.

amount: StrictStr
currency: StrictStr
classmethod from_dict(obj)

Create an instance of OnrampOrderFee from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampOrderFee from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.onramp_order_payload 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.models.onramp_order_payload.OnrampOrderPayload(**data)

Bases: BaseModel

Webhook payload for Headless Onramp API orders (Apple Pay / Google Pay). Serialized from the OnrampOrder proto via protojson with eventType appended.

created_at: Optional[datetime]
destination_address: Optional[StrictStr]
destination_network: Optional[StrictStr]
event_type: StrictStr
exchange_rate: Optional[StrictStr]
fees: Optional[List[OrderFee]]
classmethod from_dict(obj)

Create an instance of OnrampOrderPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampOrderPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order_id: StrictStr
partner_user_ref: Optional[StrictStr]
payment_currency: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

payment_subtotal: Optional[StrictStr]
payment_total: Optional[StrictStr]
purchase_amount: Optional[StrictStr]
purchase_currency: Optional[StrictStr]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

tx_hash: Optional[StrictStr]
updated_at: Optional[datetime]

cdp.openapi_client.models.onramp_order_payment_method_type_id 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.models.onramp_order_payment_method_type_id.OnrampOrderPaymentMethodTypeId(value)

Bases: str, Enum

The type of payment method to be used to complete an onramp order.

GUEST_CHECKOUT_APPLE_PAY = 'GUEST_CHECKOUT_APPLE_PAY'
GUEST_CHECKOUT_GOOGLE_PAY = 'GUEST_CHECKOUT_GOOGLE_PAY'
classmethod from_json(json_str)

Create an instance of OnrampOrderPaymentMethodTypeId from a JSON string

Return type:

Self

cdp.openapi_client.models.onramp_order_status 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.models.onramp_order_status.OnrampOrderStatus(value)

Bases: str, Enum

The status of an onramp order.

ONRAMP_ORDER_STATUS_COMPLETED = 'ONRAMP_ORDER_STATUS_COMPLETED'
ONRAMP_ORDER_STATUS_FAILED = 'ONRAMP_ORDER_STATUS_FAILED'
ONRAMP_ORDER_STATUS_PENDING_AUTH = 'ONRAMP_ORDER_STATUS_PENDING_AUTH'
ONRAMP_ORDER_STATUS_PENDING_PAYMENT = 'ONRAMP_ORDER_STATUS_PENDING_PAYMENT'
ONRAMP_ORDER_STATUS_PROCESSING = 'ONRAMP_ORDER_STATUS_PROCESSING'
classmethod from_json(json_str)

Create an instance of OnrampOrderStatus from a JSON string

Return type:

Self

cdp.openapi_client.models.onramp_quote 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.models.onramp_quote.OnrampQuote(**data)

Bases: BaseModel

Quote information with pricing details for the crypto purchase.

destination_network: StrictStr
exchange_rate: StrictStr
fees: List[OnrampOrderFee]
classmethod from_dict(obj)

Create an instance of OnrampQuote from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampQuote from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_currency: StrictStr
payment_subtotal: StrictStr
payment_total: StrictStr
purchase_amount: StrictStr
purchase_currency: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onramp_quote_payment_method_type_id 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.models.onramp_quote_payment_method_type_id.OnrampQuotePaymentMethodTypeId(value)

Bases: str, Enum

The type of payment method used to generate the onramp quote.

ACH = 'ACH'
APPLE_PAY = 'APPLE_PAY'
CARD = 'CARD'
CRYPTO_WALLET = 'CRYPTO_WALLET'
FIAT_WALLET = 'FIAT_WALLET'
PAYPAL = 'PAYPAL'
classmethod from_json(json_str)

Create an instance of OnrampQuotePaymentMethodTypeId from a JSON string

Return type:

Self

cdp.openapi_client.models.onramp_session 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.models.onramp_session.OnrampSession(**data)

Bases: BaseModel

An onramp session containing a ready-to-use onramp URL.

classmethod from_dict(obj)

Create an instance of OnrampSession from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampSession from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

onramp_url: Annotated[str, Field(min_length=11, strict=True, max_length=2048)]
classmethod onramp_url_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onramp_session_request 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.models.onramp_session_request.OnrampSessionRequest(**data)

Bases: BaseModel

Common request parameters shared by [Create Onramp Session](#operation/createOnrampSession) and [Create Onramp Mobile Challenge](#operation/createOnrampMobileChallenge).

client_ip: Optional[StrictStr]
country: Optional[StrictStr]
destination_address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
destination_network: StrictStr
classmethod from_dict(obj)

Create an instance of OnrampSessionRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampSessionRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

partner_user_ref: Optional[StrictStr]
payment_amount: Optional[StrictStr]
payment_currency: Optional[StrictStr]
payment_method: Optional[OnrampQuotePaymentMethodTypeId]
purchase_amount: Optional[StrictStr]
purchase_currency: StrictStr
redirect_url: Optional[Annotated[str, Field(min_length=5, strict=True, max_length=2048)]]
classmethod redirect_url_validate_regular_expression(value)

Validates the regular expression

subdivision: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onramp_transaction_created_event 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.models.onramp_transaction_created_event.OnrampTransactionCreatedEvent(**data)

Bases: BaseModel

coinbase_fee: Optional[MoneyAmount]
completed_at: Optional[datetime]
contract_address: Optional[StrictStr]
country: Optional[StrictStr]
created_at: Optional[datetime]
destination_address: Optional[StrictStr]
destination_network: Optional[StrictStr]
end_partner_name: Optional[StrictStr]
error_code: Optional[StrictStr]
event_type: StrictStr
exchange_rate: Optional[StrictStr]
failure_reason: Optional[StrictStr]
classmethod failure_reason_validate_enum(value)

Validates the enum

fees: Optional[List[OrderFee]]
classmethod from_dict(obj)

Create an instance of OnrampTransactionCreatedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampTransactionCreatedEvent from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network_fee: Optional[MoneyAmount]
order_id: StrictStr
partner_user_ref: Optional[StrictStr]
payment_currency: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

payment_subtotal: Optional[StrictStr]
payment_total: Optional[StrictStr]
payment_total_usd: Optional[MoneyAmount]
purchase_amount: Optional[StrictStr]
purchase_currency: Optional[StrictStr]
purchase_network: Optional[StrictStr]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_id: StrictStr
tx_hash: Optional[StrictStr]
type: Optional[StrictStr]
classmethod type_validate_enum(value)

Validates the enum

updated_at: Optional[datetime]
user_id: Optional[StrictStr]
user_type: Optional[StrictStr]
classmethod user_type_validate_enum(value)

Validates the enum

wallet_address: Optional[StrictStr]

cdp.openapi_client.models.onramp_transaction_event 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.models.onramp_transaction_event.OnrampTransactionEvent(*args, **kwargs)

Bases: BaseModel

Webhook payload for all onramp transaction events (created, updated, success, failed). Shape depends on transaction type — standard flow (guest checkout / authorized) uses OnrampTransactionPayload, Headless API (Apple Pay / Google Pay) uses OnrampOrderPayload. Distinguish by presence of orderId (Headless) vs transactionId (standard).

actual_instance: Optional[Union[OnrampOrderPayload, OnrampTransactionPayload]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[OnrampTransactionPayload]
oneof_schema_2_validator: Optional[OnrampOrderPayload]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], OnrampOrderPayload, OnrampTransactionPayload, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.onramp_transaction_failed_event 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.models.onramp_transaction_failed_event.OnrampTransactionFailedEvent(**data)

Bases: BaseModel

coinbase_fee: Optional[MoneyAmount]
completed_at: Optional[datetime]
contract_address: Optional[StrictStr]
country: Optional[StrictStr]
created_at: Optional[datetime]
destination_address: Optional[StrictStr]
destination_network: Optional[StrictStr]
end_partner_name: Optional[StrictStr]
error_code: Optional[StrictStr]
event_type: StrictStr
exchange_rate: Optional[StrictStr]
failure_reason: Optional[StrictStr]
classmethod failure_reason_validate_enum(value)

Validates the enum

fees: Optional[List[OrderFee]]
classmethod from_dict(obj)

Create an instance of OnrampTransactionFailedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampTransactionFailedEvent from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network_fee: Optional[MoneyAmount]
order_id: StrictStr
partner_user_ref: Optional[StrictStr]
payment_currency: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

payment_subtotal: Optional[StrictStr]
payment_total: Optional[StrictStr]
payment_total_usd: Optional[MoneyAmount]
purchase_amount: Optional[StrictStr]
purchase_currency: Optional[StrictStr]
purchase_network: Optional[StrictStr]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_id: StrictStr
tx_hash: Optional[StrictStr]
type: Optional[StrictStr]
classmethod type_validate_enum(value)

Validates the enum

updated_at: Optional[datetime]
user_id: Optional[StrictStr]
user_type: Optional[StrictStr]
classmethod user_type_validate_enum(value)

Validates the enum

wallet_address: Optional[StrictStr]

cdp.openapi_client.models.onramp_transaction_payload 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.models.onramp_transaction_payload.OnrampTransactionPayload(**data)

Bases: BaseModel

Webhook payload for standard onramp transactions (guest checkout and authed flow). Serialized from the OnrampTransaction proto via protojson with eventType appended.

coinbase_fee: Optional[MoneyAmount]
completed_at: Optional[datetime]
contract_address: Optional[StrictStr]
country: Optional[StrictStr]
created_at: Optional[datetime]
end_partner_name: Optional[StrictStr]
error_code: Optional[StrictStr]
event_type: StrictStr
exchange_rate: Optional[MoneyAmount]
failure_reason: Optional[StrictStr]
classmethod failure_reason_validate_enum(value)

Validates the enum

classmethod from_dict(obj)

Create an instance of OnrampTransactionPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampTransactionPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network_fee: Optional[MoneyAmount]
partner_user_ref: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

payment_subtotal: Optional[MoneyAmount]
payment_total: Optional[MoneyAmount]
payment_total_usd: Optional[MoneyAmount]
purchase_amount: Optional[MoneyAmount]
purchase_currency: Optional[StrictStr]
purchase_network: Optional[StrictStr]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_id: StrictStr
tx_hash: Optional[StrictStr]
type: Optional[StrictStr]
classmethod type_validate_enum(value)

Validates the enum

user_id: Optional[StrictStr]
user_type: Optional[StrictStr]
classmethod user_type_validate_enum(value)

Validates the enum

wallet_address: Optional[StrictStr]

cdp.openapi_client.models.onramp_transaction_success_event 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.models.onramp_transaction_success_event.OnrampTransactionSuccessEvent(**data)

Bases: BaseModel

coinbase_fee: Optional[MoneyAmount]
completed_at: Optional[datetime]
contract_address: Optional[StrictStr]
country: Optional[StrictStr]
created_at: Optional[datetime]
destination_address: Optional[StrictStr]
destination_network: Optional[StrictStr]
end_partner_name: Optional[StrictStr]
error_code: Optional[StrictStr]
event_type: StrictStr
exchange_rate: Optional[StrictStr]
failure_reason: Optional[StrictStr]
classmethod failure_reason_validate_enum(value)

Validates the enum

fees: Optional[List[OrderFee]]
classmethod from_dict(obj)

Create an instance of OnrampTransactionSuccessEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampTransactionSuccessEvent from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network_fee: Optional[MoneyAmount]
order_id: StrictStr
partner_user_ref: Optional[StrictStr]
payment_currency: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

payment_subtotal: Optional[StrictStr]
payment_total: Optional[StrictStr]
payment_total_usd: Optional[MoneyAmount]
purchase_amount: Optional[StrictStr]
purchase_currency: Optional[StrictStr]
purchase_network: Optional[StrictStr]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_id: StrictStr
tx_hash: Optional[StrictStr]
type: Optional[StrictStr]
classmethod type_validate_enum(value)

Validates the enum

updated_at: Optional[datetime]
user_id: Optional[StrictStr]
user_type: Optional[StrictStr]
classmethod user_type_validate_enum(value)

Validates the enum

wallet_address: Optional[StrictStr]

cdp.openapi_client.models.onramp_transaction_updated_event 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.models.onramp_transaction_updated_event.OnrampTransactionUpdatedEvent(**data)

Bases: BaseModel

coinbase_fee: Optional[MoneyAmount]
completed_at: Optional[datetime]
contract_address: Optional[StrictStr]
country: Optional[StrictStr]
created_at: Optional[datetime]
destination_address: Optional[StrictStr]
destination_network: Optional[StrictStr]
end_partner_name: Optional[StrictStr]
error_code: Optional[StrictStr]
event_type: StrictStr
exchange_rate: Optional[StrictStr]
failure_reason: Optional[StrictStr]
classmethod failure_reason_validate_enum(value)

Validates the enum

fees: Optional[List[OrderFee]]
classmethod from_dict(obj)

Create an instance of OnrampTransactionUpdatedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampTransactionUpdatedEvent from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network_fee: Optional[MoneyAmount]
order_id: StrictStr
partner_user_ref: Optional[StrictStr]
payment_currency: Optional[StrictStr]
payment_method: Optional[StrictStr]
classmethod payment_method_validate_enum(value)

Validates the enum

payment_subtotal: Optional[StrictStr]
payment_total: Optional[StrictStr]
payment_total_usd: Optional[MoneyAmount]
purchase_amount: Optional[StrictStr]
purchase_currency: Optional[StrictStr]
purchase_network: Optional[StrictStr]
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_id: StrictStr
tx_hash: Optional[StrictStr]
type: Optional[StrictStr]
classmethod type_validate_enum(value)

Validates the enum

updated_at: Optional[datetime]
user_id: Optional[StrictStr]
user_type: Optional[StrictStr]
classmethod user_type_validate_enum(value)

Validates the enum

wallet_address: Optional[StrictStr]

cdp.openapi_client.models.onramp_user_id_type 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.models.onramp_user_id_type.OnrampUserIdType(value)

Bases: str, Enum

The type of user identifier: - phone_number: A phone number in E.164 format associated with an onramp user.

PHONE_NUMBER = 'phone_number'
classmethod from_json(json_str)

Create an instance of OnrampUserIdType from a JSON string

Return type:

Self

cdp.openapi_client.models.onramp_user_limit 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.models.onramp_user_limit.OnrampUserLimit(**data)

Bases: BaseModel

A single limit with remaining capacity.

currency: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of OnrampUserLimit from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampUserLimit from a JSON string

Return type:

Optional[Self]

limit: StrictStr
limit_type: OnrampLimitType
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

remaining: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.onramp_verification_confirmation 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.models.onramp_verification_confirmation.OnrampVerificationConfirmation(**data)

Bases: BaseModel

The result of successfully submitting an onramp OTP verification.

classmethod from_dict(obj)

Create an instance of OnrampVerificationConfirmation from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampVerificationConfirmation from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

verification_expires_at: datetime
verification_id: Annotated[str, Field(strict=True)]
classmethod verification_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.onramp_verification_initiation 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.models.onramp_verification_initiation.OnrampVerificationInitiation(**data)

Bases: BaseModel

The result of initiating an onramp OTP verification.

classmethod from_dict(obj)

Create an instance of OnrampVerificationInitiation from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnrampVerificationInitiation from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

otp_expires_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

verification_id: Annotated[str, Field(strict=True)]
classmethod verification_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.order_fee 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.models.order_fee.OrderFee(**data)

Bases: BaseModel

A fee associated with a Headless Onramp API order.

fee_amount: Optional[StrictStr]
fee_currency: Optional[StrictStr]
fee_type: Optional[StrictStr]
classmethod fee_type_validate_enum(value)

Validates the enum

classmethod from_dict(obj)

Create an instance of OrderFee from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OrderFee from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.originating_bank_account_us 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.models.originating_bank_account_us.OriginatingBankAccountUS(**data)

Bases: BaseModel

The originating US bank account details for the transfer source. Present when funds were deposited from an external bank account into a deposit destination. Only the last 4 digits of the account number are exposed.

account_last4: Annotated[str, Field(strict=True)]
classmethod account_last4_validate_regular_expression(value)

Validates the regular expression

bank_name: StrictStr
currency: StrictStr
classmethod from_dict(obj)

Create an instance of OriginatingBankAccountUS from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OriginatingBankAccountUS from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.payment_method 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.models.payment_method.PaymentMethod(**data)

Bases: BaseModel

The Payment Method specific details for the transfer.

asset: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
classmethod from_dict(obj)

Create an instance of PaymentMethod from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of PaymentMethod from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_method_id: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.payment_method_base 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.models.payment_method_base.PaymentMethodBase(**data)

Bases: BaseModel

Common properties shared by all payment method types.

active: StrictBool
created_at: datetime
classmethod from_dict(obj)

Create an instance of PaymentMethodBase from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of PaymentMethodBase from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_method_id: Annotated[str, Field(strict=True)]
classmethod payment_method_id_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: datetime

cdp.openapi_client.models.payment_methods_payment_method 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.models.payment_methods_payment_method.PaymentMethodsPaymentMethod(*args, **kwargs)

Bases: BaseModel

A payment method linked to your entity. Payment methods represent external financial instruments that can be used as a target for transfers. The paymentRail field indicates which type-specific details object is present. Type-specific fields are nested under a key matching the rail name (e.g., fedwire, swift).

actual_instance: Optional[Union[FedwirePaymentMethod, SepaPaymentMethod, SwiftPaymentMethod]]
classmethod actual_instance_must_validate_oneof(v)
discriminator_value_class_map: Dict[str, str]
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[FedwirePaymentMethod]
oneof_schema_2_validator: Optional[SwiftPaymentMethod]
oneof_schema_3_validator: Optional[SepaPaymentMethod]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], FedwirePaymentMethod, SepaPaymentMethod, SwiftPaymentMethod, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.physical_address 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.models.physical_address.PhysicalAddress(**data)

Bases: BaseModel

A physical address with standard address components including street, city, state/province, postal code, and country.

city: Optional[StrictStr]
country_code: Optional[Annotated[str, Field(min_length=2, strict=True, max_length=2)]]
classmethod from_dict(obj)

Create an instance of PhysicalAddress from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of PhysicalAddress from a JSON string

Return type:

Optional[Self]

line1: Optional[StrictStr]
line2: Optional[StrictStr]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

post_code: Optional[StrictStr]
state: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.policy 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.models.policy.Policy(**data)

Bases: BaseModel

created_at: StrictStr
description: Optional[Annotated[str, Field(strict=True)]]
classmethod description_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of Policy from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Policy from a JSON string

Return type:

Optional[Self]

id: Annotated[str, Field(strict=True)]
classmethod id_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rules: List[Rule]
scope: StrictStr
classmethod scope_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: StrictStr

cdp.openapi_client.models.prepare_and_send_user_operation_request 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.models.prepare_and_send_user_operation_request.PrepareAndSendUserOperationRequest(**data)

Bases: BaseModel

calls: List[EvmCall]
classmethod from_dict(obj)

Create an instance of PrepareAndSendUserOperationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of PrepareAndSendUserOperationRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: EvmUserOperationNetwork
paymaster_context: Optional[Dict[str, Any]]
paymaster_url: Optional[Annotated[str, Field(min_length=11, strict=True, max_length=2048)]]
classmethod paymaster_url_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.prepare_user_operation_request 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.models.prepare_user_operation_request.PrepareUserOperationRequest(**data)

Bases: BaseModel

calls: List[EvmCall]
data_suffix: Optional[Annotated[str, Field(strict=True)]]
classmethod data_suffix_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of PrepareUserOperationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of PrepareUserOperationRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: EvmUserOperationNetwork
paymaster_context: Optional[Dict[str, Any]]
paymaster_url: Optional[Annotated[str, Field(min_length=11, strict=True, max_length=2048)]]
classmethod paymaster_url_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.prepare_user_operation_rule 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.models.prepare_user_operation_rule.PrepareUserOperationRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendEvmTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of PrepareUserOperationRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of PrepareUserOperationRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.program_id_criterion 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.models.program_id_criterion.ProgramIdCriterion(**data)

Bases: BaseModel

The criterion for the program IDs of a Solana transaction’s instructions.

classmethod from_dict(obj)

Create an instance of ProgramIdCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ProgramIdCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

program_ids: List[Annotated[str, Field(strict=True)]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.query_result_cache_configuration 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.models.query_result_cache_configuration.QueryResultCacheConfiguration(**data)

Bases: BaseModel

Enables control over how often queries need to be fully re-executed on the backing store. This can be useful in scenarios where API calls might be made frequently, API latency is critical, and some freshness lag (ex: 750ms, 2s, 5s) is tolerable. By default, each query result is returned from cache so long as the result is from an identical query and less than 500ms old. This freshness tolerance can be modified upwards, to a maximum of 900000ms (i.e. 900s, 15m).

classmethod from_dict(obj)

Create an instance of QueryResultCacheConfiguration from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of QueryResultCacheConfiguration from a JSON string

Return type:

Optional[Self]

max_age_ms: Optional[Annotated[int, Field(le=900000, strict=True, ge=500)]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.request_evm_faucet200_response 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.models.request_evm_faucet200_response.RequestEvmFaucet200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of RequestEvmFaucet200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RequestEvmFaucet200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.request_evm_faucet_request 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.models.request_evm_faucet_request.RequestEvmFaucetRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of RequestEvmFaucetRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RequestEvmFaucetRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
classmethod network_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: StrictStr
classmethod token_validate_enum(value)

Validates the enum

cdp.openapi_client.models.request_solana_faucet200_response 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.models.request_solana_faucet200_response.RequestSolanaFaucet200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of RequestSolanaFaucet200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RequestSolanaFaucet200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr

cdp.openapi_client.models.request_solana_faucet_request 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.models.request_solana_faucet_request.RequestSolanaFaucetRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of RequestSolanaFaucetRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RequestSolanaFaucetRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: StrictStr
classmethod token_validate_enum(value)

Validates the enum

cdp.openapi_client.models.revoke_delegation_for_end_user_request 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.models.revoke_delegation_for_end_user_request.RevokeDelegationForEndUserRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of RevokeDelegationForEndUserRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RevokeDelegationForEndUserRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.revoke_spend_permission_request 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.models.revoke_spend_permission_request.RevokeSpendPermissionRequest(**data)

Bases: BaseModel

Request parameters for revoking a Spend Permission.

classmethod from_dict(obj)

Create an instance of RevokeSpendPermissionRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RevokeSpendPermissionRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: SpendPermissionNetwork
paymaster_url: Optional[Annotated[str, Field(min_length=11, strict=True, max_length=2048)]]
classmethod paymaster_url_validate_regular_expression(value)

Validates the regular expression

permission_hash: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.rule 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.models.rule.Rule(*args, **kwargs)

Bases: BaseModel

A rule that limits the behavior of an account.

actual_instance: Optional[Union[CreateEndUserEvmSwapRule, PrepareUserOperationRule, SendEndUserEvmAssetRule, SendEndUserEvmTransactionRule, SendEndUserOperationRule, SendEndUserSolAssetRule, SendEndUserSolTransactionRule, SendEvmTransactionRule, SendSolTransactionRule, SendUserOperationRule, SignEndUserEvmHashRule, SignEndUserEvmMessageRule, SignEndUserEvmTransactionRule, SignEndUserEvmTypedDataRule, SignEndUserSolMessageRule, SignEndUserSolTransactionRule, SignEvmHashRule, SignEvmMessageRule, SignEvmTransactionRule, SignEvmTypedDataRule, SignSolMessageRule, SignSolTransactionRule]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_10_validator: Optional[SendUserOperationRule]
oneof_schema_11_validator: Optional[SignEndUserEvmTransactionRule]
oneof_schema_12_validator: Optional[SendEndUserEvmTransactionRule]
oneof_schema_13_validator: Optional[SignEndUserEvmMessageRule]
oneof_schema_14_validator: Optional[SignEndUserEvmTypedDataRule]
oneof_schema_15_validator: Optional[SignEndUserEvmHashRule]
oneof_schema_16_validator: Optional[SignEndUserSolTransactionRule]
oneof_schema_17_validator: Optional[SendEndUserSolTransactionRule]
oneof_schema_18_validator: Optional[SignEndUserSolMessageRule]
oneof_schema_19_validator: Optional[SendEndUserEvmAssetRule]
oneof_schema_1_validator: Optional[SignEvmTransactionRule]
oneof_schema_20_validator: Optional[SendEndUserSolAssetRule]
oneof_schema_21_validator: Optional[SendEndUserOperationRule]
oneof_schema_22_validator: Optional[CreateEndUserEvmSwapRule]
oneof_schema_2_validator: Optional[SendEvmTransactionRule]
oneof_schema_3_validator: Optional[SignEvmMessageRule]
oneof_schema_4_validator: Optional[SignEvmTypedDataRule]
oneof_schema_5_validator: Optional[SignSolTransactionRule]
oneof_schema_6_validator: Optional[SendSolTransactionRule]
oneof_schema_7_validator: Optional[SignSolMessageRule]
oneof_schema_8_validator: Optional[SignEvmHashRule]
oneof_schema_9_validator: Optional[PrepareUserOperationRule]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], CreateEndUserEvmSwapRule, PrepareUserOperationRule, SendEndUserEvmAssetRule, SendEndUserEvmTransactionRule, SendEndUserOperationRule, SendEndUserSolAssetRule, SendEndUserSolTransactionRule, SendEvmTransactionRule, SendSolTransactionRule, SendUserOperationRule, SignEndUserEvmHashRule, SignEndUserEvmMessageRule, SignEndUserEvmTransactionRule, SignEndUserEvmTypedDataRule, SignEndUserSolMessageRule, SignEndUserSolTransactionRule, SignEvmHashRule, SignEvmMessageRule, SignEvmTransactionRule, SignEvmTypedDataRule, SignSolMessageRule, SignSolTransactionRule, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.send_end_user_evm_asset_criteria_inner 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.models.send_end_user_evm_asset_criteria_inner.SendEndUserEvmAssetCriteriaInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[EvmDataCriterion, EvmNetworkCriterion, NetUSDChangeCriterion]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[EvmNetworkCriterion]
oneof_schema_2_validator: Optional[EvmDataCriterion]
oneof_schema_3_validator: Optional[NetUSDChangeCriterion]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], EvmDataCriterion, EvmNetworkCriterion, NetUSDChangeCriterion, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.send_end_user_evm_asset_rule 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.models.send_end_user_evm_asset_rule.SendEndUserEvmAssetRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendEndUserEvmAssetCriteriaInner]
classmethod from_dict(obj)

Create an instance of SendEndUserEvmAssetRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEndUserEvmAssetRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.send_end_user_evm_transaction_rule 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.models.send_end_user_evm_transaction_rule.SendEndUserEvmTransactionRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendEvmTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SendEndUserEvmTransactionRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEndUserEvmTransactionRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.send_end_user_operation_rule 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.models.send_end_user_operation_rule.SendEndUserOperationRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendEvmTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SendEndUserOperationRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEndUserOperationRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.send_end_user_sol_asset_criteria_inner 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.models.send_end_user_sol_asset_criteria_inner.SendEndUserSolAssetCriteriaInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[SolDataCriterion, SolNetworkCriterion, SplAddressCriterion, SplValueCriterion]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[SplAddressCriterion]
oneof_schema_2_validator: Optional[SplValueCriterion]
oneof_schema_3_validator: Optional[SolDataCriterion]
oneof_schema_4_validator: Optional[SolNetworkCriterion]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], SolDataCriterion, SolNetworkCriterion, SplAddressCriterion, SplValueCriterion, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.send_end_user_sol_asset_rule 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.models.send_end_user_sol_asset_rule.SendEndUserSolAssetRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendEndUserSolAssetCriteriaInner]
classmethod from_dict(obj)

Create an instance of SendEndUserSolAssetRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEndUserSolAssetRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.send_end_user_sol_transaction_rule 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.models.send_end_user_sol_transaction_rule.SendEndUserSolTransactionRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendSolTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SendEndUserSolTransactionRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEndUserSolTransactionRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.send_evm_asset_with_end_user_account200_response 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.models.send_evm_asset_with_end_user_account200_response.SendEvmAssetWithEndUserAccount200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SendEvmAssetWithEndUserAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEvmAssetWithEndUserAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: Optional[StrictStr]
user_op_hash: Optional[StrictStr]

cdp.openapi_client.models.send_evm_asset_with_end_user_account_request 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.models.send_evm_asset_with_end_user_account_request.SendEvmAssetWithEndUserAccountRequest(**data)

Bases: BaseModel

amount: Annotated[str, Field(min_length=1, strict=True, max_length=32)]
classmethod from_dict(obj)

Create an instance of SendEvmAssetWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEvmAssetWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
classmethod network_validate_enum(value)

Validates the enum

paymaster_context: Optional[Dict[str, Any]]
paymaster_url: Optional[Annotated[str, Field(min_length=11, strict=True, max_length=2048)]]
classmethod paymaster_url_validate_regular_expression(value)

Validates the regular expression

to: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

use_cdp_paymaster: Optional[StrictBool]
wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.send_evm_transaction_criteria_inner 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.models.send_evm_transaction_criteria_inner.SendEvmTransactionCriteriaInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[EthValueCriterion, EvmAddressCriterion, EvmDataCriterion, EvmNetworkCriterion, NetUSDChangeCriterion]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[EthValueCriterion]
oneof_schema_2_validator: Optional[EvmAddressCriterion]
oneof_schema_3_validator: Optional[EvmNetworkCriterion]
oneof_schema_4_validator: Optional[EvmDataCriterion]
oneof_schema_5_validator: Optional[NetUSDChangeCriterion]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], EthValueCriterion, EvmAddressCriterion, EvmDataCriterion, EvmNetworkCriterion, NetUSDChangeCriterion, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.send_evm_transaction_request 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.models.send_evm_transaction_request.SendEvmTransactionRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SendEvmTransactionRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEvmTransactionRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
classmethod network_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: StrictStr

cdp.openapi_client.models.send_evm_transaction_rule 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.models.send_evm_transaction_rule.SendEvmTransactionRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendEvmTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SendEvmTransactionRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEvmTransactionRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.send_evm_transaction_with_end_user_account200_response 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.models.send_evm_transaction_with_end_user_account200_response.SendEvmTransactionWithEndUserAccount200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SendEvmTransactionWithEndUserAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEvmTransactionWithEndUserAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.send_evm_transaction_with_end_user_account_request 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.models.send_evm_transaction_with_end_user_account_request.SendEvmTransactionWithEndUserAccountRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SendEvmTransactionWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendEvmTransactionWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
classmethod network_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: StrictStr
wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.send_sol_transaction_criteria_inner 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.models.send_sol_transaction_criteria_inner.SendSolTransactionCriteriaInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[MintAddressCriterion, ProgramIdCriterion, SolAddressCriterion, SolDataCriterion, SolNetworkCriterion, SolValueCriterion, SplAddressCriterion, SplValueCriterion]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[SolAddressCriterion]
oneof_schema_2_validator: Optional[SolValueCriterion]
oneof_schema_3_validator: Optional[SplAddressCriterion]
oneof_schema_4_validator: Optional[SplValueCriterion]
oneof_schema_5_validator: Optional[MintAddressCriterion]
oneof_schema_6_validator: Optional[SolDataCriterion]
oneof_schema_7_validator: Optional[ProgramIdCriterion]
oneof_schema_8_validator: Optional[SolNetworkCriterion]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], MintAddressCriterion, ProgramIdCriterion, SolAddressCriterion, SolDataCriterion, SolNetworkCriterion, SolValueCriterion, SplAddressCriterion, SplValueCriterion, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.send_sol_transaction_rule 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.models.send_sol_transaction_rule.SendSolTransactionRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendSolTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SendSolTransactionRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendSolTransactionRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.send_solana_asset_with_end_user_account_request 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.models.send_solana_asset_with_end_user_account_request.SendSolanaAssetWithEndUserAccountRequest(**data)

Bases: BaseModel

amount: Annotated[str, Field(min_length=1, strict=True, max_length=32)]
create_recipient_ata: Optional[StrictBool]
classmethod from_dict(obj)

Create an instance of SendSolanaAssetWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendSolanaAssetWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
classmethod network_validate_enum(value)

Validates the enum

to: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

use_cdp_sponsor: Optional[StrictBool]
wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.send_solana_transaction_request 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.models.send_solana_transaction_request.SendSolanaTransactionRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SendSolanaTransactionRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendSolanaTransactionRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
classmethod network_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: StrictStr
use_cdp_sponsor: Optional[StrictBool]

cdp.openapi_client.models.send_solana_transaction_with_end_user_account200_response 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.models.send_solana_transaction_with_end_user_account200_response.SendSolanaTransactionWithEndUserAccount200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SendSolanaTransactionWithEndUserAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendSolanaTransactionWithEndUserAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr

cdp.openapi_client.models.send_solana_transaction_with_end_user_account_request 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.models.send_solana_transaction_with_end_user_account_request.SendSolanaTransactionWithEndUserAccountRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SendSolanaTransactionWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendSolanaTransactionWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
classmethod network_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: StrictStr
use_cdp_sponsor: Optional[StrictBool]
wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.send_user_operation_request 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.models.send_user_operation_request.SendUserOperationRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SendUserOperationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendUserOperationRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signature: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.send_user_operation_rule 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.models.send_user_operation_rule.SendUserOperationRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SendEvmTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SendUserOperationRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendUserOperationRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.send_user_operation_with_end_user_account_request 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.models.send_user_operation_with_end_user_account_request.SendUserOperationWithEndUserAccountRequest(**data)

Bases: BaseModel

calls: List[EvmCall]
data_suffix: Optional[Annotated[str, Field(strict=True)]]
classmethod data_suffix_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SendUserOperationWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SendUserOperationWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: EvmUserOperationNetwork
paymaster_context: Optional[Dict[str, Any]]
paymaster_url: Optional[Annotated[str, Field(min_length=11, strict=True, max_length=2048)]]
classmethod paymaster_url_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

use_cdp_paymaster: StrictBool
wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.sepa_details 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.models.sepa_details.SepaDetails(**data)

Bases: BaseModel

Details specific to SEPA (Single Euro Payments Area) payment methods.

asset: StrictStr
bank_name: StrictStr
bic: Annotated[str, Field(strict=True)]
classmethod bic_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SepaDetails from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SepaDetails from a JSON string

Return type:

Optional[Self]

iban_last4: Annotated[str, Field(strict=True)]
classmethod iban_last4_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sepa_payment_method 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.models.sepa_payment_method.SepaPaymentMethod(**data)

Bases: BaseModel

A SEPA (Single Euro Payments Area) payment method linked to your entity.

active: StrictBool
created_at: datetime
classmethod from_dict(obj)

Create an instance of SepaPaymentMethod from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SepaPaymentMethod from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_method_id: Annotated[str, Field(strict=True)]
classmethod payment_method_id_validate_regular_expression(value)

Validates the regular expression

payment_rail: StrictStr
classmethod payment_rail_validate_enum(value)

Validates the enum

sepa: SepaDetails
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: datetime

cdp.openapi_client.models.sign_end_user_evm_hash_rule 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.models.sign_end_user_evm_hash_rule.SignEndUserEvmHashRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

classmethod from_dict(obj)

Create an instance of SignEndUserEvmHashRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEndUserEvmHashRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_end_user_evm_message_rule 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.models.sign_end_user_evm_message_rule.SignEndUserEvmMessageRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignEvmMessageCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignEndUserEvmMessageRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEndUserEvmMessageRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_end_user_evm_transaction_rule 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.models.sign_end_user_evm_transaction_rule.SignEndUserEvmTransactionRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignEvmTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignEndUserEvmTransactionRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEndUserEvmTransactionRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_end_user_evm_typed_data_rule 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.models.sign_end_user_evm_typed_data_rule.SignEndUserEvmTypedDataRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignEvmTypedDataCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignEndUserEvmTypedDataRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEndUserEvmTypedDataRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_end_user_sol_message_rule 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.models.sign_end_user_sol_message_rule.SignEndUserSolMessageRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignSolMessageCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignEndUserSolMessageRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEndUserSolMessageRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_end_user_sol_transaction_rule 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.models.sign_end_user_sol_transaction_rule.SignEndUserSolTransactionRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignSolTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignEndUserSolTransactionRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEndUserSolTransactionRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_hash200_response 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.models.sign_evm_hash200_response.SignEvmHash200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignEvmHash200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmHash200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signature: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_hash_request 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.models.sign_evm_hash_request.SignEvmHashRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignEvmHashRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmHashRequest from a JSON string

Return type:

Optional[Self]

hash: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_hash_rule 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.models.sign_evm_hash_rule.SignEvmHashRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

classmethod from_dict(obj)

Create an instance of SignEvmHashRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmHashRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_message_criteria_inner 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.models.sign_evm_message_criteria_inner.SignEvmMessageCriteriaInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[EvmMessageCriterion]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[EvmMessageCriterion]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], EvmMessageCriterion, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.sign_evm_message_request 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.models.sign_evm_message_request.SignEvmMessageRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignEvmMessageRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmMessageRequest from a JSON string

Return type:

Optional[Self]

message: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_message_rule 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.models.sign_evm_message_rule.SignEvmMessageRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignEvmMessageCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignEvmMessageRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmMessageRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_message_with_end_user_account200_response 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.models.sign_evm_message_with_end_user_account200_response.SignEvmMessageWithEndUserAccount200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignEvmMessageWithEndUserAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmMessageWithEndUserAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signature: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_message_with_end_user_account_request 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.models.sign_evm_message_with_end_user_account_request.SignEvmMessageWithEndUserAccountRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SignEvmMessageWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmMessageWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

message: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.sign_evm_transaction_criteria_inner 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.models.sign_evm_transaction_criteria_inner.SignEvmTransactionCriteriaInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[EthValueCriterion, EvmAddressCriterion, EvmDataCriterion, NetUSDChangeCriterion]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[EthValueCriterion]
oneof_schema_2_validator: Optional[EvmAddressCriterion]
oneof_schema_3_validator: Optional[EvmDataCriterion]
oneof_schema_4_validator: Optional[NetUSDChangeCriterion]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], EthValueCriterion, EvmAddressCriterion, EvmDataCriterion, NetUSDChangeCriterion, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.sign_evm_transaction_request 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.models.sign_evm_transaction_request.SignEvmTransactionRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignEvmTransactionRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTransactionRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: StrictStr

cdp.openapi_client.models.sign_evm_transaction_rule 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.models.sign_evm_transaction_rule.SignEvmTransactionRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignEvmTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignEvmTransactionRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTransactionRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_transaction_with_end_user_account200_response 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.models.sign_evm_transaction_with_end_user_account200_response.SignEvmTransactionWithEndUserAccount200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignEvmTransactionWithEndUserAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTransactionWithEndUserAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_transaction: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_transaction_with_end_user_account_request 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.models.sign_evm_transaction_with_end_user_account_request.SignEvmTransactionWithEndUserAccountRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SignEvmTransactionWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTransactionWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: StrictStr
wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.sign_evm_typed_data_criteria_inner 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.models.sign_evm_typed_data_criteria_inner.SignEvmTypedDataCriteriaInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[SignEvmTypedDataFieldCriterion, SignEvmTypedDataVerifyingContractCriterion]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[SignEvmTypedDataFieldCriterion]
oneof_schema_2_validator: Optional[SignEvmTypedDataVerifyingContractCriterion]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], SignEvmTypedDataFieldCriterion, SignEvmTypedDataVerifyingContractCriterion, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.sign_evm_typed_data_field_criterion 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.models.sign_evm_typed_data_field_criterion.SignEvmTypedDataFieldCriterion(**data)

Bases: BaseModel

conditions: List[SignEvmTypedDataFieldCriterionConditionsInner]
classmethod from_dict(obj)

Create an instance of SignEvmTypedDataFieldCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTypedDataFieldCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

types: SignEvmTypedDataFieldCriterionTypes

cdp.openapi_client.models.sign_evm_typed_data_field_criterion_conditions_inner 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.models.sign_evm_typed_data_field_criterion_conditions_inner.SignEvmTypedDataFieldCriterionConditionsInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[EvmTypedAddressCondition, EvmTypedNumericalCondition, EvmTypedStringCondition]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[EvmTypedAddressCondition]
oneof_schema_2_validator: Optional[EvmTypedNumericalCondition]
oneof_schema_3_validator: Optional[EvmTypedStringCondition]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], EvmTypedAddressCondition, EvmTypedNumericalCondition, EvmTypedStringCondition, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.sign_evm_typed_data_field_criterion_types 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.models.sign_evm_typed_data_field_criterion_types.SignEvmTypedDataFieldCriterionTypes(**data)

Bases: BaseModel

An object containing EIP-712 type definitions, as well as a primary type for the root message object.

classmethod from_dict(obj)

Create an instance of SignEvmTypedDataFieldCriterionTypes from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTypedDataFieldCriterionTypes from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

primary_type: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

types: Dict[str, List[SignEvmTypedDataFieldCriterionTypesTypesValueInner]]

cdp.openapi_client.models.sign_evm_typed_data_field_criterion_types_types_value_inner 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.models.sign_evm_typed_data_field_criterion_types_types_value_inner.SignEvmTypedDataFieldCriterionTypesTypesValueInner(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignEvmTypedDataFieldCriterionTypesTypesValueInner from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTypedDataFieldCriterionTypesTypesValueInner from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: Optional[StrictStr]

cdp.openapi_client.models.sign_evm_typed_data_rule 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.models.sign_evm_typed_data_rule.SignEvmTypedDataRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignEvmTypedDataCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignEvmTypedDataRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTypedDataRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_typed_data_verifying_contract_criterion 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.models.sign_evm_typed_data_verifying_contract_criterion.SignEvmTypedDataVerifyingContractCriterion(**data)

Bases: BaseModel

A schema for specifying criterion for a domain’s verifying contract.

addresses: List[Annotated[str, Field(strict=True)]]
classmethod from_dict(obj)

Create an instance of SignEvmTypedDataVerifyingContractCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTypedDataVerifyingContractCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.sign_evm_typed_data_with_end_user_account200_response 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.models.sign_evm_typed_data_with_end_user_account200_response.SignEvmTypedDataWithEndUserAccount200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignEvmTypedDataWithEndUserAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTypedDataWithEndUserAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signature: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_evm_typed_data_with_end_user_account_request 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.models.sign_evm_typed_data_with_end_user_account_request.SignEvmTypedDataWithEndUserAccountRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SignEvmTypedDataWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignEvmTypedDataWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

typed_data: EIP712Message
wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.sign_sol_message_criteria_inner 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.models.sign_sol_message_criteria_inner.SignSolMessageCriteriaInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[SolMessageCriterion]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[SolMessageCriterion]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], SolMessageCriterion, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.sign_sol_message_rule 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.models.sign_sol_message_rule.SignSolMessageRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignSolMessageCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignSolMessageRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignSolMessageRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_sol_transaction_criteria_inner 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.models.sign_sol_transaction_criteria_inner.SignSolTransactionCriteriaInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[MintAddressCriterion, ProgramIdCriterion, SolAddressCriterion, SolDataCriterion, SolValueCriterion, SplAddressCriterion, SplValueCriterion]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[SolAddressCriterion]
oneof_schema_2_validator: Optional[SolValueCriterion]
oneof_schema_3_validator: Optional[SplAddressCriterion]
oneof_schema_4_validator: Optional[SplValueCriterion]
oneof_schema_5_validator: Optional[MintAddressCriterion]
oneof_schema_6_validator: Optional[SolDataCriterion]
oneof_schema_7_validator: Optional[ProgramIdCriterion]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], MintAddressCriterion, ProgramIdCriterion, SolAddressCriterion, SolDataCriterion, SolValueCriterion, SplAddressCriterion, SplValueCriterion, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.sign_sol_transaction_rule 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.models.sign_sol_transaction_rule.SignSolTransactionRule(**data)

Bases: BaseModel

action: StrictStr
classmethod action_validate_enum(value)

Validates the enum

criteria: List[SignSolTransactionCriteriaInner]
classmethod from_dict(obj)

Create an instance of SignSolTransactionRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignSolTransactionRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operation: StrictStr
classmethod operation_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_solana_message_request 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.models.sign_solana_message_request.SignSolanaMessageRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignSolanaMessageRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignSolanaMessageRequest from a JSON string

Return type:

Optional[Self]

message: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_solana_message_with_end_user_account200_response 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.models.sign_solana_message_with_end_user_account200_response.SignSolanaMessageWithEndUserAccount200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignSolanaMessageWithEndUserAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignSolanaMessageWithEndUserAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signature: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_solana_message_with_end_user_account_request 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.models.sign_solana_message_with_end_user_account_request.SignSolanaMessageWithEndUserAccountRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SignSolanaMessageWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignSolanaMessageWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

message: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.sign_solana_transaction_request 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.models.sign_solana_transaction_request.SignSolanaTransactionRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignSolanaTransactionRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignSolanaTransactionRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: StrictStr

cdp.openapi_client.models.sign_solana_transaction_with_end_user_account200_response 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.models.sign_solana_transaction_with_end_user_account200_response.SignSolanaTransactionWithEndUserAccount200Response(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SignSolanaTransactionWithEndUserAccount200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignSolanaTransactionWithEndUserAccount200Response from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_transaction: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sign_solana_transaction_with_end_user_account_request 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.models.sign_solana_transaction_with_end_user_account_request.SignSolanaTransactionWithEndUserAccountRequest(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SignSolanaTransactionWithEndUserAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignSolanaTransactionWithEndUserAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: StrictStr
wallet_secret_id: Optional[Annotated[str, Field(strict=True)]]
classmethod wallet_secret_id_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.siwe_authentication 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.models.siwe_authentication.SiweAuthentication(**data)

Bases: BaseModel

Information about an end user who authenticates using Sign In With Ethereum (EIP-4361).

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of SiweAuthentication from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SiweAuthentication from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.sms_authentication 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.models.sms_authentication.SmsAuthentication(**data)

Bases: BaseModel

Information about an end user who authenticates using a one-time password sent to their phone number via SMS.

classmethod from_dict(obj)

Create an instance of SmsAuthentication from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SmsAuthentication from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phone_number: Annotated[str, Field(strict=True)]
classmethod phone_number_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.sol_address_criterion 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.models.sol_address_criterion.SolAddressCriterion(**data)

Bases: BaseModel

The criterion for the recipient addresses of a Solana transaction’s native transfer instruction.

addresses: List[Annotated[str, Field(strict=True)]]
classmethod from_dict(obj)

Create an instance of SolAddressCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolAddressCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.sol_data_condition 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.models.sol_data_condition.SolDataCondition(**data)

Bases: BaseModel

A single condition to apply against a specific instruction type and its parameters.

classmethod from_dict(obj)

Create an instance of SolDataCondition from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolDataCondition from a JSON string

Return type:

Optional[Self]

instruction: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

params: Optional[List[SolDataConditionParamsInner]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.sol_data_condition_params_inner 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.models.sol_data_condition_params_inner.SolDataConditionParamsInner(*args, **kwargs)

Bases: BaseModel

A list of parameter conditions to apply against a specific instruction’s data.

actual_instance: Optional[Union[SolDataParameterCondition, SolDataParameterConditionList]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[SolDataParameterCondition]
oneof_schema_2_validator: Optional[SolDataParameterConditionList]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], SolDataParameterCondition, SolDataParameterConditionList, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.sol_data_criterion 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.models.sol_data_criterion.SolDataCriterion(**data)

Bases: BaseModel

A schema for specifying criterion for instruction data in a Solana transaction.

conditions: List[SolDataCondition]
classmethod from_dict(obj)

Create an instance of SolDataCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolDataCriterion from a JSON string

Return type:

Optional[Self]

idls: List[SolDataCriterionIdlsInner]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.sol_data_criterion_idls_inner 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.models.sol_data_criterion_idls_inner.SolDataCriterionIdlsInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[Idl, KnownIdlType]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[KnownIdlType]
oneof_schema_2_validator: Optional[Idl]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], Idl, KnownIdlType, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.sol_data_parameter_condition 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.models.sol_data_parameter_condition.SolDataParameterCondition(**data)

Bases: BaseModel

A single parameter condition to apply against a specific instruction’s parameters.

classmethod from_dict(obj)

Create an instance of SolDataParameterCondition from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolDataParameterCondition from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr
operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

value: StrictStr

cdp.openapi_client.models.sol_data_parameter_condition_list 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.models.sol_data_parameter_condition_list.SolDataParameterConditionList(**data)

Bases: BaseModel

A single parameter condition to apply against a specific instruction’s parameters.

classmethod from_dict(obj)

Create an instance of SolDataParameterConditionList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolDataParameterConditionList from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr
operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

values: List[StrictStr]

cdp.openapi_client.models.sol_message_criterion 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.models.sol_message_criterion.SolMessageCriterion(**data)

Bases: BaseModel

The criterion for the message of a Solana transaction.

classmethod from_dict(obj)

Create an instance of SolMessageCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolMessageCriterion from a JSON string

Return type:

Optional[Self]

match: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.sol_network_criterion 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.models.sol_network_criterion.SolNetworkCriterion(**data)

Bases: BaseModel

The criterion for the Solana network of a transaction.

classmethod from_dict(obj)

Create an instance of SolNetworkCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolNetworkCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

networks: List[StrictStr]
classmethod networks_validate_enum(value)

Validates the enum

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.sol_value_criterion 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.models.sol_value_criterion.SolValueCriterion(**data)

Bases: BaseModel

The criterion for the SOL value in lamports of a native transfer instruction in a Solana transaction.

classmethod from_dict(obj)

Create an instance of SolValueCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolValueCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

sol_value: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.solana_account 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.models.solana_account.SolanaAccount(**data)

Bases: BaseModel

address: Annotated[str, Field(strict=True)]
classmethod address_validate_regular_expression(value)

Validates the regular expression

created_at: Optional[datetime]
classmethod from_dict(obj)

Create an instance of SolanaAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolanaAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

policies: Optional[List[Annotated[str, Field(strict=True)]]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: Optional[datetime]

cdp.openapi_client.models.solana_token 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.models.solana_token.SolanaToken(**data)

Bases: BaseModel

General information about a Solana token. Includes the mint address, and other identifying information.

classmethod from_dict(obj)

Create an instance of SolanaToken from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolanaToken from a JSON string

Return type:

Optional[Self]

mint_address: Annotated[str, Field(strict=True)]
classmethod mint_address_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
symbol: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.solana_token_amount 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.models.solana_token_amount.SolanaTokenAmount(**data)

Bases: BaseModel

Amount of a given Solana token.

amount: Annotated[str, Field(strict=True)]
classmethod amount_validate_regular_expression(value)

Validates the regular expression

decimals: StrictInt
classmethod from_dict(obj)

Create an instance of SolanaTokenAmount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolanaTokenAmount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.solana_token_balance 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.models.solana_token_balance.SolanaTokenBalance(**data)

Bases: BaseModel

amount: SolanaTokenAmount
classmethod from_dict(obj)

Create an instance of SolanaTokenBalance from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolanaTokenBalance from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: SolanaToken

cdp.openapi_client.models.spend_permission 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.models.spend_permission.SpendPermission(**data)

Bases: BaseModel

The core spend permission.

account: Annotated[str, Field(strict=True)]
classmethod account_validate_regular_expression(value)

Validates the regular expression

allowance: StrictStr
end: StrictStr
extra_data: StrictStr
classmethod from_dict(obj)

Create an instance of SpendPermission from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SpendPermission from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

period: StrictStr
salt: StrictStr
spender: Annotated[str, Field(strict=True)]
classmethod spender_validate_regular_expression(value)

Validates the regular expression

start: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: Annotated[str, Field(strict=True)]
classmethod token_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.spend_permission_network 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.models.spend_permission_network.SpendPermissionNetwork(value)

Bases: str, Enum

The network the spend permission is on.

ARBITRUM = 'arbitrum'
AVALANCHE = 'avalanche'
BASE = 'base'
BASE_MINUS_SEPOLIA = 'base-sepolia'
ETHEREUM = 'ethereum'
ETHEREUM_MINUS_SEPOLIA = 'ethereum-sepolia'
OPTIMISM = 'optimism'
POLYGON = 'polygon'
classmethod from_json(json_str)

Create an instance of SpendPermissionNetwork from a JSON string

Return type:

Self

cdp.openapi_client.models.spend_permission_response_object 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.models.spend_permission_response_object.SpendPermissionResponseObject(**data)

Bases: BaseModel

created_at: datetime
classmethod from_dict(obj)

Create an instance of SpendPermissionResponseObject from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SpendPermissionResponseObject from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: SpendPermissionNetwork
permission: SpendPermission
permission_hash: StrictStr
revoked: StrictBool
revoked_at: Optional[datetime]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.spl_address_criterion 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.models.spl_address_criterion.SplAddressCriterion(**data)

Bases: BaseModel

The criterion for the recipient addresses of a Solana transaction’s SPL token transfer instructions.

addresses: List[Annotated[str, Field(strict=True)]]
classmethod from_dict(obj)

Create an instance of SplAddressCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SplAddressCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.spl_value_criterion 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.models.spl_value_criterion.SplValueCriterion(**data)

Bases: BaseModel

The criterion for the SPL token value of a SPL token transfer instruction in a Solana transaction.

classmethod from_dict(obj)

Create an instance of SplValueCriterion from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SplValueCriterion from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

operator: StrictStr
classmethod operator_validate_enum(value)

Validates the enum

spl_value: StrictStr
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.submit_onramp_verification_request 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.models.submit_onramp_verification_request.SubmitOnrampVerificationRequest(**data)

Bases: BaseModel

Request body for submitting an OTP code to complete an onramp verification.

classmethod from_dict(obj)

Create an instance of SubmitOnrampVerificationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SubmitOnrampVerificationRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

otp_code: Annotated[str, Field(strict=True)]
classmethod otp_code_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.swap_unavailable_response 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.models.swap_unavailable_response.SwapUnavailableResponse(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SwapUnavailableResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SwapUnavailableResponse from a JSON string

Return type:

Optional[Self]

liquidity_available: StrictBool
classmethod liquidity_available_validate_enum(value)

Validates the enum

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.swift_details 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.models.swift_details.SwiftDetails(**data)

Bases: BaseModel

Details specific to SWIFT (international wire) payment methods.

account_last4: Annotated[str, Field(strict=True)]
classmethod account_last4_validate_regular_expression(value)

Validates the regular expression

asset: StrictStr
bank_name: StrictStr
bic: Annotated[str, Field(strict=True)]
classmethod bic_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of SwiftDetails from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SwiftDetails from a JSON string

Return type:

Optional[Self]

iban_last4: Optional[Annotated[str, Field(strict=True)]]
classmethod iban_last4_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.swift_payment_method 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.models.swift_payment_method.SwiftPaymentMethod(**data)

Bases: BaseModel

A SWIFT (international wire) payment method linked to your entity.

active: StrictBool
created_at: datetime
classmethod from_dict(obj)

Create an instance of SwiftPaymentMethod from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SwiftPaymentMethod from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_method_id: Annotated[str, Field(strict=True)]
classmethod payment_method_id_validate_regular_expression(value)

Validates the regular expression

payment_rail: StrictStr
classmethod payment_rail_validate_enum(value)

Validates the enum

swift: SwiftDetails
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: datetime

cdp.openapi_client.models.telegram_authentication 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.models.telegram_authentication.TelegramAuthentication(**data)

Bases: BaseModel

Information about an end user who authenticates using Telegram.

auth_date: StrictInt
first_name: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of TelegramAuthentication from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TelegramAuthentication from a JSON string

Return type:

Optional[Self]

id: StrictInt
last_name: Optional[StrictStr]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

photo_url: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: OAuth2ProviderType
username: Optional[StrictStr]

cdp.openapi_client.models.token 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.models.token.Token(**data)

Bases: BaseModel

General information about a token. Includes the type, the network, and other identifying information.

contract_address: Annotated[str, Field(strict=True)]
classmethod contract_address_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of Token from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Token from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
network: ListEvmTokenBalancesNetwork
symbol: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.token_amount 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.models.token_amount.TokenAmount(**data)

Bases: BaseModel

Amount of a given token.

amount: Annotated[str, Field(strict=True)]
classmethod amount_validate_regular_expression(value)

Validates the regular expression

decimals: StrictInt
classmethod from_dict(obj)

Create an instance of TokenAmount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TokenAmount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.token_balance 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.models.token_balance.TokenBalance(**data)

Bases: BaseModel

amount: TokenAmount
classmethod from_dict(obj)

Create an instance of TokenBalance from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TokenBalance from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: Token

cdp.openapi_client.models.token_fee 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.models.token_fee.TokenFee(**data)

Bases: BaseModel

amount: Annotated[str, Field(strict=True)]
classmethod amount_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of TokenFee from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TokenFee from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: Annotated[str, Field(strict=True)]
classmethod token_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.transfer 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.models.transfer.Transfer(**data)

Bases: BaseModel

A Transfer represents all the information needed to execute a transfer and tracks the lifecycle of a transfer from initiation through completion or failure.

completed_at: Optional[datetime]
created_at: Optional[datetime]
details: Optional[TransferDetails]
estimate: Optional[TransferEstimate]
exchange_rate: Optional[TransferExchangeRate]
executed_at: Optional[datetime]
expires_at: Optional[datetime]
failure_reason: Optional[StrictStr]
fees: Optional[List[TransferFee]]
classmethod from_dict(obj)

Create an instance of Transfer from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Transfer from a JSON string

Return type:

Optional[Self]

metadata: Optional[Dict[str, Annotated[str, Field(min_length=0, strict=True, max_length=500)]]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

source: TransferSource
source_amount: Optional[StrictStr]
source_asset: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=42)]]
status: Optional[TransferStatus]
target: TransferTarget
target_amount: Optional[StrictStr]
target_asset: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=42)]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transfer_id: Optional[StrictStr]
updated_at: Optional[datetime]

cdp.openapi_client.models.transfer_details 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.models.transfer_details.TransferDetails(**data)

Bases: BaseModel

Additional details about the transfer. For example, if the transfer was sent to a deposit destination, the information about that destination will be included in this field.

deposit_destination: Optional[DepositDestinationReference]
classmethod from_dict(obj)

Create an instance of TransferDetails from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TransferDetails from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

onchain_transactions: Optional[List[TransferDetailsOnchainTransactionsInner]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

travel_rule: Optional[TransferDetailsTravelRule]

cdp.openapi_client.models.transfer_details_onchain_transactions_inner 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.models.transfer_details_onchain_transactions_inner.TransferDetailsOnchainTransactionsInner(**data)

Bases: BaseModel

An onchain transaction associated with the transfer.

classmethod from_dict(obj)

Create an instance of TransferDetailsOnchainTransactionsInner from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TransferDetailsOnchainTransactionsInner from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.transfer_details_travel_rule 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.models.transfer_details_travel_rule.TransferDetailsTravelRule(**data)

Bases: BaseModel

Travel rule compliance status for deposit transfers. Present when the transfer requires travel rule information.

classmethod from_dict(obj)

Create an instance of TransferDetailsTravelRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TransferDetailsTravelRule from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: Optional[TravelRuleStatus]
status_message: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.transfer_estimate 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.models.transfer_estimate.TransferEstimate(**data)

Bases: BaseModel

Captures estimated values for transfers where amounts can’t be guaranteed (e.g., USDC -> EURC). The values in estimate are not modified after a transfer is executed. They are preserved as an immutable record of the original pre-execution snapshot. The actual executed values are populated in the transfer resource post-execution.

estimated_at: datetime
exchange_rate: Optional[TransferExchangeRate]
fees: Optional[List[TransferFee]]
classmethod from_dict(obj)

Create an instance of TransferEstimate from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TransferEstimate from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

target_amount: Optional[StrictStr]
target_asset: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=42)]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.transfer_exchange_rate 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.models.transfer_exchange_rate.TransferExchangeRate(**data)

Bases: BaseModel

Exchange rate information for currency conversion. The rate indicates how much of the target asset is equivalent to one unit of the source asset.

classmethod from_dict(obj)

Create an instance of TransferExchangeRate from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TransferExchangeRate from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rate: StrictStr
source_asset: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
target_asset: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.transfer_fee 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.models.transfer_fee.TransferFee(**data)

Bases: BaseModel

A single fee for a transfer.

amount: StrictStr
asset: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
classmethod from_dict(obj)

Create an instance of TransferFee from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TransferFee from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.transfer_request 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.models.transfer_request.TransferRequest(**data)

Bases: BaseModel

A request to create a transfer.

amount: StrictStr
amount_type: Optional[StrictStr]
classmethod amount_type_validate_enum(value)

Validates the enum

asset: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
execute: StrictBool
classmethod from_dict(obj)

Create an instance of TransferRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TransferRequest from a JSON string

Return type:

Optional[Self]

metadata: Optional[Dict[str, Annotated[str, Field(min_length=0, strict=True, max_length=500)]]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

source: CreateTransferSource
target: TransferTarget
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

travel_rule: Optional[TravelRule]
validate_only: Optional[StrictBool]

cdp.openapi_client.models.transfer_source 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.models.transfer_source.TransferSource(*args, **kwargs)

Bases: BaseModel

The source of the transfer.

actual_instance: Optional[Union[OnchainAddress, OriginatingBankAccountUS, PaymentMethod, TransfersAccount]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[TransfersAccount]
oneof_schema_2_validator: Optional[PaymentMethod]
oneof_schema_3_validator: Optional[OnchainAddress]
oneof_schema_4_validator: Optional[OriginatingBankAccountUS]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], OnchainAddress, OriginatingBankAccountUS, PaymentMethod, TransfersAccount, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.transfer_status 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.models.transfer_status.TransferStatus(value)

Bases: str, Enum

The current status of the transfer, indicating what action you need to take next. Required when validateOnly is false.

COMPLETED = 'completed'
FAILED = 'failed'
PROCESSING = 'processing'
QUOTED = 'quoted'
classmethod from_json(json_str)

Create an instance of TransferStatus from a JSON string

Return type:

Self

cdp.openapi_client.models.transfer_target 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.models.transfer_target.TransferTarget(*args, **kwargs)

Bases: BaseModel

The target of the transfer.

actual_instance: Optional[Union[EmailInstrument, OnchainAddress, PaymentMethod, TransfersAccount]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[TransfersAccount]
oneof_schema_2_validator: Optional[PaymentMethod]
oneof_schema_3_validator: Optional[OnchainAddress]
oneof_schema_4_validator: Optional[EmailInstrument]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], EmailInstrument, OnchainAddress, PaymentMethod, TransfersAccount, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.transfers_account 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.models.transfers_account.TransfersAccount(**data)

Bases: BaseModel

The Account specific details for the transfer.

account_id: StrictStr
asset: Annotated[str, Field(min_length=1, strict=True, max_length=42)]
classmethod from_dict(obj)

Create an instance of TransfersAccount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TransfersAccount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.travel_rule 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.models.travel_rule.TravelRule(**data)

Bases: BaseModel

Required Travel Rule fields differ by region. These requirements are determined based on which Coinbase entity the customer has signed the service agreement for.

beneficiary: Optional[TravelRuleBeneficiary]
classmethod from_dict(obj)

Create an instance of TravelRule from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TravelRule from a JSON string

Return type:

Optional[Self]

is_intermediary: Optional[StrictBool]
is_self: Optional[StrictBool]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

originator: Optional[TravelRuleOriginator]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.travel_rule_beneficiary 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.models.travel_rule_beneficiary.TravelRuleBeneficiary(**data)

Bases: BaseModel

Beneficiary (receiver) party.

address: Optional[PhysicalAddress]
financial_institution: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of TravelRuleBeneficiary from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TravelRuleBeneficiary from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

wallet_type: Optional[StrictStr]
classmethod wallet_type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.travel_rule_originator 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.models.travel_rule_originator.TravelRuleOriginator(**data)

Bases: BaseModel

Originator (sender) party.

address: Optional[PhysicalAddress]
date_of_birth: Optional[DateOfBirth]
financial_institution: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of TravelRuleOriginator from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TravelRuleOriginator from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
personal_id: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

virtual_asset_service_provider: Optional[TravelRuleOriginatorAllOfVirtualAssetServiceProvider]

cdp.openapi_client.models.travel_rule_originator_all_of_virtual_asset_service_provider 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.models.travel_rule_originator_all_of_virtual_asset_service_provider.TravelRuleOriginatorAllOfVirtualAssetServiceProvider(**data)

Bases: BaseModel

Information about the originating Virtual Asset Service Provider (VASP) that handles cryptocurrency or other virtual assets on behalf of customers.

address: Optional[PhysicalAddress]
classmethod from_dict(obj)

Create an instance of TravelRuleOriginatorAllOfVirtualAssetServiceProvider from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TravelRuleOriginatorAllOfVirtualAssetServiceProvider from a JSON string

Return type:

Optional[Self]

identifier: Optional[StrictStr]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.travel_rule_party 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.models.travel_rule_party.TravelRuleParty(**data)

Bases: BaseModel

Information about a party (originator or beneficiary) for travel rule compliance.

address: Optional[PhysicalAddress]
financial_institution: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of TravelRuleParty from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TravelRuleParty from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.travel_rule_status 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.models.travel_rule_status.TravelRuleStatus(value)

Bases: str, Enum

The status of a travel rule submission.

COMPLETED = 'completed'
INCOMPLETE = 'incomplete'
classmethod from_json(json_str)

Create an instance of TravelRuleStatus from a JSON string

Return type:

Self

cdp.openapi_client.models.update_evm_account_request 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.models.update_evm_account_request.UpdateEvmAccountRequest(**data)

Bases: BaseModel

account_policy: Optional[Annotated[str, Field(strict=True)]]
classmethod account_policy_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of UpdateEvmAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UpdateEvmAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.update_evm_smart_account_request 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.models.update_evm_smart_account_request.UpdateEvmSmartAccountRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of UpdateEvmSmartAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UpdateEvmSmartAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.update_policy_request 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.models.update_policy_request.UpdatePolicyRequest(**data)

Bases: BaseModel

description: Optional[Annotated[str, Field(strict=True)]]
classmethod description_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of UpdatePolicyRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UpdatePolicyRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rules: List[Rule]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.update_solana_account_request 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.models.update_solana_account_request.UpdateSolanaAccountRequest(**data)

Bases: BaseModel

account_policy: Optional[Annotated[str, Field(strict=True)]]
classmethod account_policy_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of UpdateSolanaAccountRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UpdateSolanaAccountRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[Annotated[str, Field(strict=True)]]
classmethod name_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.user_operation_receipt 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.models.user_operation_receipt.UserOperationReceipt(**data)

Bases: BaseModel

The receipt that contains information about the execution of user operation.

block_hash: Optional[Annotated[str, Field(strict=True)]]
classmethod block_hash_validate_regular_expression(value)

Validates the regular expression

block_number: Optional[StrictInt]
classmethod from_dict(obj)

Create an instance of UserOperationReceipt from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserOperationReceipt from a JSON string

Return type:

Optional[Self]

gas_used: Optional[StrictStr]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

revert: Optional[UserOperationReceiptRevert]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: Optional[Annotated[str, Field(strict=True)]]
classmethod transaction_hash_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.user_operation_receipt_revert 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.models.user_operation_receipt_revert.UserOperationReceiptRevert(**data)

Bases: BaseModel

The revert data if the user operation has reverted.

data: Annotated[str, Field(strict=True)]
classmethod data_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of UserOperationReceiptRevert from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserOperationReceiptRevert from a JSON string

Return type:

Optional[Self]

message: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.user_wallet 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.models.user_wallet.UserWallet(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of UserWallet from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWallet from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
replaced_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet1 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.models.user_wallet1.UserWallet1(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of UserWallet1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWallet1 from a JSON string

Return type:

Optional[Self]

max_fee_per_gas: StrictStr
max_priority_fee_per_gas: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
pending_since: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet2 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.models.user_wallet2.UserWallet2(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of UserWallet2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWallet2 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing 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.models.user_wallet_delegated_signing.UserWalletDelegatedSigning(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigning from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigning from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
replaced_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing1 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.models.user_wallet_delegated_signing1.UserWalletDelegatedSigning1(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigning1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigning1 from a JSON string

Return type:

Optional[Self]

max_fee_per_gas: StrictStr
max_priority_fee_per_gas: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
pending_since: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing2 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.models.user_wallet_delegated_signing2.UserWalletDelegatedSigning2(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigning2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigning2 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_evm 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.models.user_wallet_delegated_signing_evm.UserWalletDelegatedSigningEVM(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
created_at: datetime
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningEVM from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningEVM from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_evm1 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.models.user_wallet_delegated_signing_evm1.UserWalletDelegatedSigningEVM1(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningEVM1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningEVM1 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_evm2 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.models.user_wallet_delegated_signing_evm2.UserWalletDelegatedSigningEVM2(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
broadcast_at: datetime
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningEVM2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningEVM2 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_evm3 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.models.user_wallet_delegated_signing_evm3.UserWalletDelegatedSigningEVM3(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
confirmed_at: datetime
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningEVM3 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningEVM3 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_evm4 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.models.user_wallet_delegated_signing_evm4.UserWalletDelegatedSigningEVM4(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
delegation_id: StrictStr
failed_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningEVM4 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningEVM4 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_solana 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.models.user_wallet_delegated_signing_solana.UserWalletDelegatedSigningSolana(**data)

Bases: BaseModel

created_at: datetime
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningSolana from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningSolana from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_solana1 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.models.user_wallet_delegated_signing_solana1.UserWalletDelegatedSigningSolana1(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningSolana1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningSolana1 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_solana2 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.models.user_wallet_delegated_signing_solana2.UserWalletDelegatedSigningSolana2(**data)

Bases: BaseModel

broadcast_at: datetime
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningSolana2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningSolana2 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_solana3 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.models.user_wallet_delegated_signing_solana3.UserWalletDelegatedSigningSolana3(**data)

Bases: BaseModel

confirmed_at: datetime
delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningSolana3 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningSolana3 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_delegated_signing_solana4 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.models.user_wallet_delegated_signing_solana4.UserWalletDelegatedSigningSolana4(**data)

Bases: BaseModel

delegation_id: StrictStr
failed_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletDelegatedSigningSolana4 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletDelegatedSigningSolana4 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_evm 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.models.user_wallet_evm.UserWalletEVM(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
created_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletEVM from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletEVM from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_evm1 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.models.user_wallet_evm1.UserWalletEVM1(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of UserWalletEVM1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletEVM1 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_evm2 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.models.user_wallet_evm2.UserWalletEVM2(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
broadcast_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletEVM2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletEVM2 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_evm3 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.models.user_wallet_evm3.UserWalletEVM3(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
confirmed_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletEVM3 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletEVM3 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_evm4 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.models.user_wallet_evm4.UserWalletEVM4(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
failed_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletEVM4 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletEVM4 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_solana 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.models.user_wallet_solana.UserWalletSolana(**data)

Bases: BaseModel

created_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletSolana from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletSolana from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_solana1 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.models.user_wallet_solana1.UserWalletSolana1(**data)

Bases: BaseModel

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of UserWalletSolana1 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletSolana1 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.user_wallet_solana2 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.models.user_wallet_solana2.UserWalletSolana2(**data)

Bases: BaseModel

broadcast_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletSolana2 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletSolana2 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_solana3 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.models.user_wallet_solana3.UserWalletSolana3(**data)

Bases: BaseModel

confirmed_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletSolana3 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletSolana3 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr
user_id: StrictStr

cdp.openapi_client.models.user_wallet_solana4 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.models.user_wallet_solana4.UserWalletSolana4(**data)

Bases: BaseModel

failed_at: datetime
classmethod from_dict(obj)

Create an instance of UserWalletSolana4 from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UserWalletSolana4 from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr
user_id: StrictStr

cdp.openapi_client.models.validate_end_user_access_token_request 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.models.validate_end_user_access_token_request.ValidateEndUserAccessTokenRequest(**data)

Bases: BaseModel

The request body for a developer to verify an end user’s access token.

access_token: StrictStr
classmethod from_dict(obj)

Create an instance of ValidateEndUserAccessTokenRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ValidateEndUserAccessTokenRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.verify_x402_payment_request 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.models.verify_x402_payment_request.VerifyX402PaymentRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of VerifyX402PaymentRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of VerifyX402PaymentRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_payload: X402PaymentPayload
payment_requirements: X402PaymentRequirements
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

x402_version: X402Version

cdp.openapi_client.models.wallet_activity_detected_event 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.models.wallet_activity_detected_event.WalletActivityDetectedEvent(**data)

Bases: BaseModel

data: OnchainActivityEventData
event_id: StrictStr
event_type: StrictStr
classmethod event_type_validate_enum(value)

Validates the enum

classmethod from_dict(obj)

Create an instance of WalletActivityDetectedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletActivityDetectedEvent from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

timestamp: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.wallet_activity_event_base 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.models.wallet_activity_event_base.WalletActivityEventBase(**data)

Bases: BaseModel

Common fields included in every wallet activity webhook event payload.

data: OnchainActivityEventData
event_id: StrictStr
classmethod from_dict(obj)

Create an instance of WalletActivityEventBase from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletActivityEventBase from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

timestamp: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.wallet_activity_multi_event 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.models.wallet_activity_multi_event.WalletActivityMultiEvent(**data)

Bases: BaseModel

data: OnchainActivityEventData
event_id: StrictStr
event_type: StrictStr
classmethod event_type_validate_enum(value)

Validates the enum

classmethod from_dict(obj)

Create an instance of WalletActivityMultiEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletActivityMultiEvent from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

timestamp: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.wallet_api_key_event_payload_not 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.models.wallet_api_key_event_payload_not.WalletApiKeyEventPayloadNot(*args, **kwargs)

Bases: BaseModel

actual_instance: Any
classmethod actual_instance_must_validate_anyof(v)
any_of_schemas: Set[str]
anyof_schema_1_validator: Optional[Any]
anyof_schema_2_validator: Optional[Any]
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], object, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_delegated_event_payload 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.models.wallet_delegated_event_payload.WalletDelegatedEventPayload(**data)

Bases: BaseModel

Payload for delegated User Wallet events, where a User Wallet action was authorized via a delegation grant. Includes user_id and the delegation_id of the active grant.

delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of WalletDelegatedEventPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletDelegatedEventPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.wallet_delegation_created_event 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.models.wallet_delegation_created_event.WalletDelegationCreatedEvent(**data)

Bases: BaseModel

Delivered when a delegation grant is created for a User Wallet.

created_at: datetime
delegation_id: StrictStr
expires_at: datetime
classmethod from_dict(obj)

Create an instance of WalletDelegationCreatedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletDelegationCreatedEvent from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.wallet_delegation_revoked_event 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.models.wallet_delegation_revoked_event.WalletDelegationRevokedEvent(**data)

Bases: BaseModel

Delivered when a delegation grant is revoked.

delegation_id: StrictStr
classmethod from_dict(obj)

Create an instance of WalletDelegationRevokedEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletDelegationRevokedEvent from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

revoked_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.wallet_evm_signing_payload 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.models.wallet_evm_signing_payload.WalletEvmSigningPayload(**data)

Bases: BaseModel

Payload for EVM wallet signing events. Carries the EVM signing address and timestamp; no network or transaction identifier.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of WalletEvmSigningPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletEvmSigningPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.wallet_evm_transaction_broadcast_payload 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.models.wallet_evm_transaction_broadcast_payload.WalletEvmTransactionBroadcastPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.broadcast on EVM networks. Includes transaction_hash and address.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
broadcast_at: datetime
classmethod from_dict(obj)

Create an instance of WalletEvmTransactionBroadcastPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletEvmTransactionBroadcastPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.wallet_evm_transaction_confirmed_payload 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.models.wallet_evm_transaction_confirmed_payload.WalletEvmTransactionConfirmedPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.confirmed on EVM networks. Includes transaction_hash and address.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
confirmed_at: datetime
classmethod from_dict(obj)

Create an instance of WalletEvmTransactionConfirmedPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletEvmTransactionConfirmedPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.wallet_evm_transaction_created_payload 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.models.wallet_evm_transaction_created_payload.WalletEvmTransactionCreatedPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.created on EVM networks. Includes the originating address.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
created_at: datetime
classmethod from_dict(obj)

Create an instance of WalletEvmTransactionCreatedPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletEvmTransactionCreatedPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.wallet_evm_transaction_failed_payload 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.models.wallet_evm_transaction_failed_payload.WalletEvmTransactionFailedPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.failed on EVM networks. Includes transaction_hash and address.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
failed_at: datetime
classmethod from_dict(obj)

Create an instance of WalletEvmTransactionFailedPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletEvmTransactionFailedPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.wallet_hash_signed_event 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.models.wallet_hash_signed_event.WalletHashSignedEvent(*args, **kwargs)

Bases: BaseModel

Delivered when a raw hash is signed. Emitted for both EVM and Solana wallets. The payload is one of six variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing), each delivered as an EVM or Solana variant.

actual_instance: Optional[Union[APIKeyWalletEVM1, APIKeyWalletSolana1, UserWalletDelegatedSigningEVM1, UserWalletDelegatedSigningSolana1, UserWalletEVM1, UserWalletSolana1]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWalletEVM1]
oneof_schema_2_validator: Optional[APIKeyWalletSolana1]
oneof_schema_3_validator: Optional[UserWalletEVM1]
oneof_schema_4_validator: Optional[UserWalletSolana1]
oneof_schema_5_validator: Optional[UserWalletDelegatedSigningEVM1]
oneof_schema_6_validator: Optional[UserWalletDelegatedSigningSolana1]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWalletEVM1, APIKeyWalletSolana1, UserWalletDelegatedSigningEVM1, UserWalletDelegatedSigningSolana1, UserWalletEVM1, UserWalletSolana1, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_message_signed_event 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.models.wallet_message_signed_event.WalletMessageSignedEvent(*args, **kwargs)

Bases: BaseModel

Delivered when a message is signed. Emitted for both EVM and Solana wallets. The payload is one of six variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing), each delivered as an EVM or Solana variant.

actual_instance: Optional[Union[APIKeyWalletEVM1, APIKeyWalletSolana1, UserWalletDelegatedSigningEVM1, UserWalletDelegatedSigningSolana1, UserWalletEVM1, UserWalletSolana1]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWalletEVM1]
oneof_schema_2_validator: Optional[APIKeyWalletSolana1]
oneof_schema_3_validator: Optional[UserWalletEVM1]
oneof_schema_4_validator: Optional[UserWalletSolana1]
oneof_schema_5_validator: Optional[UserWalletDelegatedSigningEVM1]
oneof_schema_6_validator: Optional[UserWalletDelegatedSigningSolana1]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWalletEVM1, APIKeyWalletSolana1, UserWalletDelegatedSigningEVM1, UserWalletDelegatedSigningSolana1, UserWalletEVM1, UserWalletSolana1, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_solana_signing_payload 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.models.wallet_solana_signing_payload.WalletSolanaSigningPayload(**data)

Bases: BaseModel

Payload for Solana wallet signing events. Carries the Solana signing address and timestamp; no network or transaction identifier.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of WalletSolanaSigningPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletSolanaSigningPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signed_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.wallet_solana_transaction_broadcast_payload 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.models.wallet_solana_transaction_broadcast_payload.WalletSolanaTransactionBroadcastPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.broadcast on Solana. Includes transaction_signature and omits address.

broadcast_at: datetime
classmethod from_dict(obj)

Create an instance of WalletSolanaTransactionBroadcastPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletSolanaTransactionBroadcastPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr

cdp.openapi_client.models.wallet_solana_transaction_confirmed_payload 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.models.wallet_solana_transaction_confirmed_payload.WalletSolanaTransactionConfirmedPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.confirmed on Solana. Includes transaction_signature and omits address.

confirmed_at: datetime
classmethod from_dict(obj)

Create an instance of WalletSolanaTransactionConfirmedPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletSolanaTransactionConfirmedPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr

cdp.openapi_client.models.wallet_solana_transaction_created_payload 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.models.wallet_solana_transaction_created_payload.WalletSolanaTransactionCreatedPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.created on Solana. Solana transaction events do not include an address.

created_at: datetime
classmethod from_dict(obj)

Create an instance of WalletSolanaTransactionCreatedPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletSolanaTransactionCreatedPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.wallet_solana_transaction_failed_payload 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.models.wallet_solana_transaction_failed_payload.WalletSolanaTransactionFailedPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.failed on Solana. Includes transaction_signature and omits address.

failed_at: datetime
classmethod from_dict(obj)

Create an instance of WalletSolanaTransactionFailedPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletSolanaTransactionFailedPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_signature: StrictStr

cdp.openapi_client.models.wallet_transaction_broadcast_event 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.models.wallet_transaction_broadcast_event.WalletTransactionBroadcastEvent(*args, **kwargs)

Bases: BaseModel

Delivered when a transaction is broadcast to the network. The payload is one of six variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing), each delivered as an EVM or Solana variant.

actual_instance: Optional[Union[APIKeyWalletEVM2, APIKeyWalletSolana2, UserWalletDelegatedSigningEVM2, UserWalletDelegatedSigningSolana2, UserWalletEVM2, UserWalletSolana2]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWalletEVM2]
oneof_schema_2_validator: Optional[APIKeyWalletSolana2]
oneof_schema_3_validator: Optional[UserWalletEVM2]
oneof_schema_4_validator: Optional[UserWalletSolana2]
oneof_schema_5_validator: Optional[UserWalletDelegatedSigningEVM2]
oneof_schema_6_validator: Optional[UserWalletDelegatedSigningSolana2]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWalletEVM2, APIKeyWalletSolana2, UserWalletDelegatedSigningEVM2, UserWalletDelegatedSigningSolana2, UserWalletEVM2, UserWalletSolana2, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_transaction_confirmed_event 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.models.wallet_transaction_confirmed_event.WalletTransactionConfirmedEvent(*args, **kwargs)

Bases: BaseModel

Delivered when a transaction is confirmed onchain. The payload is one of six variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing), each delivered as an EVM or Solana variant.

actual_instance: Optional[Union[APIKeyWalletEVM3, APIKeyWalletSolana3, UserWalletDelegatedSigningEVM3, UserWalletDelegatedSigningSolana3, UserWalletEVM3, UserWalletSolana3]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWalletEVM3]
oneof_schema_2_validator: Optional[APIKeyWalletSolana3]
oneof_schema_3_validator: Optional[UserWalletEVM3]
oneof_schema_4_validator: Optional[UserWalletSolana3]
oneof_schema_5_validator: Optional[UserWalletDelegatedSigningEVM3]
oneof_schema_6_validator: Optional[UserWalletDelegatedSigningSolana3]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWalletEVM3, APIKeyWalletSolana3, UserWalletDelegatedSigningEVM3, UserWalletDelegatedSigningSolana3, UserWalletEVM3, UserWalletSolana3, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_transaction_created_event 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.models.wallet_transaction_created_event.WalletTransactionCreatedEvent(*args, **kwargs)

Bases: BaseModel

Delivered when a transaction is created. The payload is one of six variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing), each delivered as an EVM or Solana variant.

actual_instance: Optional[Union[APIKeyWalletEVM, APIKeyWalletSolana, UserWalletDelegatedSigningEVM, UserWalletDelegatedSigningSolana, UserWalletEVM, UserWalletSolana]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWalletEVM]
oneof_schema_2_validator: Optional[APIKeyWalletSolana]
oneof_schema_3_validator: Optional[UserWalletEVM]
oneof_schema_4_validator: Optional[UserWalletSolana]
oneof_schema_5_validator: Optional[UserWalletDelegatedSigningEVM]
oneof_schema_6_validator: Optional[UserWalletDelegatedSigningSolana]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWalletEVM, APIKeyWalletSolana, UserWalletDelegatedSigningEVM, UserWalletDelegatedSigningSolana, UserWalletEVM, UserWalletSolana, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_transaction_failed_event 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.models.wallet_transaction_failed_event.WalletTransactionFailedEvent(*args, **kwargs)

Bases: BaseModel

Delivered when a transaction fails. The payload is one of six variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing), each delivered as an EVM or Solana variant.

actual_instance: Optional[Union[APIKeyWalletEVM4, APIKeyWalletSolana4, UserWalletDelegatedSigningEVM4, UserWalletDelegatedSigningSolana4, UserWalletEVM4, UserWalletSolana4]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWalletEVM4]
oneof_schema_2_validator: Optional[APIKeyWalletSolana4]
oneof_schema_3_validator: Optional[UserWalletEVM4]
oneof_schema_4_validator: Optional[UserWalletSolana4]
oneof_schema_5_validator: Optional[UserWalletDelegatedSigningEVM4]
oneof_schema_6_validator: Optional[UserWalletDelegatedSigningSolana4]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWalletEVM4, APIKeyWalletSolana4, UserWalletDelegatedSigningEVM4, UserWalletDelegatedSigningSolana4, UserWalletEVM4, UserWalletSolana4, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_transaction_pending_event 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.models.wallet_transaction_pending_event.WalletTransactionPendingEvent(*args, **kwargs)

Bases: BaseModel

Delivered when a transaction enters the pending state. EVM-only. The payload is one of three EVM wallet-type variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing).

actual_instance: Optional[Union[APIKeyWallet1, UserWallet1, UserWalletDelegatedSigning1]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWallet1]
oneof_schema_2_validator: Optional[UserWallet1]
oneof_schema_3_validator: Optional[UserWalletDelegatedSigning1]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWallet1, UserWallet1, UserWalletDelegatedSigning1, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_transaction_pending_payload 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.models.wallet_transaction_pending_payload.WalletTransactionPendingPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.pending. EVM-only. EIP-1559 fee fields are included.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of WalletTransactionPendingPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletTransactionPendingPayload from a JSON string

Return type:

Optional[Self]

max_fee_per_gas: StrictStr
max_priority_fee_per_gas: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
pending_since: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.wallet_transaction_replaced_event 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.models.wallet_transaction_replaced_event.WalletTransactionReplacedEvent(*args, **kwargs)

Bases: BaseModel

Delivered when a pending transaction is replaced (e.g. a fee bump). EVM-only. The payload is one of three EVM wallet-type variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing).

actual_instance: Optional[Union[APIKeyWallet, UserWallet, UserWalletDelegatedSigning]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWallet]
oneof_schema_2_validator: Optional[UserWallet]
oneof_schema_3_validator: Optional[UserWalletDelegatedSigning]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWallet, UserWallet, UserWalletDelegatedSigning, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_transaction_replaced_payload 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.models.wallet_transaction_replaced_payload.WalletTransactionReplacedPayload(**data)

Bases: BaseModel

Payload for wallet.transaction.replaced. EVM-only; Solana transactions are not replaceable.

address: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
classmethod from_dict(obj)

Create an instance of WalletTransactionReplacedPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletTransactionReplacedPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Network
replaced_at: datetime
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction_hash: StrictStr

cdp.openapi_client.models.wallet_transaction_signed_event 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.models.wallet_transaction_signed_event.WalletTransactionSignedEvent(*args, **kwargs)

Bases: BaseModel

Delivered when a transaction is signed. Emitted for both EVM and Solana wallets. The payload is one of six variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing), each delivered as an EVM or Solana variant.

actual_instance: Optional[Union[APIKeyWalletEVM1, APIKeyWalletSolana1, UserWalletDelegatedSigningEVM1, UserWalletDelegatedSigningSolana1, UserWalletEVM1, UserWalletSolana1]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWalletEVM1]
oneof_schema_2_validator: Optional[APIKeyWalletSolana1]
oneof_schema_3_validator: Optional[UserWalletEVM1]
oneof_schema_4_validator: Optional[UserWalletSolana1]
oneof_schema_5_validator: Optional[UserWalletDelegatedSigningEVM1]
oneof_schema_6_validator: Optional[UserWalletDelegatedSigningSolana1]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWalletEVM1, APIKeyWalletSolana1, UserWalletDelegatedSigningEVM1, UserWalletDelegatedSigningSolana1, UserWalletEVM1, UserWalletSolana1, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_typed_data_signed_event 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.models.wallet_typed_data_signed_event.WalletTypedDataSignedEvent(*args, **kwargs)

Bases: BaseModel

Delivered when EIP-712 typed data is signed. EVM-only. Uses the EVM signing payload. The payload is one of three EVM wallet-type variants: API Key Wallet, User Wallet, or User Wallet (Delegated Signing).

actual_instance: Optional[Union[APIKeyWallet2, UserWallet2, UserWalletDelegatedSigning2]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[APIKeyWallet2]
oneof_schema_2_validator: Optional[UserWallet2]
oneof_schema_3_validator: Optional[UserWalletDelegatedSigning2]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], APIKeyWallet2, UserWallet2, UserWalletDelegatedSigning2, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.wallet_user_event_payload 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.models.wallet_user_event_payload.WalletUserEventPayload(**data)

Bases: BaseModel

Payload for User Wallet events. The wallet is owned by an end user, identified by user_id. User Wallet actions do not include delegation_id.

classmethod from_dict(obj)

Create an instance of WalletUserEventPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletUserEventPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

user_id: StrictStr

cdp.openapi_client.models.webhook_event_list_response 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.models.webhook_event_list_response.WebhookEventListResponse(**data)

Bases: BaseModel

Response containing a list of webhook event delivery attempts.

events: List[WebhookEventResponse]
classmethod from_dict(obj)

Create an instance of WebhookEventListResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookEventListResponse from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.webhook_event_response 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.models.webhook_event_response.WebhookEventResponse(**data)

Bases: BaseModel

Details of a webhook event delivery attempt for a subscription.

created_at: datetime
event_id: StrictStr
event_type_name: StrictStr
classmethod from_dict(obj)

Create an instance of WebhookEventResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookEventResponse from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

response: Optional[WebhookEventResponseDetail]
retry_count: StrictInt
status: StrictStr
classmethod status_validate_enum(value)

Validates the enum

succeeded_at: Optional[datetime]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.webhook_event_response_detail 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.models.webhook_event_response_detail.WebhookEventResponseDetail(**data)

Bases: BaseModel

Details of the HTTP response received from the webhook target.

body: Optional[StrictStr]
elapsed_time_ms: Optional[StrictInt]
error_name: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of WebhookEventResponseDetail from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookEventResponseDetail from a JSON string

Return type:

Optional[Self]

http_code: Optional[StrictInt]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.webhook_subscription_list_response 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.models.webhook_subscription_list_response.WebhookSubscriptionListResponse(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of WebhookSubscriptionListResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookSubscriptionListResponse from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next_page_token: Optional[StrictStr]
subscriptions: List[WebhookSubscriptionResponse]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.webhook_subscription_request 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.models.webhook_subscription_request.WebhookSubscriptionRequest(**data)

Bases: BaseModel

Request to create a new webhook subscription with support for multi-label filtering.

description: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]]
event_types: List[EventType]
classmethod from_dict(obj)

Create an instance of WebhookSubscriptionRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookSubscriptionRequest from a JSON string

Return type:

Optional[Self]

is_enabled: StrictBool
labels: Optional[Dict[str, StrictStr]]
metadata: Optional[Dict[str, Annotated[str, Field(min_length=0, strict=True, max_length=500)]]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

target: WebhookTarget
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.webhook_subscription_response 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.models.webhook_subscription_response.WebhookSubscriptionResponse(**data)

Bases: BaseModel

Response containing webhook subscription details.

created_at: datetime
description: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]]
event_types: List[EventType]
classmethod from_dict(obj)

Create an instance of WebhookSubscriptionResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookSubscriptionResponse from a JSON string

Return type:

Optional[Self]

is_enabled: StrictBool
labels: Optional[Dict[str, StrictStr]]
metadata: Optional[WebhookSubscriptionResponseMetadata]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

secret: StrictStr
subscription_id: StrictStr
target: WebhookTarget
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: Optional[datetime]

cdp.openapi_client.models.webhook_subscription_response_metadata 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.models.webhook_subscription_response_metadata.WebhookSubscriptionResponseMetadata(**data)

Bases: BaseModel

Additional metadata for the subscription.

classmethod from_dict(obj)

Create an instance of WebhookSubscriptionResponseMetadata from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookSubscriptionResponseMetadata from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

secret: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.webhook_subscription_update_request 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.models.webhook_subscription_update_request.WebhookSubscriptionUpdateRequest(**data)

Bases: BaseModel

Request to update an existing webhook subscription.

description: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]]
event_types: List[EventType]
classmethod from_dict(obj)

Create an instance of WebhookSubscriptionUpdateRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookSubscriptionUpdateRequest from a JSON string

Return type:

Optional[Self]

is_enabled: StrictBool
labels: Optional[Dict[str, StrictStr]]
metadata: Optional[Dict[str, Annotated[str, Field(min_length=0, strict=True, max_length=500)]]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

target: WebhookTarget
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.webhook_target 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.models.webhook_target.WebhookTarget(**data)

Bases: BaseModel

Target configuration for webhook delivery. Specifies the destination URL and any custom headers to include in webhook requests.

classmethod from_dict(obj)

Create an instance of WebhookTarget from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookTarget from a JSON string

Return type:

Optional[Self]

headers: Optional[Dict[str, StrictStr]]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

url: Annotated[str, Field(min_length=11, strict=True, max_length=2048)]
classmethod url_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.x402_batch_settlement_channel_config 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.models.x402_batch_settlement_channel_config.X402BatchSettlementChannelConfig(**data)

Bases: BaseModel

Immutable configuration for an x402 batch-settlement payment channel. The EIP-712 hash of this struct produces the channelId used by all batch-settlement payloads.

classmethod from_dict(obj)

Create an instance of X402BatchSettlementChannelConfig from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementChannelConfig from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payer: Annotated[str, Field(strict=True)]
payer_authorizer: Annotated[str, Field(strict=True)]
classmethod payer_authorizer_validate_regular_expression(value)

Validates the regular expression

classmethod payer_validate_regular_expression(value)

Validates the regular expression

receiver: Annotated[str, Field(strict=True)]
receiver_authorizer: Annotated[str, Field(strict=True)]
classmethod receiver_authorizer_validate_regular_expression(value)

Validates the regular expression

classmethod receiver_validate_regular_expression(value)

Validates the regular expression

salt: Annotated[str, Field(strict=True)]
classmethod salt_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: Annotated[str, Field(strict=True)]
classmethod token_validate_regular_expression(value)

Validates the regular expression

withdraw_delay: Annotated[int, Field(le=2592000, strict=True, ge=900)]

cdp.openapi_client.models.x402_batch_settlement_claim 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.models.x402_batch_settlement_claim.X402BatchSettlementClaim(**data)

Bases: BaseModel

A single voucher claim within a batched on-chain claim transaction. Used by x402BatchSettlementClaimPayload.claims and by the server-enriched shape of x402BatchSettlementRefundPayload.claims. NOTE: the nested voucher here has a different shape from the top-level x402BatchSettlementVoucher schema. The top-level voucher is the signed cumulative-ceiling message sent by a client ({channelId, maxClaimableAmount, signature}). This nested voucher mirrors the on-chain claim struct ({channel: ChannelConfig, maxClaimableAmount}) that participates in the EIP-712 hash, with signature and totalClaimed as siblings rather than nested fields. The field names match the upstream x402 protocol and the on-chain Solidity struct; they cannot be renamed without breaking wire and EIP-712 compatibility.

classmethod from_dict(obj)

Create an instance of X402BatchSettlementClaim from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementClaim from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signature: Annotated[str, Field(strict=True)]
classmethod signature_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

total_claimed: Annotated[str, Field(strict=True)]
classmethod total_claimed_validate_regular_expression(value)

Validates the regular expression

voucher: X402BatchSettlementClaimVoucher

cdp.openapi_client.models.x402_batch_settlement_claim_payload 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.models.x402_batch_settlement_claim_payload.X402BatchSettlementClaimPayload(**data)

Bases: BaseModel

Server-to-facilitator request to batch on-chain claims of accumulated vouchers. claimAuthorizerSignature is optional; when absent the facilitator auto-signs with its receiver-authorizer key.

claim_authorizer_signature: Optional[Annotated[str, Field(strict=True)]]
classmethod claim_authorizer_signature_validate_regular_expression(value)

Validates the regular expression

claims: List[X402BatchSettlementClaim]
classmethod from_dict(obj)

Create an instance of X402BatchSettlementClaimPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementClaimPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.x402_batch_settlement_claim_voucher 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.models.x402_batch_settlement_claim_voucher.X402BatchSettlementClaimVoucher(**data)

Bases: BaseModel

The voucher to claim, identified by the channel config it was signed against and its cumulative ceiling. Field shape mirrors the on-chain claim struct.

channel: X402BatchSettlementChannelConfig
classmethod from_dict(obj)

Create an instance of X402BatchSettlementClaimVoucher from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementClaimVoucher from a JSON string

Return type:

Optional[Self]

max_claimable_amount: Annotated[str, Field(strict=True)]
classmethod max_claimable_amount_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_batch_settlement_deposit_payload 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.models.x402_batch_settlement_deposit_payload.X402BatchSettlementDepositPayload(**data)

Bases: BaseModel

Sent on the first request to fund a channel via an ERC-3009 receiveWithAuthorization deposit.

channel_config: X402BatchSettlementChannelConfig
deposit: X402BatchSettlementDepositPayloadDeposit
classmethod from_dict(obj)

Create an instance of X402BatchSettlementDepositPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementDepositPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

voucher: X402BatchSettlementVoucher

cdp.openapi_client.models.x402_batch_settlement_deposit_payload_deposit 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.models.x402_batch_settlement_deposit_payload_deposit.X402BatchSettlementDepositPayloadDeposit(**data)

Bases: BaseModel

The deposit amount and asset-transfer authorization that funds the channel.

amount: Annotated[str, Field(strict=True)]
classmethod amount_validate_regular_expression(value)

Validates the regular expression

authorization: X402BatchSettlementDepositPayloadDepositAuthorization
classmethod from_dict(obj)

Create an instance of X402BatchSettlementDepositPayloadDeposit from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementDepositPayloadDeposit from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_batch_settlement_deposit_payload_deposit_authorization 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.models.x402_batch_settlement_deposit_payload_deposit_authorization.X402BatchSettlementDepositPayloadDepositAuthorization(**data)

Bases: BaseModel

The asset-transfer authorization for the deposit. Currently only ERC-3009 is supported.

erc3009_authorization: Optional[X402BatchSettlementDepositPayloadDepositAuthorizationErc3009Authorization]
classmethod from_dict(obj)

Create an instance of X402BatchSettlementDepositPayloadDepositAuthorization from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementDepositPayloadDepositAuthorization from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_batch_settlement_deposit_payload_deposit_authorization_erc3009_authorization 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.models.x402_batch_settlement_deposit_payload_deposit_authorization_erc3009_authorization.X402BatchSettlementDepositPayloadDepositAuthorizationErc3009Authorization(**data)

Bases: BaseModel

An ERC-3009 receiveWithAuthorization message authorizing the channel-funding transfer.

classmethod from_dict(obj)

Create an instance of X402BatchSettlementDepositPayloadDepositAuthorizationErc3009Authorization from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementDepositPayloadDepositAuthorizationErc3009Authorization from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

salt: Annotated[str, Field(strict=True)]
classmethod salt_validate_regular_expression(value)

Validates the regular expression

signature: Annotated[str, Field(strict=True)]
classmethod signature_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

valid_after: StrictStr
valid_before: StrictStr

cdp.openapi_client.models.x402_batch_settlement_evm_payload 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.models.x402_batch_settlement_evm_payload.X402BatchSettlementEvmPayload(*args, **kwargs)

Bases: BaseModel

The x402 protocol batch-settlement scheme payload for EVM networks. The batch-settlement scheme uses pre-funded payment channels with off-chain cumulative-ceiling vouchers, allowing servers to batch-claim accumulated value in a single on-chain transaction. The payload is a discriminated union on the type field with five variants: - deposit: client-initiated channel funding via ERC-3009. - voucher: client-side cumulative voucher against an already-funded channel. - refund: cooperative refund request. The client emits a minimal shape (just channelConfig + voucher, with an optional amount); a mediating server enriches it with amount, refundNonce, and claims before forwarding to the facilitator. Authorizer signatures are optional — the facilitator auto-signs when absent. - claim: server-to-facilitator request to batch on-chain voucher claims. - settle: server-to-facilitator request to transfer claimed funds to the receiver. For more details, see [batch-settlement specs](https://github.com/x402-foundation/x402/tree/main/specs/schemes/batch-settlement).

actual_instance: Optional[Union[X402BatchSettlementClaimPayload, X402BatchSettlementDepositPayload, X402BatchSettlementRefundPayload, X402BatchSettlementSettlePayload, X402BatchSettlementVoucherPayload]]
classmethod actual_instance_must_validate_oneof(v)
discriminator_value_class_map: Dict[str, str]
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[X402BatchSettlementDepositPayload]
oneof_schema_2_validator: Optional[X402BatchSettlementVoucherPayload]
oneof_schema_3_validator: Optional[X402BatchSettlementRefundPayload]
oneof_schema_4_validator: Optional[X402BatchSettlementClaimPayload]
oneof_schema_5_validator: Optional[X402BatchSettlementSettlePayload]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], X402BatchSettlementClaimPayload, X402BatchSettlementDepositPayload, X402BatchSettlementRefundPayload, X402BatchSettlementSettlePayload, X402BatchSettlementVoucherPayload, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.x402_batch_settlement_refund_payload 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.models.x402_batch_settlement_refund_payload.X402BatchSettlementRefundPayload(**data)

Bases: BaseModel

A cooperative refund request. The client emits the minimal shape (just channelConfig and voucher, with an optional amount). A mediating server enriches the payload with amount, refundNonce, and claims before forwarding to the facilitator. Authorizer signatures are optional — the facilitator auto-signs when absent. Field presence determines which shape was sent; the facilitator dispatches accordingly.

amount: Optional[Annotated[str, Field(strict=True)]]
classmethod amount_validate_regular_expression(value)

Validates the regular expression

channel_config: X402BatchSettlementChannelConfig
claim_authorizer_signature: Optional[Annotated[str, Field(strict=True)]]
classmethod claim_authorizer_signature_validate_regular_expression(value)

Validates the regular expression

claims: Optional[List[X402BatchSettlementClaim]]
classmethod from_dict(obj)

Create an instance of X402BatchSettlementRefundPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementRefundPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

refund_authorizer_signature: Optional[Annotated[str, Field(strict=True)]]
classmethod refund_authorizer_signature_validate_regular_expression(value)

Validates the regular expression

refund_nonce: Optional[Annotated[str, Field(strict=True)]]
classmethod refund_nonce_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

voucher: X402BatchSettlementVoucher

cdp.openapi_client.models.x402_batch_settlement_settle_payload 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.models.x402_batch_settlement_settle_payload.X402BatchSettlementSettlePayload(**data)

Bases: BaseModel

Server-to-facilitator request to transfer claimed funds for a (receiver, token) pair to the receiver wallet.

classmethod from_dict(obj)

Create an instance of X402BatchSettlementSettlePayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementSettlePayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

receiver: Annotated[str, Field(strict=True)]
classmethod receiver_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: Annotated[str, Field(strict=True)]
classmethod token_validate_regular_expression(value)

Validates the regular expression

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

cdp.openapi_client.models.x402_batch_settlement_voucher 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.models.x402_batch_settlement_voucher.X402BatchSettlementVoucher(**data)

Bases: BaseModel

A signed cumulative-ceiling voucher for an x402 batch-settlement channel. maxClaimableAmount is monotonically increasing across requests in the same channel; the receiver may claim any amount up to this ceiling.

channel_id: Annotated[str, Field(strict=True)]
classmethod channel_id_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of X402BatchSettlementVoucher from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementVoucher from a JSON string

Return type:

Optional[Self]

max_claimable_amount: Annotated[str, Field(strict=True)]
classmethod max_claimable_amount_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signature: Annotated[str, Field(strict=True)]
classmethod signature_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_batch_settlement_voucher_payload 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.models.x402_batch_settlement_voucher_payload.X402BatchSettlementVoucherPayload(**data)

Bases: BaseModel

Sent on subsequent requests against an already-funded channel; carries only the latest cumulative voucher.

channel_config: X402BatchSettlementChannelConfig
classmethod from_dict(obj)

Create an instance of X402BatchSettlementVoucherPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402BatchSettlementVoucherPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

voucher: X402BatchSettlementVoucher

cdp.openapi_client.models.x402_discovery_merchant_response 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.models.x402_discovery_merchant_response.X402DiscoveryMerchantResponse(**data)

Bases: BaseModel

Response containing x402 resources associated with a merchant payment address. The resources list is empty when no active resources are found.

classmethod from_dict(obj)

Create an instance of X402DiscoveryMerchantResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402DiscoveryMerchantResponse from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pagination: X402DiscoveryMerchantResponsePagination
pay_to: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
resources: List[X402DiscoveryResource]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

x402_version: X402Version

cdp.openapi_client.models.x402_discovery_merchant_response_pagination 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.models.x402_discovery_merchant_response_pagination.X402DiscoveryMerchantResponsePagination(**data)

Bases: BaseModel

Pagination information for the response.

classmethod from_dict(obj)

Create an instance of X402DiscoveryMerchantResponsePagination from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402DiscoveryMerchantResponsePagination from a JSON string

Return type:

Optional[Self]

limit: Optional[StrictInt]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offset: Optional[StrictInt]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

total: Optional[StrictInt]

cdp.openapi_client.models.x402_discovery_resource 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.models.x402_discovery_resource.X402DiscoveryResource(**data)

Bases: BaseModel

A single discovered x402 resource.

accepts: Optional[List[X402PaymentRequirements]]
description: Optional[StrictStr]
extensions: Optional[Dict[str, Any]]
classmethod from_dict(obj)

Create an instance of X402DiscoveryResource from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402DiscoveryResource from a JSON string

Return type:

Optional[Self]

icon_url: Optional[Annotated[str, Field(min_length=11, strict=True, max_length=2048)]]
classmethod icon_url_validate_regular_expression(value)

Validates the regular expression

last_updated: Optional[datetime]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

quality: Optional[X402ResourceQuality]
resource: StrictStr
service_name: Optional[StrictStr]
tags: Optional[List[StrictStr]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr
classmethod type_validate_enum(value)

Validates the enum

x402_version: X402Version

cdp.openapi_client.models.x402_discovery_resources_response 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.models.x402_discovery_resources_response.X402DiscoveryResourcesResponse(**data)

Bases: BaseModel

Response containing discovered x402 resources.

classmethod from_dict(obj)

Create an instance of X402DiscoveryResourcesResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402DiscoveryResourcesResponse from a JSON string

Return type:

Optional[Self]

items: List[X402DiscoveryResource]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pagination: X402DiscoveryResourcesResponsePagination
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

x402_version: X402Version

cdp.openapi_client.models.x402_discovery_resources_response_pagination 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.models.x402_discovery_resources_response_pagination.X402DiscoveryResourcesResponsePagination(**data)

Bases: BaseModel

Pagination information for the response.

classmethod from_dict(obj)

Create an instance of X402DiscoveryResourcesResponsePagination from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402DiscoveryResourcesResponsePagination from a JSON string

Return type:

Optional[Self]

limit: Optional[StrictInt]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offset: Optional[StrictInt]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

total: Optional[StrictInt]

cdp.openapi_client.models.x402_exact_evm_payload 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.models.x402_exact_evm_payload.X402ExactEvmPayload(**data)

Bases: BaseModel

The x402 protocol exact scheme payload for EVM networks. The scheme is implemented using ERC-3009. For more details, please see [EVM Exact Scheme Details](https://github.com/coinbase/x402/blob/main/specs/schemes/exact/scheme_exact_evm.md).

authorization: X402ExactEvmPayloadAuthorization
classmethod from_dict(obj)

Create an instance of X402ExactEvmPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ExactEvmPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

signature: Annotated[str, Field(strict=True)]
classmethod signature_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_exact_evm_payload_authorization 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.models.x402_exact_evm_payload_authorization.X402ExactEvmPayloadAuthorization(**data)

Bases: BaseModel

The authorization data for the ERC-3009 authorization message.

classmethod from_dict(obj)

Create an instance of X402ExactEvmPayloadAuthorization from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ExactEvmPayloadAuthorization from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nonce: Annotated[str, Field(strict=True)]
classmethod nonce_validate_regular_expression(value)

Validates the regular expression

to: Annotated[str, Field(strict=True)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

classmethod to_validate_regular_expression(value)

Validates the regular expression

valid_after: StrictStr
valid_before: StrictStr
value: StrictStr
var_from: Annotated[str, Field(strict=True)]
classmethod var_from_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.x402_exact_evm_permit2_payload 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.models.x402_exact_evm_permit2_payload.X402ExactEvmPermit2Payload(**data)

Bases: BaseModel

The x402 protocol exact scheme payload for EVM networks using Permit2. Permit2 is a universal token approval mechanism that works with any ERC-20 token, unlike ERC-3009 which requires token-level support.

classmethod from_dict(obj)

Create an instance of X402ExactEvmPermit2Payload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ExactEvmPermit2Payload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

permit2_authorization: X402ExactEvmPermit2PayloadPermit2Authorization
signature: Annotated[str, Field(strict=True)]
classmethod signature_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_exact_evm_permit2_payload_permit2_authorization 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.models.x402_exact_evm_permit2_payload_permit2_authorization.X402ExactEvmPermit2PayloadPermit2Authorization(**data)

Bases: BaseModel

The authorization data for the Permit2 PermitWitnessTransferFrom message.

deadline: StrictStr
classmethod from_dict(obj)

Create an instance of X402ExactEvmPermit2PayloadPermit2Authorization from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ExactEvmPermit2PayloadPermit2Authorization from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nonce: Annotated[str, Field(strict=True)]
classmethod nonce_validate_regular_expression(value)

Validates the regular expression

permitted: X402ExactEvmPermit2PayloadPermit2AuthorizationPermitted
spender: Annotated[str, Field(strict=True)]
classmethod spender_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

var_from: Annotated[str, Field(strict=True)]
classmethod var_from_validate_regular_expression(value)

Validates the regular expression

witness: X402ExactEvmPermit2PayloadPermit2AuthorizationWitness

cdp.openapi_client.models.x402_exact_evm_permit2_payload_permit2_authorization_permitted 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.models.x402_exact_evm_permit2_payload_permit2_authorization_permitted.X402ExactEvmPermit2PayloadPermit2AuthorizationPermitted(**data)

Bases: BaseModel

The token permissions for the transfer.

amount: StrictStr
classmethod from_dict(obj)

Create an instance of X402ExactEvmPermit2PayloadPermit2AuthorizationPermitted from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ExactEvmPermit2PayloadPermit2AuthorizationPermitted from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: Annotated[str, Field(strict=True)]
classmethod token_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.x402_exact_evm_permit2_payload_permit2_authorization_witness 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.models.x402_exact_evm_permit2_payload_permit2_authorization_witness.X402ExactEvmPermit2PayloadPermit2AuthorizationWitness(**data)

Bases: BaseModel

The witness data containing payment details.

extra: Optional[Annotated[str, Field(strict=True)]]
classmethod extra_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of X402ExactEvmPermit2PayloadPermit2AuthorizationWitness from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ExactEvmPermit2PayloadPermit2AuthorizationWitness from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to: Annotated[str, Field(strict=True)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

classmethod to_validate_regular_expression(value)

Validates the regular expression

valid_after: StrictStr

cdp.openapi_client.models.x402_exact_solana_payload 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.models.x402_exact_solana_payload.X402ExactSolanaPayload(**data)

Bases: BaseModel

The x402 protocol exact scheme payload for Solana networks. For more details, please see [Solana Exact Scheme Details](https://github.com/coinbase/x402/blob/main/specs/schemes/exact/scheme_exact_svm.md).

classmethod from_dict(obj)

Create an instance of X402ExactSolanaPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ExactSolanaPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: StrictStr

cdp.openapi_client.models.x402_mcp_error 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.models.x402_mcp_error.X402McpError(**data)

Bases: BaseModel

JSON-RPC 2.0 error object.

code: StrictInt
data: Optional[Dict[str, Any]]
classmethod from_dict(obj)

Create an instance of X402McpError from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402McpError from a JSON string

Return type:

Optional[Self]

message: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_mcp_request 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.models.x402_mcp_request.X402McpRequest(**data)

Bases: BaseModel

A JSON-RPC 2.0 request for the Model Context Protocol.

classmethod from_dict(obj)

Create an instance of X402McpRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402McpRequest from a JSON string

Return type:

Optional[Self]

id: Optional[X402McpRequestId]
jsonrpc: StrictStr
classmethod jsonrpc_validate_enum(value)

Validates the enum

method: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

params: Optional[Dict[str, Any]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_mcp_request_id 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.models.x402_mcp_request_id.X402McpRequestId(*args, **kwargs)

Bases: BaseModel

Request identifier.

actual_instance: Optional[Union[int, str]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[StrictStr]
oneof_schema_2_validator: Optional[StrictInt]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], int, str, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.x402_mcp_response 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.models.x402_mcp_response.X402McpResponse(**data)

Bases: BaseModel

A JSON-RPC 2.0 response for the Model Context Protocol.

error: Optional[X402McpError]
classmethod from_dict(obj)

Create an instance of X402McpResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402McpResponse from a JSON string

Return type:

Optional[Self]

id: Optional[X402McpResponseId]
jsonrpc: StrictStr
classmethod jsonrpc_validate_enum(value)

Validates the enum

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[Dict[str, Any]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_mcp_response_id 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.models.x402_mcp_response_id.X402McpResponseId(*args, **kwargs)

Bases: BaseModel

Request identifier (matches the request ID, null for notifications).

actual_instance: Optional[Union[int, str]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[StrictStr]
oneof_schema_2_validator: Optional[StrictInt]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], int, str, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.x402_payment_payload 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.models.x402_payment_payload.X402PaymentPayload(*args, **kwargs)

Bases: BaseModel

The x402 protocol payment payload that the client attaches to x402-paid API requests to the resource server in the X-PAYMENT header. For EVM networks, smart account signatures can be longer than 65 bytes.

actual_instance: Optional[Union[X402V1PaymentPayload, X402V2PaymentPayload]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[X402V2PaymentPayload]
oneof_schema_2_validator: Optional[X402V1PaymentPayload]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], X402V1PaymentPayload, X402V2PaymentPayload, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.x402_payment_requirements 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.models.x402_payment_requirements.X402PaymentRequirements(*args, **kwargs)

Bases: BaseModel

The x402 protocol payment requirements that the resource server expects the client’s payment payload to meet.

actual_instance: Optional[Union[X402V1PaymentRequirements, X402V2PaymentRequirements]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[X402V2PaymentRequirements]
oneof_schema_2_validator: Optional[X402V1PaymentRequirements]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], X402V1PaymentRequirements, X402V2PaymentRequirements, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.x402_resource_info 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.models.x402_resource_info.X402ResourceInfo(**data)

Bases: BaseModel

Describes the resource being accessed in x402 protocol.

description: Optional[Annotated[str, Field(min_length=0, strict=True, max_length=500)]]
classmethod from_dict(obj)

Create an instance of X402ResourceInfo from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ResourceInfo from a JSON string

Return type:

Optional[Self]

mime_type: Optional[StrictStr]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

url: Optional[StrictStr]

cdp.openapi_client.models.x402_resource_quality 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.models.x402_resource_quality.X402ResourceQuality(**data)

Bases: BaseModel

Quality metrics for a discovered x402 resource.

classmethod from_dict(obj)

Create an instance of X402ResourceQuality from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ResourceQuality from a JSON string

Return type:

Optional[Self]

l30_days_total_calls: Optional[StrictInt]
l30_days_unique_payers: Optional[StrictInt]
last_called_at: Optional[datetime]
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_search_resources_response 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.models.x402_search_resources_response.X402SearchResourcesResponse(**data)

Bases: BaseModel

Response from a search for x402 resources.

classmethod from_dict(obj)

Create an instance of X402SearchResourcesResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402SearchResourcesResponse from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

partial_results: StrictBool
resources: List[X402DiscoveryResource]
search_method: Optional[StrictStr]
classmethod search_method_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

x402_version: X402Version

cdp.openapi_client.models.x402_settle_error_reason 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.models.x402_settle_error_reason.X402SettleErrorReason(value)

Bases: str, Enum

The reason the payment settlement errored on the x402 protocol.

AMOUNT_TOO_LOW = 'amount_too_low'
BATCH_SETTLEMENT_CHANNEL_BUSY = 'batch_settlement_channel_busy'
BATCH_SETTLEMENT_CHARGE_EXCEEDS_SIGNED_CUMULATIVE = 'batch_settlement_charge_exceeds_signed_cumulative'
BATCH_SETTLEMENT_CUMULATIVE_AMOUNT_MISMATCH = 'batch_settlement_cumulative_amount_mismatch'
BATCH_SETTLEMENT_REFUND_AMOUNT_EXCEEDS_BALANCE = 'batch_settlement_refund_amount_exceeds_balance'
BATCH_SETTLEMENT_REFUND_AMOUNT_INVALID = 'batch_settlement_refund_amount_invalid'
BATCH_SETTLEMENT_REFUND_NO_BALANCE = 'batch_settlement_refund_no_balance'
DUPLICATE_SETTLEMENT = 'duplicate_settlement'
ERC20_APPROVAL_ASSET_MISMATCH = 'erc20_approval_asset_mismatch'
ERC20_APPROVAL_BROADCAST_FAILED = 'erc20_approval_broadcast_failed'
ERC20_APPROVAL_FROM_MISMATCH = 'erc20_approval_from_mismatch'
ERC20_APPROVAL_INSUFFICIENT_ETH_FOR_GAS = 'erc20_approval_insufficient_eth_for_gas'
ERC20_APPROVAL_SPENDER_NOT_PERMIT2 = 'erc20_approval_spender_not_permit2'
ERC20_APPROVAL_TX_FAILED = 'erc20_approval_tx_failed'
ERC20_APPROVAL_TX_INVALID_SIGNATURE = 'erc20_approval_tx_invalid_signature'
ERC20_APPROVAL_TX_PARSE_FAILED = 'erc20_approval_tx_parse_failed'
ERC20_APPROVAL_TX_SIGNER_MISMATCH = 'erc20_approval_tx_signer_mismatch'
ERC20_APPROVAL_TX_WRONG_SELECTOR = 'erc20_approval_tx_wrong_selector'
ERC20_APPROVAL_TX_WRONG_SPENDER = 'erc20_approval_tx_wrong_spender'
ERC20_APPROVAL_TX_WRONG_TARGET = 'erc20_approval_tx_wrong_target'
INSUFFICIENT_FUNDS = 'insufficient_funds'
INVALID_AMOUNT = 'invalid_amount'
INVALID_BATCH_SETTLEMENT_EVM_AUTHORIZER_ADDRESS_MISMATCH = 'invalid_batch_settlement_evm_authorizer_address_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_CHANNEL_ID_MISMATCH = 'invalid_batch_settlement_evm_channel_id_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_CHANNEL_NOT_FOUND = 'invalid_batch_settlement_evm_channel_not_found'
INVALID_BATCH_SETTLEMENT_EVM_CHANNEL_STATE_READ_FAILED = 'invalid_batch_settlement_evm_channel_state_read_failed'
INVALID_BATCH_SETTLEMENT_EVM_CLAIM_PAYLOAD = 'invalid_batch_settlement_evm_claim_payload'
INVALID_BATCH_SETTLEMENT_EVM_CLAIM_SIMULATION_FAILED = 'invalid_batch_settlement_evm_claim_simulation_failed'
INVALID_BATCH_SETTLEMENT_EVM_CLAIM_TRANSACTION_FAILED = 'invalid_batch_settlement_evm_claim_transaction_failed'
INVALID_BATCH_SETTLEMENT_EVM_CUMULATIVE_BELOW_CLAIMED = 'invalid_batch_settlement_evm_cumulative_below_claimed'
INVALID_BATCH_SETTLEMENT_EVM_CUMULATIVE_EXCEEDS_BALANCE = 'invalid_batch_settlement_evm_cumulative_exceeds_balance'
INVALID_BATCH_SETTLEMENT_EVM_DEPOSIT_PAYLOAD = 'invalid_batch_settlement_evm_deposit_payload'
INVALID_BATCH_SETTLEMENT_EVM_DEPOSIT_SIMULATION_FAILED = 'invalid_batch_settlement_evm_deposit_simulation_failed'
INVALID_BATCH_SETTLEMENT_EVM_DEPOSIT_TRANSACTION_FAILED = 'invalid_batch_settlement_evm_deposit_transaction_failed'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_AMOUNT_MISMATCH = 'invalid_batch_settlement_evm_eip2612_amount_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_ASSET_MISMATCH = 'invalid_batch_settlement_evm_eip2612_asset_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_DEADLINE_EXPIRED = 'invalid_batch_settlement_evm_eip2612_deadline_expired'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_INVALID_FORMAT = 'invalid_batch_settlement_evm_eip2612_invalid_format'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_INVALID_SIGNATURE = 'invalid_batch_settlement_evm_eip2612_invalid_signature'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_OWNER_MISMATCH = 'invalid_batch_settlement_evm_eip2612_owner_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_SPENDER_MISMATCH = 'invalid_batch_settlement_evm_eip2612_spender_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_ASSET_MISMATCH = 'invalid_batch_settlement_evm_erc20_approval_asset_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_BROADCAST_FAILED = 'invalid_batch_settlement_evm_erc20_approval_broadcast_failed'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_FROM_MISMATCH = 'invalid_batch_settlement_evm_erc20_approval_from_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_INVALID_FORMAT = 'invalid_batch_settlement_evm_erc20_approval_invalid_format'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_UNAVAILABLE = 'invalid_batch_settlement_evm_erc20_approval_unavailable'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_WRONG_SPENDER = 'invalid_batch_settlement_evm_erc20_approval_wrong_spender'
INVALID_BATCH_SETTLEMENT_EVM_ERC3009_AUTHORIZATION_REQUIRED = 'invalid_batch_settlement_evm_erc3009_authorization_required'
INVALID_BATCH_SETTLEMENT_EVM_INSUFFICIENT_BALANCE = 'invalid_batch_settlement_evm_insufficient_balance'
INVALID_BATCH_SETTLEMENT_EVM_MISSING_EIP712_DOMAIN = 'invalid_batch_settlement_evm_missing_eip712_domain'
INVALID_BATCH_SETTLEMENT_EVM_NETWORK_MISMATCH = 'invalid_batch_settlement_evm_network_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_PAYLOAD_AUTHORIZATION_VALID_AFTER = 'invalid_batch_settlement_evm_payload_authorization_valid_after'
INVALID_BATCH_SETTLEMENT_EVM_PAYLOAD_AUTHORIZATION_VALID_BEFORE = 'invalid_batch_settlement_evm_payload_authorization_valid_before'
INVALID_BATCH_SETTLEMENT_EVM_PAYLOAD_TYPE = 'invalid_batch_settlement_evm_payload_type'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_ALLOWANCE_REQUIRED = 'invalid_batch_settlement_evm_permit2_allowance_required'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_AMOUNT_MISMATCH = 'invalid_batch_settlement_evm_permit2_amount_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_AUTHORIZATION_REQUIRED = 'invalid_batch_settlement_evm_permit2_authorization_required'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_DEADLINE_EXPIRED = 'invalid_batch_settlement_evm_permit2_deadline_expired'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_INVALID_SIGNATURE = 'invalid_batch_settlement_evm_permit2_invalid_signature'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_INVALID_SPENDER = 'invalid_batch_settlement_evm_permit2_invalid_spender'
INVALID_BATCH_SETTLEMENT_EVM_RECEIVER_AUTHORIZER_MISMATCH = 'invalid_batch_settlement_evm_receiver_authorizer_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_RECEIVER_MISMATCH = 'invalid_batch_settlement_evm_receiver_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_RECEIVE_AUTHORIZATION_SIGNATURE = 'invalid_batch_settlement_evm_receive_authorization_signature'
INVALID_BATCH_SETTLEMENT_EVM_REFUND_PAYLOAD = 'invalid_batch_settlement_evm_refund_payload'
INVALID_BATCH_SETTLEMENT_EVM_REFUND_SIMULATION_FAILED = 'invalid_batch_settlement_evm_refund_simulation_failed'
INVALID_BATCH_SETTLEMENT_EVM_REFUND_TRANSACTION_FAILED = 'invalid_batch_settlement_evm_refund_transaction_failed'
INVALID_BATCH_SETTLEMENT_EVM_RPC_READ_FAILED = 'invalid_batch_settlement_evm_rpc_read_failed'
INVALID_BATCH_SETTLEMENT_EVM_SCHEME = 'invalid_batch_settlement_evm_scheme'
INVALID_BATCH_SETTLEMENT_EVM_SETTLE_PAYLOAD = 'invalid_batch_settlement_evm_settle_payload'
INVALID_BATCH_SETTLEMENT_EVM_SETTLE_SIMULATION_FAILED = 'invalid_batch_settlement_evm_settle_simulation_failed'
INVALID_BATCH_SETTLEMENT_EVM_SETTLE_TRANSACTION_FAILED = 'invalid_batch_settlement_evm_settle_transaction_failed'
INVALID_BATCH_SETTLEMENT_EVM_TOKEN_MISMATCH = 'invalid_batch_settlement_evm_token_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_TRANSACTION_REVERTED = 'invalid_batch_settlement_evm_transaction_reverted'
INVALID_BATCH_SETTLEMENT_EVM_UNKNOWN_SETTLE_ACTION = 'invalid_batch_settlement_evm_unknown_settle_action'
INVALID_BATCH_SETTLEMENT_EVM_VOUCHER_PAYLOAD = 'invalid_batch_settlement_evm_voucher_payload'
INVALID_BATCH_SETTLEMENT_EVM_VOUCHER_SIGNATURE = 'invalid_batch_settlement_evm_voucher_signature'
INVALID_BATCH_SETTLEMENT_EVM_WAIT_FOR_RECEIPT_FAILED = 'invalid_batch_settlement_evm_wait_for_receipt_failed'
INVALID_BATCH_SETTLEMENT_EVM_WITHDRAW_DELAY_MISMATCH = 'invalid_batch_settlement_evm_withdraw_delay_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_WITHDRAW_DELAY_OUT_OF_RANGE = 'invalid_batch_settlement_evm_withdraw_delay_out_of_range'
INVALID_BAZAAR_EXTENSION = 'invalid_bazaar_extension'
INVALID_ERC20_APPROVAL_EXTENSION_FORMAT = 'invalid_erc20_approval_extension_format'
INVALID_EXACT_EVM_AUTHORIZATION_VALUE = 'invalid_exact_evm_authorization_value'
INVALID_EXACT_EVM_EIP3009_NOT_SUPPORTED = 'invalid_exact_evm_eip3009_not_supported'
INVALID_EXACT_EVM_EXTRA_FIELD = 'invalid_exact_evm_extra_field'
INVALID_EXACT_EVM_FAILED_TO_CHECK_DEPLOYMENT = 'invalid_exact_evm_failed_to_check_deployment'
INVALID_EXACT_EVM_FAILED_TO_CHECK_NONCE = 'invalid_exact_evm_failed_to_check_nonce'
INVALID_EXACT_EVM_FAILED_TO_EXECUTE_TRANSFER = 'invalid_exact_evm_failed_to_execute_transfer'
INVALID_EXACT_EVM_FAILED_TO_GET_BALANCE = 'invalid_exact_evm_failed_to_get_balance'
INVALID_EXACT_EVM_FAILED_TO_GET_NETWORK_CONFIG = 'invalid_exact_evm_failed_to_get_network_config'
INVALID_EXACT_EVM_FAILED_TO_GET_RECEIPT = 'invalid_exact_evm_failed_to_get_receipt'
INVALID_EXACT_EVM_FAILED_TO_PARSE_SIGNATURE = 'invalid_exact_evm_failed_to_parse_signature'
INVALID_EXACT_EVM_FAILED_TO_VERIFY_SIGNATURE = 'invalid_exact_evm_failed_to_verify_signature'
INVALID_EXACT_EVM_INSUFFICIENT_BALANCE = 'invalid_exact_evm_insufficient_balance'
INVALID_EXACT_EVM_INSUFFICIENT_FUNDS = 'invalid_exact_evm_insufficient_funds'
INVALID_EXACT_EVM_MISSING_EIP712_DOMAIN = 'invalid_exact_evm_missing_eip712_domain'
INVALID_EXACT_EVM_NETWORK_MISMATCH = 'invalid_exact_evm_network_mismatch'
INVALID_EXACT_EVM_NONCE_ALREADY_USED = 'invalid_exact_evm_nonce_already_used'
INVALID_EXACT_EVM_PAYLOAD = 'invalid_exact_evm_payload'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_FROM_ADDRESS_KYT = 'invalid_exact_evm_payload_authorization_from_address_kyt'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_TO_ADDRESS_KYT = 'invalid_exact_evm_payload_authorization_to_address_kyt'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_TYPED_DATA_MESSAGE = 'invalid_exact_evm_payload_authorization_typed_data_message'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALID_AFTER = 'invalid_exact_evm_payload_authorization_valid_after'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALID_BEFORE = 'invalid_exact_evm_payload_authorization_valid_before'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALUE = 'invalid_exact_evm_payload_authorization_value'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALUE_MISMATCH = 'invalid_exact_evm_payload_authorization_value_mismatch'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALUE_TOO_LOW = 'invalid_exact_evm_payload_authorization_value_too_low'
INVALID_EXACT_EVM_PAYLOAD_MISSING_SIGNATURE = 'invalid_exact_evm_payload_missing_signature'
INVALID_EXACT_EVM_PAYLOAD_RECIPIENT_MISMATCH = 'invalid_exact_evm_payload_recipient_mismatch'
INVALID_EXACT_EVM_PAYLOAD_SIGNATURE = 'invalid_exact_evm_payload_signature'
INVALID_EXACT_EVM_PAYLOAD_SIGNATURE_ADDRESS = 'invalid_exact_evm_payload_signature_address'
INVALID_EXACT_EVM_PAYLOAD_UNDEPLOYED_SMART_WALLET = 'invalid_exact_evm_payload_undeployed_smart_wallet'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_ALLOWANCE_REQUIRED = 'invalid_exact_evm_permit2_payload_allowance_required'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_AMOUNT = 'invalid_exact_evm_permit2_payload_amount'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_DEADLINE = 'invalid_exact_evm_permit2_payload_deadline'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_RECIPIENT = 'invalid_exact_evm_permit2_payload_recipient'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_SIGNATURE = 'invalid_exact_evm_permit2_payload_signature'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_SPENDER = 'invalid_exact_evm_permit2_payload_spender'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_VALID_AFTER = 'invalid_exact_evm_permit2_payload_valid_after'
INVALID_EXACT_EVM_RECIPIENT_MISMATCH = 'invalid_exact_evm_recipient_mismatch'
INVALID_EXACT_EVM_REQUIRED_AMOUNT = 'invalid_exact_evm_required_amount'
INVALID_EXACT_EVM_SCHEME = 'invalid_exact_evm_scheme'
INVALID_EXACT_EVM_SIGNATURE = 'invalid_exact_evm_signature'
INVALID_EXACT_EVM_SIGNATURE_FORMAT = 'invalid_exact_evm_signature_format'
INVALID_EXACT_EVM_TOKEN_NAME_MISMATCH = 'invalid_exact_evm_token_name_mismatch'
INVALID_EXACT_EVM_TOKEN_VERSION_MISMATCH = 'invalid_exact_evm_token_version_mismatch'
INVALID_EXACT_EVM_TRANSACTION_FAILED = 'invalid_exact_evm_transaction_failed'
INVALID_EXACT_EVM_TRANSACTION_SIMULATION_FAILED = 'invalid_exact_evm_transaction_simulation_failed'
INVALID_EXACT_EVM_TRANSACTION_STATE = 'invalid_exact_evm_transaction_state'
INVALID_EXACT_EVM_UNSUPPORTED_SCHEME = 'invalid_exact_evm_unsupported_scheme'
INVALID_EXACT_EVM_VERIFICATION_FAILED = 'invalid_exact_evm_verification_failed'
INVALID_EXACT_SOLANA_EXTRA_FIELD = 'invalid_exact_solana_extra_field'
INVALID_EXACT_SOLANA_FEE_PAYER_MISMATCH = 'invalid_exact_solana_fee_payer_mismatch'
INVALID_EXACT_SOLANA_FEE_PAYER_NOT_MANAGED_BY_FACILITATOR = 'invalid_exact_solana_fee_payer_not_managed_by_facilitator'
INVALID_EXACT_SOLANA_INVALID_FEE_PAYER = 'invalid_exact_solana_invalid_fee_payer'
INVALID_EXACT_SOLANA_NETWORK_MISMATCH = 'invalid_exact_solana_network_mismatch'
INVALID_EXACT_SOLANA_PAYLOAD_AMOUNT_INSUFFICIENT = 'invalid_exact_solana_payload_amount_insufficient'
INVALID_EXACT_SOLANA_PAYLOAD_MEMO_COUNT = 'invalid_exact_solana_payload_memo_count'
INVALID_EXACT_SOLANA_PAYLOAD_MEMO_MISMATCH = 'invalid_exact_solana_payload_memo_mismatch'
INVALID_EXACT_SOLANA_PAYLOAD_MINT_MISMATCH = 'invalid_exact_solana_payload_mint_mismatch'
INVALID_EXACT_SOLANA_PAYLOAD_MISSING_FEE_PAYER = 'invalid_exact_solana_payload_missing_fee_payer'
INVALID_EXACT_SOLANA_PAYLOAD_NO_TRANSFER_INSTRUCTION = 'invalid_exact_solana_payload_no_transfer_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_RECIPIENT_MISMATCH = 'invalid_exact_solana_payload_recipient_mismatch'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION = 'invalid_exact_solana_payload_transaction'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_COULD_NOT_BE_DECODED = 'invalid_exact_solana_payload_transaction_could_not_be_decoded'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_FEE_PAYER_TRANSFERRING_FUNDS = 'invalid_exact_solana_payload_transaction_fee_payer_transferring_funds'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_LIMIT_INSTRUCTION = 'invalid_exact_solana_payload_transaction_instructions_compute_limit_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION = 'invalid_exact_solana_payload_transaction_instructions_compute_price_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION_TOO_HIGH = 'invalid_exact_solana_payload_transaction_instructions_compute_price_instruction_too_high'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_INSTRUCTIONS_LENGTH = 'invalid_exact_solana_payload_transaction_instructions_length'
INVALID_EXACT_SOLANA_PAYLOAD_UNKNOWN_FIFTH_INSTRUCTION = 'invalid_exact_solana_payload_unknown_fifth_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_UNKNOWN_FOURTH_INSTRUCTION = 'invalid_exact_solana_payload_unknown_fourth_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_UNKNOWN_SIXTH_INSTRUCTION = 'invalid_exact_solana_payload_unknown_sixth_instruction'
INVALID_EXACT_SOLANA_TRANSACTION_CONFIRMATION_FAILED = 'invalid_exact_solana_transaction_confirmation_failed'
INVALID_EXACT_SOLANA_TRANSACTION_FAILED = 'invalid_exact_solana_transaction_failed'
INVALID_EXACT_SOLANA_TRANSACTION_SIGNING_FAILED = 'invalid_exact_solana_transaction_signing_failed'
INVALID_EXACT_SOLANA_TRANSACTION_SIMULATION_FAILED = 'invalid_exact_solana_transaction_simulation_failed'
INVALID_EXACT_SOLANA_UNSUPPORTED_SCHEME = 'invalid_exact_solana_unsupported_scheme'
INVALID_EXACT_SOLANA_VERIFICATION_FAILED = 'invalid_exact_solana_verification_failed'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION = 'invalid_exact_svm_payload_transaction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_AMOUNT_MISMATCH = 'invalid_exact_svm_payload_transaction_amount_mismatch'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CANNOT_DERIVE_RECEIVER_ATA = 'invalid_exact_svm_payload_transaction_cannot_derive_receiver_ata'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CREATE_ATA_INSTRUCTION = 'invalid_exact_svm_payload_transaction_create_ata_instruction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CREATE_ATA_INSTRUCTION_INCORRECT_ASSET = 'invalid_exact_svm_payload_transaction_create_ata_instruction_incorrect_asset'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CREATE_ATA_INSTRUCTION_INCORRECT_PAYEE = 'invalid_exact_svm_payload_transaction_create_ata_instruction_incorrect_payee'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_FEE_PAYER_INCLUDED_IN_INSTRUCTION_ACCOUNTS = 'invalid_exact_svm_payload_transaction_fee_payer_included_in_instruction_accounts'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_FEE_PAYER_TRANSFERRING_FUNDS = 'invalid_exact_svm_payload_transaction_fee_payer_transferring_funds'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS = 'invalid_exact_svm_payload_transaction_instructions'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_LIMIT_INSTRUCTION = 'invalid_exact_svm_payload_transaction_instructions_compute_limit_instruction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION = 'invalid_exact_svm_payload_transaction_instructions_compute_price_instruction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION_TOO_HIGH = 'invalid_exact_svm_payload_transaction_instructions_compute_price_instruction_too_high'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_LENGTH = 'invalid_exact_svm_payload_transaction_instructions_length'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTION_NOT_SPL_TOKEN_TRANSFER_CHECKED = 'invalid_exact_svm_payload_transaction_instruction_not_spl_token_transfer_checked'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTION_NOT_TOKEN_2022_TRANSFER_CHECKED = 'invalid_exact_svm_payload_transaction_instruction_not_token_2022_transfer_checked'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_NOT_A_TRANSFER_INSTRUCTION = 'invalid_exact_svm_payload_transaction_not_a_transfer_instruction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_RECEIVER_ATA_NOT_FOUND = 'invalid_exact_svm_payload_transaction_receiver_ata_not_found'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_SENDER_ATA_NOT_FOUND = 'invalid_exact_svm_payload_transaction_sender_ata_not_found'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_SIMULATION_FAILED = 'invalid_exact_svm_payload_transaction_simulation_failed'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_TRANSFER_TO_INCORRECT_ATA = 'invalid_exact_svm_payload_transaction_transfer_to_incorrect_ata'
INVALID_NETWORK = 'invalid_network'
INVALID_PAYLOAD = 'invalid_payload'
INVALID_PAYMENT_REQUIREMENTS = 'invalid_payment_requirements'
INVALID_PERMIT2_RECIPIENT_MISMATCH = 'invalid_permit2_recipient_mismatch'
INVALID_PERMIT2_SIGNATURE = 'invalid_permit2_signature'
INVALID_PERMIT2_SPENDER = 'invalid_permit2_spender'
INVALID_SCHEME = 'invalid_scheme'
INVALID_X402_VERSION = 'invalid_x402_version'
KYT_RISK_DETECTED = 'kyt_risk_detected'
MISSING_BATCH_SETTLEMENT_CHANNEL = 'missing_batch_settlement_channel'
PERMIT2_2612_AMOUNT_MISMATCH = 'permit2_2612_amount_mismatch'
PERMIT2_ALLOWANCE_REQUIRED = 'permit2_allowance_required'
PERMIT2_AMOUNT_MISMATCH = 'permit2_amount_mismatch'
PERMIT2_DEADLINE_EXPIRED = 'permit2_deadline_expired'
PERMIT2_DISABLED = 'permit2_disabled'
PERMIT2_INSUFFICIENT_BALANCE = 'permit2_insufficient_balance'
PERMIT2_INVALID_AMOUNT = 'permit2_invalid_amount'
PERMIT2_INVALID_DESTINATION = 'permit2_invalid_destination'
PERMIT2_INVALID_NONCE = 'permit2_invalid_nonce'
PERMIT2_INVALID_OWNER = 'permit2_invalid_owner'
PERMIT2_NOT_YET_VALID = 'permit2_not_yet_valid'
PERMIT2_PAYMENT_TOO_EARLY = 'permit2_payment_too_early'
PERMIT2_PROXY_NOT_DEPLOYED = 'permit2_proxy_not_deployed'
PERMIT2_SIMULATION_FAILED = 'permit2_simulation_failed'
PERMIT2_TOKEN_MISMATCH = 'permit2_token_mismatch'
PREFLIGHT_VALIDATION_FAILED = 'preflight_validation_failed'
REQUEST_BLOCKED_BY_LOCATION = 'request_blocked_by_location'
SELF_SEND_NOT_ALLOWED = 'self_send_not_allowed'
SETTLE_EXACT_EVM_TRANSACTION_CONFIRMATION_TIMED_OUT = 'settle_exact_evm_transaction_confirmation_timed_out'
SETTLE_EXACT_FAILED_ONCHAIN = 'settle_exact_failed_onchain'
SETTLE_EXACT_NODE_FAILURE = 'settle_exact_node_failure'
SETTLE_EXACT_SVM_BLOCK_HEIGHT_EXCEEDED = 'settle_exact_svm_block_height_exceeded'
SETTLE_EXACT_SVM_TRANSACTION_CONFIRMATION_TIMED_OUT = 'settle_exact_svm_transaction_confirmation_timed_out'
SMART_WALLET_DEPLOYMENT_FAILED = 'smart_wallet_deployment_failed'
UNKNOWN_ERROR = 'unknown_error'
UNSUPPORTED_PAYLOAD_TYPE = 'unsupported_payload_type'
classmethod from_json(json_str)

Create an instance of X402SettleErrorReason from a JSON string

Return type:

Self

cdp.openapi_client.models.x402_settle_payment_rejection 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.models.x402_settle_payment_rejection.X402SettlePaymentRejection(**data)

Bases: BaseModel

The result when x402 payment settlement fails.

error_message: Optional[StrictStr]
error_reason: X402SettleErrorReason
classmethod from_dict(obj)

Create an instance of X402SettlePaymentRejection from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402SettlePaymentRejection from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: Optional[StrictStr]
payer: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=128)]]
success: StrictBool
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

transaction: Optional[Annotated[str, Field(strict=True)]]
classmethod transaction_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.x402_supported_payment_kind 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.models.x402_supported_payment_kind.X402SupportedPaymentKind(**data)

Bases: BaseModel

The supported payment kind for the x402 protocol. A kind is comprised of a scheme and a network, which together uniquely identify a way to move money on the x402 protocol. For more details, please see [x402 Schemes](https://github.com/coinbase/x402?tab=readme-ov-file#schemes).

extra: Optional[Dict[str, Any]]
classmethod from_dict(obj)

Create an instance of X402SupportedPaymentKind from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402SupportedPaymentKind from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: StrictStr
classmethod network_validate_enum(value)

Validates the enum

scheme: StrictStr
classmethod scheme_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

x402_version: X402Version

cdp.openapi_client.models.x402_upto_evm_permit2_payload 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.models.x402_upto_evm_permit2_payload.X402UptoEvmPermit2Payload(**data)

Bases: BaseModel

The x402 protocol upto scheme payload for EVM networks using Permit2. The upto scheme authorizes a maximum amount and lets the facilitator settle for the actual amount used. Structurally identical to x402ExactEvmPermit2Payload except permit2Authorization.witness carries an additional facilitator address that binds the authorization to a specific facilitator (the one announced via extra.facilitatorAddress in the payment requirements). For more details, see [EVM Upto Scheme Details](https://github.com/x402-foundation/x402/blob/main/specs/schemes/upto/scheme_upto_evm.md).

classmethod from_dict(obj)

Create an instance of X402UptoEvmPermit2Payload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402UptoEvmPermit2Payload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

permit2_authorization: X402UptoEvmPermit2PayloadPermit2Authorization
signature: Annotated[str, Field(strict=True)]
classmethod signature_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_upto_evm_permit2_payload_permit2_authorization 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.models.x402_upto_evm_permit2_payload_permit2_authorization.X402UptoEvmPermit2PayloadPermit2Authorization(**data)

Bases: BaseModel

The authorization data for the Permit2 PermitWitnessTransferFrom message. The permitted.amount is the maximum the client authorizes; the actual settled amount is decided by the resource server at settle time and MUST be less than or equal to it.

deadline: StrictStr
classmethod from_dict(obj)

Create an instance of X402UptoEvmPermit2PayloadPermit2Authorization from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402UptoEvmPermit2PayloadPermit2Authorization from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nonce: Annotated[str, Field(strict=True)]
classmethod nonce_validate_regular_expression(value)

Validates the regular expression

permitted: X402UptoEvmPermit2PayloadPermit2AuthorizationPermitted
spender: Annotated[str, Field(strict=True)]
classmethod spender_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

var_from: Annotated[str, Field(strict=True)]
classmethod var_from_validate_regular_expression(value)

Validates the regular expression

witness: X402UptoEvmPermit2PayloadPermit2AuthorizationWitness

cdp.openapi_client.models.x402_upto_evm_permit2_payload_permit2_authorization_permitted 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.models.x402_upto_evm_permit2_payload_permit2_authorization_permitted.X402UptoEvmPermit2PayloadPermit2AuthorizationPermitted(**data)

Bases: BaseModel

The token permissions for the transfer.

amount: StrictStr
classmethod from_dict(obj)

Create an instance of X402UptoEvmPermit2PayloadPermit2AuthorizationPermitted from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402UptoEvmPermit2PayloadPermit2AuthorizationPermitted from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

token: Annotated[str, Field(strict=True)]
classmethod token_validate_regular_expression(value)

Validates the regular expression

cdp.openapi_client.models.x402_upto_evm_permit2_payload_permit2_authorization_witness 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.models.x402_upto_evm_permit2_payload_permit2_authorization_witness.X402UptoEvmPermit2PayloadPermit2AuthorizationWitness(**data)

Bases: BaseModel

The witness data containing payment details. Includes a facilitator field to bind the authorization to a specific facilitator address.

facilitator: Annotated[str, Field(strict=True)]
classmethod facilitator_validate_regular_expression(value)

Validates the regular expression

classmethod from_dict(obj)

Create an instance of X402UptoEvmPermit2PayloadPermit2AuthorizationWitness from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402UptoEvmPermit2PayloadPermit2AuthorizationWitness from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to: Annotated[str, Field(strict=True)]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

classmethod to_validate_regular_expression(value)

Validates the regular expression

valid_after: StrictStr

cdp.openapi_client.models.x402_v1_network 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.models.x402_v1_network.X402V1Network(value)

Bases: str, Enum

The x402 v1 network identifier. x402 v1 uses human-readable network names. Supported networks: Base mainnet and testnet, Solana mainnet and devnet.

BASE = 'base'
BASE_MINUS_SEPOLIA = 'base-sepolia'
SOLANA = 'solana'
SOLANA_MINUS_DEVNET = 'solana-devnet'
classmethod from_json(json_str)

Create an instance of X402V1Network from a JSON string

Return type:

Self

cdp.openapi_client.models.x402_v1_payment_payload 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.models.x402_v1_payment_payload.X402V1PaymentPayload(**data)

Bases: BaseModel

The x402 v1 protocol payment payload. Uses human-readable network names and requires scheme and network alongside the inner payload object.

classmethod from_dict(obj)

Create an instance of X402V1PaymentPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402V1PaymentPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: X402V1Network
payload: X402V1PaymentPayloadPayload
scheme: StrictStr
classmethod scheme_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

x402_version: X402Version

cdp.openapi_client.models.x402_v1_payment_payload_payload 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.models.x402_v1_payment_payload_payload.X402V1PaymentPayloadPayload(*args, **kwargs)

Bases: BaseModel

The payload of the payment depending on the x402Version, scheme, and network.

actual_instance: Optional[Union[X402ExactEvmPayload, X402ExactEvmPermit2Payload, X402ExactSolanaPayload]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[X402ExactEvmPayload]
oneof_schema_2_validator: Optional[X402ExactEvmPermit2Payload]
oneof_schema_3_validator: Optional[X402ExactSolanaPayload]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], X402ExactEvmPayload, X402ExactEvmPermit2Payload, X402ExactSolanaPayload, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.x402_v1_payment_requirements 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.models.x402_v1_payment_requirements.X402V1PaymentRequirements(**data)

Bases: BaseModel

The x402 v1 payment requirements. Uses human-readable network names, and carries resource metadata (resource, description, mimeType) alongside the payment fields. The only supported scheme is exact.

asset: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
description: Annotated[str, Field(min_length=0, strict=True, max_length=500)]
extra: Optional[Dict[str, Any]]
classmethod from_dict(obj)

Create an instance of X402V1PaymentRequirements from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402V1PaymentRequirements from a JSON string

Return type:

Optional[Self]

max_amount_required: StrictStr
max_timeout_seconds: StrictInt
mime_type: StrictStr
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: X402V1Network
output_schema: Optional[Dict[str, Any]]
pay_to: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
resource: StrictStr
scheme: StrictStr
classmethod scheme_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_v2_network 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.models.x402_v2_network.X402V2Network(value)

Bases: str, Enum

The x402 v2 network identifier in CAIP-2 format. x402 v2 identifies networks by their CAIP-2 chain ID (e.g. eip155:<chainId> for EVM networks, solana:<genesisHash> for Solana). Supported networks: Base, Polygon, Arbitrum One, World Chain (EVM), and Solana.

EIP155_COLON_137 = 'eip155:137'
EIP155_COLON_42161 = 'eip155:42161'
EIP155_COLON_480 = 'eip155:480'
EIP155_COLON_4801 = 'eip155:4801'
EIP155_COLON_8453 = 'eip155:8453'
EIP155_COLON_84532 = 'eip155:84532'
SOLANA_COLON_5EYKT4_US_FV8_P8_NJD_TREP_Y1VZQ_KQ_Z_KVDP = 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp'
SOLANA_COLON_ET_WTRABZA_YQ6I_MFE_Y_KOU_RU166_VU2XQA1 = 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1'
classmethod from_json(json_str)

Create an instance of X402V2Network from a JSON string

Return type:

Self

cdp.openapi_client.models.x402_v2_payment_payload 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.models.x402_v2_payment_payload.X402V2PaymentPayload(**data)

Bases: BaseModel

The x402 v2 protocol payment payload. Uses CAIP-2 network identifiers. The accepted field carries the full payment requirements; scheme and network are not top-level fields (they are on the nested accepted object).

accepted: X402V2PaymentRequirements
extensions: Optional[Dict[str, Any]]
classmethod from_dict(obj)

Create an instance of X402V2PaymentPayload from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402V2PaymentPayload from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payload: X402V2PaymentPayloadPayload
resource: Optional[X402ResourceInfo]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

x402_version: X402Version

cdp.openapi_client.models.x402_v2_payment_payload_payload 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.models.x402_v2_payment_payload_payload.X402V2PaymentPayloadPayload(*args, **kwargs)

Bases: BaseModel

The payload of the payment depending on the x402Version, scheme, and network. Discriminated by scheme-specific fields: exact-EVM/upto-EVM payloads carry a signature; exact-Solana carries a transaction; batch-settlement carries a type discriminator. See x402BatchSettlementEvmPayload for the documented batch-settlement variants.

actual_instance: Optional[Union[X402BatchSettlementEvmPayload, X402ExactEvmPayload, X402ExactEvmPermit2Payload, X402ExactSolanaPayload, X402UptoEvmPermit2Payload]]
classmethod actual_instance_must_validate_oneof(v)
classmethod from_dict(obj)
Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]
oneof_schema_1_validator: Optional[X402ExactEvmPayload]
oneof_schema_2_validator: Optional[X402ExactEvmPermit2Payload]
oneof_schema_3_validator: Optional[X402ExactSolanaPayload]
oneof_schema_4_validator: Optional[X402UptoEvmPermit2Payload]
oneof_schema_5_validator: Optional[X402BatchSettlementEvmPayload]
to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], X402BatchSettlementEvmPayload, X402ExactEvmPayload, X402ExactEvmPermit2Payload, X402ExactSolanaPayload, X402UptoEvmPermit2Payload, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

cdp.openapi_client.models.x402_v2_payment_requirements 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.models.x402_v2_payment_requirements.X402V2PaymentRequirements(**data)

Bases: BaseModel

The x402 v2 payment requirements. Uses CAIP-2 network identifiers and supports exact, upto, and batch-settlement schemes. Carries only the payment fields (no resource metadata — that is in the enclosing x402V2PaymentPayload.resource).

amount: StrictStr
asset: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
extra: Optional[Dict[str, Any]]
classmethod from_dict(obj)

Create an instance of X402V2PaymentRequirements from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402V2PaymentRequirements from a JSON string

Return type:

Optional[Self]

max_timeout_seconds: StrictInt
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

network: X402V2Network
pay_to: Annotated[str, Field(min_length=1, strict=True, max_length=128)]
scheme: StrictStr
classmethod scheme_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_validate_check 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.models.x402_validate_check.X402ValidateCheck(**data)

Bases: BaseModel

The result of a single preflight check performed against the x402 endpoint.

actual: Optional[StrictStr]
check: StrictStr
classmethod check_validate_enum(value)

Validates the enum

detail: StrictStr
expected: Optional[StrictStr]
classmethod from_dict(obj)

Create an instance of X402ValidateCheck from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ValidateCheck from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

passed: StrictBool
severity: StrictStr
classmethod severity_validate_enum(value)

Validates the enum

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_validate_index 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.models.x402_validate_index.X402ValidateIndex(**data)

Bases: BaseModel

Bazaar index status for a validated x402 endpoint.

active: StrictBool
classmethod from_dict(obj)

Create an instance of X402ValidateIndex from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ValidateIndex from a JSON string

Return type:

Optional[Self]

last_crawled_at: datetime
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

quality: Optional[X402ResourceQuality]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_validate_request 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.models.x402_validate_request.X402ValidateRequest(**data)

Bases: BaseModel

Request to validate an x402 endpoint’s bazaar-discovery configuration.

classmethod from_dict(obj)

Create an instance of X402ValidateRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ValidateRequest from a JSON string

Return type:

Optional[Self]

method: Optional[StrictStr]
classmethod method_validate_enum(value)

Validates the enum

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

resource: Annotated[str, Field(min_length=12, strict=True, max_length=2048)]
classmethod resource_validate_regular_expression(value)

Validates the regular expression

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_validate_response 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.models.x402_validate_response.X402ValidateResponse(**data)

Bases: BaseModel

Response from validating an x402 endpoint’s bazaar-discovery configuration.

bazaar_extension: Dict[str, Any]
classmethod from_dict(obj)

Create an instance of X402ValidateResponse from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ValidateResponse from a JSON string

Return type:

Optional[Self]

index: X402ValidateIndex
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payment_requirements: X402PaymentRequirements
preflight: List[X402ValidateCheck]
simulation: X402ValidateSimulation
status_code: StrictInt
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

valid: StrictBool
x402_version: StrictInt

cdp.openapi_client.models.x402_validate_simulation 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.models.x402_validate_simulation.X402ValidateSimulation(**data)

Bases: BaseModel

The simulated facilitator decision for the x402 endpoint.

classmethod from_dict(obj)

Create an instance of X402ValidateSimulation from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402ValidateSimulation from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

outcome: StrictStr
classmethod outcome_validate_enum(value)

Validates the enum

rejection_reason: Optional[StrictStr]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_verify_invalid_reason 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.models.x402_verify_invalid_reason.X402VerifyInvalidReason(value)

Bases: str, Enum

The reason the payment is invalid on the x402 protocol.

AMOUNT_TOO_LOW = 'amount_too_low'
BATCH_SETTLEMENT_CHANNEL_BUSY = 'batch_settlement_channel_busy'
BATCH_SETTLEMENT_CHARGE_EXCEEDS_SIGNED_CUMULATIVE = 'batch_settlement_charge_exceeds_signed_cumulative'
BATCH_SETTLEMENT_CUMULATIVE_AMOUNT_MISMATCH = 'batch_settlement_cumulative_amount_mismatch'
BATCH_SETTLEMENT_REFUND_AMOUNT_EXCEEDS_BALANCE = 'batch_settlement_refund_amount_exceeds_balance'
BATCH_SETTLEMENT_REFUND_AMOUNT_INVALID = 'batch_settlement_refund_amount_invalid'
BATCH_SETTLEMENT_REFUND_NO_BALANCE = 'batch_settlement_refund_no_balance'
DUPLICATE_SETTLEMENT = 'duplicate_settlement'
ERC20_APPROVAL_ASSET_MISMATCH = 'erc20_approval_asset_mismatch'
ERC20_APPROVAL_BROADCAST_FAILED = 'erc20_approval_broadcast_failed'
ERC20_APPROVAL_FROM_MISMATCH = 'erc20_approval_from_mismatch'
ERC20_APPROVAL_INSUFFICIENT_ETH_FOR_GAS = 'erc20_approval_insufficient_eth_for_gas'
ERC20_APPROVAL_SPENDER_NOT_PERMIT2 = 'erc20_approval_spender_not_permit2'
ERC20_APPROVAL_TX_FAILED = 'erc20_approval_tx_failed'
ERC20_APPROVAL_TX_INVALID_SIGNATURE = 'erc20_approval_tx_invalid_signature'
ERC20_APPROVAL_TX_PARSE_FAILED = 'erc20_approval_tx_parse_failed'
ERC20_APPROVAL_TX_SIGNER_MISMATCH = 'erc20_approval_tx_signer_mismatch'
ERC20_APPROVAL_TX_WRONG_SELECTOR = 'erc20_approval_tx_wrong_selector'
ERC20_APPROVAL_TX_WRONG_SPENDER = 'erc20_approval_tx_wrong_spender'
ERC20_APPROVAL_TX_WRONG_TARGET = 'erc20_approval_tx_wrong_target'
INSUFFICIENT_FUNDS = 'insufficient_funds'
INVALID_AMOUNT = 'invalid_amount'
INVALID_BATCH_SETTLEMENT_EVM_CHANNEL_ID_MISMATCH = 'invalid_batch_settlement_evm_channel_id_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_CHANNEL_NOT_FOUND = 'invalid_batch_settlement_evm_channel_not_found'
INVALID_BATCH_SETTLEMENT_EVM_CHANNEL_STATE_READ_FAILED = 'invalid_batch_settlement_evm_channel_state_read_failed'
INVALID_BATCH_SETTLEMENT_EVM_CUMULATIVE_BELOW_CLAIMED = 'invalid_batch_settlement_evm_cumulative_below_claimed'
INVALID_BATCH_SETTLEMENT_EVM_CUMULATIVE_EXCEEDS_BALANCE = 'invalid_batch_settlement_evm_cumulative_exceeds_balance'
INVALID_BATCH_SETTLEMENT_EVM_DEPOSIT_PAYLOAD = 'invalid_batch_settlement_evm_deposit_payload'
INVALID_BATCH_SETTLEMENT_EVM_DEPOSIT_SIMULATION_FAILED = 'invalid_batch_settlement_evm_deposit_simulation_failed'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_AMOUNT_MISMATCH = 'invalid_batch_settlement_evm_eip2612_amount_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_ASSET_MISMATCH = 'invalid_batch_settlement_evm_eip2612_asset_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_DEADLINE_EXPIRED = 'invalid_batch_settlement_evm_eip2612_deadline_expired'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_INVALID_FORMAT = 'invalid_batch_settlement_evm_eip2612_invalid_format'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_INVALID_SIGNATURE = 'invalid_batch_settlement_evm_eip2612_invalid_signature'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_OWNER_MISMATCH = 'invalid_batch_settlement_evm_eip2612_owner_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_EIP2612_SPENDER_MISMATCH = 'invalid_batch_settlement_evm_eip2612_spender_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_ASSET_MISMATCH = 'invalid_batch_settlement_evm_erc20_approval_asset_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_FROM_MISMATCH = 'invalid_batch_settlement_evm_erc20_approval_from_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_INVALID_FORMAT = 'invalid_batch_settlement_evm_erc20_approval_invalid_format'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_UNAVAILABLE = 'invalid_batch_settlement_evm_erc20_approval_unavailable'
INVALID_BATCH_SETTLEMENT_EVM_ERC20_APPROVAL_WRONG_SPENDER = 'invalid_batch_settlement_evm_erc20_approval_wrong_spender'
INVALID_BATCH_SETTLEMENT_EVM_ERC3009_AUTHORIZATION_REQUIRED = 'invalid_batch_settlement_evm_erc3009_authorization_required'
INVALID_BATCH_SETTLEMENT_EVM_INSUFFICIENT_BALANCE = 'invalid_batch_settlement_evm_insufficient_balance'
INVALID_BATCH_SETTLEMENT_EVM_MISSING_EIP712_DOMAIN = 'invalid_batch_settlement_evm_missing_eip712_domain'
INVALID_BATCH_SETTLEMENT_EVM_NETWORK_MISMATCH = 'invalid_batch_settlement_evm_network_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_PAYLOAD_AUTHORIZATION_VALID_AFTER = 'invalid_batch_settlement_evm_payload_authorization_valid_after'
INVALID_BATCH_SETTLEMENT_EVM_PAYLOAD_AUTHORIZATION_VALID_BEFORE = 'invalid_batch_settlement_evm_payload_authorization_valid_before'
INVALID_BATCH_SETTLEMENT_EVM_PAYLOAD_TYPE = 'invalid_batch_settlement_evm_payload_type'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_ALLOWANCE_REQUIRED = 'invalid_batch_settlement_evm_permit2_allowance_required'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_AMOUNT_MISMATCH = 'invalid_batch_settlement_evm_permit2_amount_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_AUTHORIZATION_REQUIRED = 'invalid_batch_settlement_evm_permit2_authorization_required'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_DEADLINE_EXPIRED = 'invalid_batch_settlement_evm_permit2_deadline_expired'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_INVALID_SIGNATURE = 'invalid_batch_settlement_evm_permit2_invalid_signature'
INVALID_BATCH_SETTLEMENT_EVM_PERMIT2_INVALID_SPENDER = 'invalid_batch_settlement_evm_permit2_invalid_spender'
INVALID_BATCH_SETTLEMENT_EVM_RECEIVER_AUTHORIZER_MISMATCH = 'invalid_batch_settlement_evm_receiver_authorizer_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_RECEIVER_MISMATCH = 'invalid_batch_settlement_evm_receiver_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_RECEIVE_AUTHORIZATION_SIGNATURE = 'invalid_batch_settlement_evm_receive_authorization_signature'
INVALID_BATCH_SETTLEMENT_EVM_REFUND_PAYLOAD = 'invalid_batch_settlement_evm_refund_payload'
INVALID_BATCH_SETTLEMENT_EVM_RPC_READ_FAILED = 'invalid_batch_settlement_evm_rpc_read_failed'
INVALID_BATCH_SETTLEMENT_EVM_SCHEME = 'invalid_batch_settlement_evm_scheme'
INVALID_BATCH_SETTLEMENT_EVM_TOKEN_MISMATCH = 'invalid_batch_settlement_evm_token_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_VOUCHER_PAYLOAD = 'invalid_batch_settlement_evm_voucher_payload'
INVALID_BATCH_SETTLEMENT_EVM_VOUCHER_SIGNATURE = 'invalid_batch_settlement_evm_voucher_signature'
INVALID_BATCH_SETTLEMENT_EVM_WITHDRAW_DELAY_MISMATCH = 'invalid_batch_settlement_evm_withdraw_delay_mismatch'
INVALID_BATCH_SETTLEMENT_EVM_WITHDRAW_DELAY_OUT_OF_RANGE = 'invalid_batch_settlement_evm_withdraw_delay_out_of_range'
INVALID_BAZAAR_EXTENSION = 'invalid_bazaar_extension'
INVALID_ERC20_APPROVAL_EXTENSION_FORMAT = 'invalid_erc20_approval_extension_format'
INVALID_EXACT_EVM_AUTHORIZATION_VALUE = 'invalid_exact_evm_authorization_value'
INVALID_EXACT_EVM_EIP3009_NOT_SUPPORTED = 'invalid_exact_evm_eip3009_not_supported'
INVALID_EXACT_EVM_EXTRA_FIELD = 'invalid_exact_evm_extra_field'
INVALID_EXACT_EVM_FAILED_TO_CHECK_DEPLOYMENT = 'invalid_exact_evm_failed_to_check_deployment'
INVALID_EXACT_EVM_FAILED_TO_CHECK_NONCE = 'invalid_exact_evm_failed_to_check_nonce'
INVALID_EXACT_EVM_FAILED_TO_EXECUTE_TRANSFER = 'invalid_exact_evm_failed_to_execute_transfer'
INVALID_EXACT_EVM_FAILED_TO_GET_BALANCE = 'invalid_exact_evm_failed_to_get_balance'
INVALID_EXACT_EVM_FAILED_TO_GET_NETWORK_CONFIG = 'invalid_exact_evm_failed_to_get_network_config'
INVALID_EXACT_EVM_FAILED_TO_GET_RECEIPT = 'invalid_exact_evm_failed_to_get_receipt'
INVALID_EXACT_EVM_FAILED_TO_PARSE_SIGNATURE = 'invalid_exact_evm_failed_to_parse_signature'
INVALID_EXACT_EVM_FAILED_TO_VERIFY_SIGNATURE = 'invalid_exact_evm_failed_to_verify_signature'
INVALID_EXACT_EVM_INSUFFICIENT_BALANCE = 'invalid_exact_evm_insufficient_balance'
INVALID_EXACT_EVM_INSUFFICIENT_FUNDS = 'invalid_exact_evm_insufficient_funds'
INVALID_EXACT_EVM_MISSING_EIP712_DOMAIN = 'invalid_exact_evm_missing_eip712_domain'
INVALID_EXACT_EVM_NETWORK_MISMATCH = 'invalid_exact_evm_network_mismatch'
INVALID_EXACT_EVM_NONCE_ALREADY_USED = 'invalid_exact_evm_nonce_already_used'
INVALID_EXACT_EVM_PAYLOAD = 'invalid_exact_evm_payload'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_FROM_ADDRESS_KYT = 'invalid_exact_evm_payload_authorization_from_address_kyt'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_TO_ADDRESS_KYT = 'invalid_exact_evm_payload_authorization_to_address_kyt'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_TYPED_DATA_MESSAGE = 'invalid_exact_evm_payload_authorization_typed_data_message'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALID_AFTER = 'invalid_exact_evm_payload_authorization_valid_after'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALID_BEFORE = 'invalid_exact_evm_payload_authorization_valid_before'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALUE = 'invalid_exact_evm_payload_authorization_value'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALUE_MISMATCH = 'invalid_exact_evm_payload_authorization_value_mismatch'
INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALUE_TOO_LOW = 'invalid_exact_evm_payload_authorization_value_too_low'
INVALID_EXACT_EVM_PAYLOAD_MISSING_SIGNATURE = 'invalid_exact_evm_payload_missing_signature'
INVALID_EXACT_EVM_PAYLOAD_RECIPIENT_MISMATCH = 'invalid_exact_evm_payload_recipient_mismatch'
INVALID_EXACT_EVM_PAYLOAD_SIGNATURE = 'invalid_exact_evm_payload_signature'
INVALID_EXACT_EVM_PAYLOAD_SIGNATURE_ADDRESS = 'invalid_exact_evm_payload_signature_address'
INVALID_EXACT_EVM_PAYLOAD_UNDEPLOYED_SMART_WALLET = 'invalid_exact_evm_payload_undeployed_smart_wallet'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_ALLOWANCE_REQUIRED = 'invalid_exact_evm_permit2_payload_allowance_required'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_AMOUNT = 'invalid_exact_evm_permit2_payload_amount'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_DEADLINE = 'invalid_exact_evm_permit2_payload_deadline'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_RECIPIENT = 'invalid_exact_evm_permit2_payload_recipient'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_SIGNATURE = 'invalid_exact_evm_permit2_payload_signature'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_SPENDER = 'invalid_exact_evm_permit2_payload_spender'
INVALID_EXACT_EVM_PERMIT2_PAYLOAD_VALID_AFTER = 'invalid_exact_evm_permit2_payload_valid_after'
INVALID_EXACT_EVM_RECIPIENT_MISMATCH = 'invalid_exact_evm_recipient_mismatch'
INVALID_EXACT_EVM_REQUIRED_AMOUNT = 'invalid_exact_evm_required_amount'
INVALID_EXACT_EVM_SCHEME = 'invalid_exact_evm_scheme'
INVALID_EXACT_EVM_SIGNATURE = 'invalid_exact_evm_signature'
INVALID_EXACT_EVM_SIGNATURE_FORMAT = 'invalid_exact_evm_signature_format'
INVALID_EXACT_EVM_TOKEN_NAME_MISMATCH = 'invalid_exact_evm_token_name_mismatch'
INVALID_EXACT_EVM_TOKEN_VERSION_MISMATCH = 'invalid_exact_evm_token_version_mismatch'
INVALID_EXACT_EVM_TRANSACTION_FAILED = 'invalid_exact_evm_transaction_failed'
INVALID_EXACT_EVM_TRANSACTION_SIMULATION_FAILED = 'invalid_exact_evm_transaction_simulation_failed'
INVALID_EXACT_EVM_TRANSACTION_STATE = 'invalid_exact_evm_transaction_state'
INVALID_EXACT_EVM_UNSUPPORTED_SCHEME = 'invalid_exact_evm_unsupported_scheme'
INVALID_EXACT_EVM_VERIFICATION_FAILED = 'invalid_exact_evm_verification_failed'
INVALID_EXACT_SOLANA_EXTRA_FIELD = 'invalid_exact_solana_extra_field'
INVALID_EXACT_SOLANA_FEE_PAYER_MISMATCH = 'invalid_exact_solana_fee_payer_mismatch'
INVALID_EXACT_SOLANA_FEE_PAYER_NOT_MANAGED_BY_FACILITATOR = 'invalid_exact_solana_fee_payer_not_managed_by_facilitator'
INVALID_EXACT_SOLANA_INVALID_FEE_PAYER = 'invalid_exact_solana_invalid_fee_payer'
INVALID_EXACT_SOLANA_NETWORK_MISMATCH = 'invalid_exact_solana_network_mismatch'
INVALID_EXACT_SOLANA_PAYLOAD_AMOUNT_INSUFFICIENT = 'invalid_exact_solana_payload_amount_insufficient'
INVALID_EXACT_SOLANA_PAYLOAD_MEMO_COUNT = 'invalid_exact_solana_payload_memo_count'
INVALID_EXACT_SOLANA_PAYLOAD_MEMO_MISMATCH = 'invalid_exact_solana_payload_memo_mismatch'
INVALID_EXACT_SOLANA_PAYLOAD_MINT_MISMATCH = 'invalid_exact_solana_payload_mint_mismatch'
INVALID_EXACT_SOLANA_PAYLOAD_MISSING_FEE_PAYER = 'invalid_exact_solana_payload_missing_fee_payer'
INVALID_EXACT_SOLANA_PAYLOAD_NO_TRANSFER_INSTRUCTION = 'invalid_exact_solana_payload_no_transfer_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_RECIPIENT_MISMATCH = 'invalid_exact_solana_payload_recipient_mismatch'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION = 'invalid_exact_solana_payload_transaction'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_COULD_NOT_BE_DECODED = 'invalid_exact_solana_payload_transaction_could_not_be_decoded'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_FEE_PAYER_TRANSFERRING_FUNDS = 'invalid_exact_solana_payload_transaction_fee_payer_transferring_funds'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_LIMIT_INSTRUCTION = 'invalid_exact_solana_payload_transaction_instructions_compute_limit_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION = 'invalid_exact_solana_payload_transaction_instructions_compute_price_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION_TOO_HIGH = 'invalid_exact_solana_payload_transaction_instructions_compute_price_instruction_too_high'
INVALID_EXACT_SOLANA_PAYLOAD_TRANSACTION_INSTRUCTIONS_LENGTH = 'invalid_exact_solana_payload_transaction_instructions_length'
INVALID_EXACT_SOLANA_PAYLOAD_UNKNOWN_FIFTH_INSTRUCTION = 'invalid_exact_solana_payload_unknown_fifth_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_UNKNOWN_FOURTH_INSTRUCTION = 'invalid_exact_solana_payload_unknown_fourth_instruction'
INVALID_EXACT_SOLANA_PAYLOAD_UNKNOWN_SIXTH_INSTRUCTION = 'invalid_exact_solana_payload_unknown_sixth_instruction'
INVALID_EXACT_SOLANA_TRANSACTION_CONFIRMATION_FAILED = 'invalid_exact_solana_transaction_confirmation_failed'
INVALID_EXACT_SOLANA_TRANSACTION_FAILED = 'invalid_exact_solana_transaction_failed'
INVALID_EXACT_SOLANA_TRANSACTION_SIGNING_FAILED = 'invalid_exact_solana_transaction_signing_failed'
INVALID_EXACT_SOLANA_TRANSACTION_SIMULATION_FAILED = 'invalid_exact_solana_transaction_simulation_failed'
INVALID_EXACT_SOLANA_UNSUPPORTED_SCHEME = 'invalid_exact_solana_unsupported_scheme'
INVALID_EXACT_SOLANA_VERIFICATION_FAILED = 'invalid_exact_solana_verification_failed'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION = 'invalid_exact_svm_payload_transaction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_AMOUNT_MISMATCH = 'invalid_exact_svm_payload_transaction_amount_mismatch'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CANNOT_DERIVE_RECEIVER_ATA = 'invalid_exact_svm_payload_transaction_cannot_derive_receiver_ata'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CREATE_ATA_INSTRUCTION = 'invalid_exact_svm_payload_transaction_create_ata_instruction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CREATE_ATA_INSTRUCTION_INCORRECT_ASSET = 'invalid_exact_svm_payload_transaction_create_ata_instruction_incorrect_asset'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CREATE_ATA_INSTRUCTION_INCORRECT_PAYEE = 'invalid_exact_svm_payload_transaction_create_ata_instruction_incorrect_payee'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_FEE_PAYER_INCLUDED_IN_INSTRUCTION_ACCOUNTS = 'invalid_exact_svm_payload_transaction_fee_payer_included_in_instruction_accounts'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_FEE_PAYER_TRANSFERRING_FUNDS = 'invalid_exact_svm_payload_transaction_fee_payer_transferring_funds'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS = 'invalid_exact_svm_payload_transaction_instructions'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_LIMIT_INSTRUCTION = 'invalid_exact_svm_payload_transaction_instructions_compute_limit_instruction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION = 'invalid_exact_svm_payload_transaction_instructions_compute_price_instruction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION_TOO_HIGH = 'invalid_exact_svm_payload_transaction_instructions_compute_price_instruction_too_high'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_LENGTH = 'invalid_exact_svm_payload_transaction_instructions_length'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTION_NOT_SPL_TOKEN_TRANSFER_CHECKED = 'invalid_exact_svm_payload_transaction_instruction_not_spl_token_transfer_checked'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTION_NOT_TOKEN_2022_TRANSFER_CHECKED = 'invalid_exact_svm_payload_transaction_instruction_not_token_2022_transfer_checked'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_NOT_A_TRANSFER_INSTRUCTION = 'invalid_exact_svm_payload_transaction_not_a_transfer_instruction'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_RECEIVER_ATA_NOT_FOUND = 'invalid_exact_svm_payload_transaction_receiver_ata_not_found'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_SENDER_ATA_NOT_FOUND = 'invalid_exact_svm_payload_transaction_sender_ata_not_found'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_SIMULATION_FAILED = 'invalid_exact_svm_payload_transaction_simulation_failed'
INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_TRANSFER_TO_INCORRECT_ATA = 'invalid_exact_svm_payload_transaction_transfer_to_incorrect_ata'
INVALID_NETWORK = 'invalid_network'
INVALID_PAYLOAD = 'invalid_payload'
INVALID_PAYMENT_REQUIREMENTS = 'invalid_payment_requirements'
INVALID_PERMIT2_RECIPIENT_MISMATCH = 'invalid_permit2_recipient_mismatch'
INVALID_PERMIT2_SIGNATURE = 'invalid_permit2_signature'
INVALID_PERMIT2_SPENDER = 'invalid_permit2_spender'
INVALID_SCHEME = 'invalid_scheme'
INVALID_X402_VERSION = 'invalid_x402_version'
KYT_RISK_DETECTED = 'kyt_risk_detected'
MISSING_BATCH_SETTLEMENT_CHANNEL = 'missing_batch_settlement_channel'
PERMIT2_2612_AMOUNT_MISMATCH = 'permit2_2612_amount_mismatch'
PERMIT2_ALLOWANCE_REQUIRED = 'permit2_allowance_required'
PERMIT2_AMOUNT_MISMATCH = 'permit2_amount_mismatch'
PERMIT2_DEADLINE_EXPIRED = 'permit2_deadline_expired'
PERMIT2_DISABLED = 'permit2_disabled'
PERMIT2_INSUFFICIENT_BALANCE = 'permit2_insufficient_balance'
PERMIT2_INVALID_AMOUNT = 'permit2_invalid_amount'
PERMIT2_INVALID_DESTINATION = 'permit2_invalid_destination'
PERMIT2_INVALID_NONCE = 'permit2_invalid_nonce'
PERMIT2_INVALID_OWNER = 'permit2_invalid_owner'
PERMIT2_NOT_YET_VALID = 'permit2_not_yet_valid'
PERMIT2_PAYMENT_TOO_EARLY = 'permit2_payment_too_early'
PERMIT2_PROXY_NOT_DEPLOYED = 'permit2_proxy_not_deployed'
PERMIT2_SIMULATION_FAILED = 'permit2_simulation_failed'
PERMIT2_TOKEN_MISMATCH = 'permit2_token_mismatch'
PREFLIGHT_VALIDATION_FAILED = 'preflight_validation_failed'
REQUEST_BLOCKED_BY_LOCATION = 'request_blocked_by_location'
SELF_SEND_NOT_ALLOWED = 'self_send_not_allowed'
SMART_WALLET_DEPLOYMENT_FAILED = 'smart_wallet_deployment_failed'
UNKNOWN_ERROR = 'unknown_error'
UNSUPPORTED_PAYLOAD_TYPE = 'unsupported_payload_type'
classmethod from_json(json_str)

Create an instance of X402VerifyInvalidReason from a JSON string

Return type:

Self

cdp.openapi_client.models.x402_verify_payment_rejection 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.models.x402_verify_payment_rejection.X402VerifyPaymentRejection(**data)

Bases: BaseModel

The result when x402 payment verification fails.

classmethod from_dict(obj)

Create an instance of X402VerifyPaymentRejection from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of X402VerifyPaymentRejection from a JSON string

Return type:

Optional[Self]

invalid_message: Optional[StrictStr]
invalid_reason: X402VerifyInvalidReason
is_valid: StrictBool
model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payer: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=128)]]
to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype: Dict[str, Any]

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

cdp.openapi_client.models.x402_version 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.models.x402_version.X402Version(value)

Bases: int, Enum

The version of the x402 protocol.

NUMBER_1 = 1
NUMBER_2 = 2
classmethod from_json(json_str)

Create an instance of X402Version from a JSON string

Return type:

Self

Module contents

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.