cdp.client.models package

Submodules

cdp.client.models.abi module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.abi.ABI(**data)

Bases: BaseModel

Smart Contract to be registered

abi: StrictStr

contract_name: StrictStr

classmethod from_dict(obj)

Create an instance of ABI from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ABI from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.address module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.address.Address(**data)

Bases: BaseModel

address_id: StrictStr

classmethod from_dict(obj)

Create an instance of Address from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Address from a JSON string

Return type:

Optional[Self]

index: StrictInt

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

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

network_id: StrictStr

public_key: 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_id: StrictStr

cdp.client.models.address_balance_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.address_balance_list.AddressBalanceList(**data)

Bases: BaseModel

data: List[Balance]

classmethod from_dict(obj)

Create an instance of AddressBalanceList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddressBalanceList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.address_historical_balance_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.address_historical_balance_list.AddressHistoricalBalanceList(**data)

Bases: BaseModel

data: List[HistoricalBalance]

classmethod from_dict(obj)

Create an instance of AddressHistoricalBalanceList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddressHistoricalBalanceList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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.client.models.address_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.address_list.AddressList(**data)

Bases: BaseModel

data: List[Address]

classmethod from_dict(obj)

Create an instance of AddressList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddressList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.address_reputation module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.address_reputation.AddressReputation(**data)

Bases: BaseModel

The reputation score with metadata of a blockchain address.

classmethod from_dict(obj)

Create an instance of AddressReputation from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddressReputation from a JSON string

Return type:

Optional[Self]

metadata: AddressReputationMetadata

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

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

reputation_score: 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.client.models.address_reputation_metadata module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.address_reputation_metadata.AddressReputationMetadata(**data)

Bases: BaseModel

The metadata for the reputation score of onchain address.

activity_period_days: StrictInt

bridge_transactions_performed: StrictInt

current_active_streak: StrictInt

ens_contract_interactions: StrictInt

classmethod from_dict(obj)

Create an instance of AddressReputationMetadata from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddressReputationMetadata from a JSON string

Return type:

Optional[Self]

lend_borrow_stake_transactions: StrictInt

longest_active_streak: StrictInt

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

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

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

token_swaps_performed: StrictInt

total_transactions: StrictInt

unique_days_active: StrictInt

cdp.client.models.address_risk module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.address_risk.AddressRisk(**data)

Bases: BaseModel

The risk score of a blockchain address.

classmethod from_dict(obj)

Create an instance of AddressRisk from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddressRisk from a JSON string

Return type:

Optional[Self]

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

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

risk_score: 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.client.models.address_transaction_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.address_transaction_list.AddressTransactionList(**data)

Bases: BaseModel

data: List[Transaction]

classmethod from_dict(obj)

Create an instance of AddressTransactionList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AddressTransactionList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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.client.models.asset module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.asset.Asset(**data)

Bases: BaseModel

An asset onchain scoped to a particular network, e.g. ETH on base-sepolia, or the USDC ERC20 Token on ethereum-mainnet.

asset_id: StrictStr

contract_address: Optional[StrictStr]

decimals: Optional[StrictInt]

classmethod from_dict(obj)

Create an instance of Asset from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Asset from a JSON string

Return type:

Optional[Self]

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

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

network_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.client.models.balance module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.balance.Balance(**data)

Bases: BaseModel

The balance of an asset onchain

amount: StrictStr

asset: Asset

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}

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.client.models.broadcast_contract_invocation_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.broadcast_contract_invocation_request.BroadcastContractInvocationRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of BroadcastContractInvocationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of BroadcastContractInvocationRequest from a JSON string

Return type:

Optional[Self]

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

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

signed_payload: 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.client.models.broadcast_staking_operation_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.broadcast_staking_operation_request.BroadcastStakingOperationRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of BroadcastStakingOperationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of BroadcastStakingOperationRequest from a JSON string

Return type:

Optional[Self]

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

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

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

transaction_index: StrictInt

cdp.client.models.broadcast_trade_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.broadcast_trade_request.BroadcastTradeRequest(**data)

Bases: BaseModel

approve_transaction_signed_payload: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of BroadcastTradeRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of BroadcastTradeRequest from a JSON string

Return type:

Optional[Self]

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

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

signed_payload: 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.client.models.broadcast_transfer_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.broadcast_transfer_request.BroadcastTransferRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of BroadcastTransferRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of BroadcastTransferRequest from a JSON string

Return type:

Optional[Self]

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

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

signed_payload: 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.client.models.build_staking_operation_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.build_staking_operation_request.BuildStakingOperationRequest(**data)

Bases: BaseModel

action: StrictStr

address_id: StrictStr

asset_id: StrictStr

classmethod from_dict(obj)

Create an instance of BuildStakingOperationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of BuildStakingOperationRequest from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

options: Dict[str, 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.client.models.contract_event module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.contract_event.ContractEvent(**data)

Bases: BaseModel

Represents a single decoded event emitted by a smart contract

block_height: StrictInt

block_time: datetime

contract_address: StrictStr

contract_name: StrictStr

data: StrictStr

event_index: StrictInt

event_name: StrictStr

four_bytes: StrictStr

classmethod from_dict(obj)

Create an instance of ContractEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ContractEvent from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

protocol_name: StrictStr

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

tx_hash: StrictStr

tx_index: StrictInt

cdp.client.models.contract_event_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.contract_event_list.ContractEventList(**data)

Bases: BaseModel

A list of contract events with pagination information

data: List[ContractEvent]

classmethod from_dict(obj)

Create an instance of ContractEventList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ContractEventList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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.client.models.contract_invocation module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.contract_invocation.ContractInvocation(**data)

Bases: BaseModel

A contract invocation onchain.

abi: Optional[StrictStr]

address_id: StrictStr

amount: StrictStr

args: StrictStr

contract_address: StrictStr

contract_invocation_id: StrictStr

classmethod from_dict(obj)

Create an instance of ContractInvocation from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ContractInvocation from a JSON string

Return type:

Optional[Self]

method: StrictStr

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

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

network_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

transaction: Transaction

wallet_id: StrictStr

cdp.client.models.contract_invocation_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.contract_invocation_list.ContractInvocationList(**data)

Bases: BaseModel

data: List[ContractInvocation]

classmethod from_dict(obj)

Create an instance of ContractInvocationList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ContractInvocationList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.create_address_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_address_request.CreateAddressRequest(**data)

Bases: BaseModel

address_index: Optional[StrictInt]

attestation: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of CreateAddressRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateAddressRequest from a JSON string

Return type:

Optional[Self]

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

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

public_key: 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.client.models.create_contract_invocation_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_contract_invocation_request.CreateContractInvocationRequest(**data)

Bases: BaseModel

abi: Optional[StrictStr]

amount: Optional[StrictStr]

args: StrictStr

contract_address: StrictStr

classmethod from_dict(obj)

Create an instance of CreateContractInvocationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateContractInvocationRequest from a JSON string

Return type:

Optional[Self]

method: StrictStr

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.create_fund_operation_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_fund_operation_request.CreateFundOperationRequest(**data)

Bases: BaseModel

amount: StrictStr

asset_id: StrictStr

classmethod from_dict(obj)

Create an instance of CreateFundOperationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateFundOperationRequest from a JSON string

Return type:

Optional[Self]

fund_quote_id: Optional[StrictStr]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.create_fund_quote_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_fund_quote_request.CreateFundQuoteRequest(**data)

Bases: BaseModel

amount: StrictStr

asset_id: StrictStr

classmethod from_dict(obj)

Create an instance of CreateFundQuoteRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateFundQuoteRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.create_payload_signature_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_payload_signature_request.CreatePayloadSignatureRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of CreatePayloadSignatureRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreatePayloadSignatureRequest from a JSON string

Return type:

Optional[Self]

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

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

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

unsigned_payload: StrictStr

cdp.client.models.create_server_signer_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_server_signer_request.CreateServerSignerRequest(**data)

Bases: BaseModel

enrollment_data: StrictStr

classmethod from_dict(obj)

Create an instance of CreateServerSignerRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateServerSignerRequest from a JSON string

Return type:

Optional[Self]

is_mpc: StrictBool

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

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

server_signer_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

cdp.client.models.create_smart_contract_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_smart_contract_request.CreateSmartContractRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of CreateSmartContractRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateSmartContractRequest from a JSON string

Return type:

Optional[Self]

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

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

options: SmartContractOptions

to_dict()

Return the dictionary representation of the model using alias.

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

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

to_json()

Returns the 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: SmartContractType

cdp.client.models.create_staking_operation_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_staking_operation_request.CreateStakingOperationRequest(**data)

Bases: BaseModel

action: StrictStr

asset_id: StrictStr

classmethod from_dict(obj)

Create an instance of CreateStakingOperationRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateStakingOperationRequest from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

options: Dict[str, 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.client.models.create_trade_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_trade_request.CreateTradeRequest(**data)

Bases: BaseModel

amount: StrictStr

from_asset_id: StrictStr

classmethod from_dict(obj)

Create an instance of CreateTradeRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateTradeRequest from a JSON string

Return type:

Optional[Self]

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

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

to_asset_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.client.models.create_transfer_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_transfer_request.CreateTransferRequest(**data)

Bases: BaseModel

amount: StrictStr

asset_id: StrictStr

destination: StrictStr

classmethod from_dict(obj)

Create an instance of CreateTransferRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateTransferRequest from a JSON string

Return type:

Optional[Self]

gasless: Optional[StrictBool]

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

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

network_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.client.models.create_wallet_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_wallet_request.CreateWalletRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of CreateWalletRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateWalletRequest from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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: CreateWalletRequestWallet

cdp.client.models.create_wallet_request_wallet module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_wallet_request_wallet.CreateWalletRequestWallet(**data)

Bases: BaseModel

Parameters for configuring a wallet

classmethod from_dict(obj)

Create an instance of CreateWalletRequestWallet from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateWalletRequestWallet from a JSON string

Return type:

Optional[Self]

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

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

network_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

use_server_signer: Optional[StrictBool]

cdp.client.models.create_wallet_webhook_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_wallet_webhook_request.CreateWalletWebhookRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of CreateWalletWebhookRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateWalletWebhookRequest from a JSON string

Return type:

Optional[Self]

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

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

notification_uri: StrictStr

signature_header: 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.client.models.create_webhook_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.create_webhook_request.CreateWebhookRequest(**data)

Bases: BaseModel

event_filters: Optional[List[WebhookEventFilter]]

event_type: WebhookEventType

event_type_filter: Optional[WebhookEventTypeFilter]

classmethod from_dict(obj)

Create an instance of CreateWebhookRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CreateWebhookRequest from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

notification_uri: StrictStr

signature_header: 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.client.models.crypto_amount module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.crypto_amount.CryptoAmount(**data)

Bases: BaseModel

An amount in cryptocurrency

amount: StrictStr

asset: Asset

classmethod from_dict(obj)

Create an instance of CryptoAmount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CryptoAmount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.deploy_smart_contract_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.deploy_smart_contract_request.DeploySmartContractRequest(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of DeploySmartContractRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of DeploySmartContractRequest from a JSON string

Return type:

Optional[Self]

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

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

signed_payload: 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.client.models.erc20_transfer_event module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.erc20_transfer_event.ERC20TransferEvent(**data)

Bases: BaseModel

Represents an event triggered by an ERC-20 token transfer on the blockchain. Contains information about the transaction, block, and involved addresses.

block_hash: Optional[StrictStr]

block_number: Optional[StrictInt]

block_time: Optional[datetime]

contract_address: Optional[StrictStr]

event_type: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of ERC20TransferEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ERC20TransferEvent from a JSON string

Return type:

Optional[Self]

log_index: Optional[StrictInt]

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

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

network: Optional[StrictStr]

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

transaction_hash: Optional[StrictStr]

transaction_index: Optional[StrictInt]

value: Optional[StrictStr]

var_from: Optional[StrictStr]

webhook_id: Optional[StrictStr]

cdp.client.models.erc721_transfer_event module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.erc721_transfer_event.ERC721TransferEvent(**data)

Bases: BaseModel

Represents an event triggered by an ERC-721 token transfer on the blockchain. Contains information about the transaction, block, and involved addresses.

block_hash: Optional[StrictStr]

block_number: Optional[StrictInt]

block_time: Optional[datetime]

contract_address: Optional[StrictStr]

event_type: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of ERC721TransferEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ERC721TransferEvent from a JSON string

Return type:

Optional[Self]

log_index: Optional[StrictInt]

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

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

network: Optional[StrictStr]

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

token_id: Optional[StrictStr]

transaction_hash: Optional[StrictStr]

transaction_index: Optional[StrictInt]

var_from: Optional[StrictStr]

webhook_id: Optional[StrictStr]

cdp.client.models.error module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.error.Error(**data)

Bases: BaseModel

An error response from the Coinbase Developer Platform API

code: Annotated[str, Field(strict=True, max_length=5000)]

correlation_id: Optional[StrictStr]

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]

message: Annotated[str, Field(strict=True, max_length=5000)]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.ethereum_token_transfer module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.ethereum_token_transfer.EthereumTokenTransfer(**data)

Bases: BaseModel

contract_address: StrictStr

from_address: StrictStr

classmethod from_dict(obj)

Create an instance of EthereumTokenTransfer from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EthereumTokenTransfer from a JSON string

Return type:

Optional[Self]

log_index: StrictInt

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

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

to_address: 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_id: Optional[StrictStr]

token_transfer_type: TokenTransferType

value: Optional[StrictStr]

cdp.client.models.ethereum_transaction module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.ethereum_transaction.EthereumTransaction(**data)

Bases: BaseModel

block_timestamp: Optional[datetime]

flattened_traces: Optional[List[EthereumTransactionFlattenedTrace]]

classmethod from_dict(obj)

Create an instance of EthereumTransaction from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EthereumTransaction from a JSON string

Return type:

Optional[Self]

gas: Optional[StrictInt]

gas_price: Optional[StrictInt]

hash: Optional[StrictStr]

index: Optional[StrictInt]

input: Optional[StrictStr]

max_fee_per_gas: Optional[StrictInt]

max_priority_fee_per_gas: Optional[StrictInt]

mint: Optional[StrictStr]

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

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

nonce: Optional[StrictInt]

priority_fee_per_gas: Optional[StrictInt]

rlp_encoded_tx: Optional[StrictStr]

to: 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_transfers: Optional[List[EthereumTokenTransfer]]

transaction_access_list: Optional[EthereumTransactionAccessList]

type: Optional[StrictInt]

value: Optional[StrictStr]

var_from: StrictStr

cdp.client.models.ethereum_transaction_access module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.ethereum_transaction_access.EthereumTransactionAccess(**data)

Bases: BaseModel

address: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of EthereumTransactionAccess from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EthereumTransactionAccess from a JSON string

Return type:

Optional[Self]

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

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

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

cdp.client.models.ethereum_transaction_access_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.ethereum_transaction_access_list.EthereumTransactionAccessList(**data)

Bases: BaseModel

access_list: Optional[List[EthereumTransactionAccess]]

classmethod from_dict(obj)

Create an instance of EthereumTransactionAccessList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EthereumTransactionAccessList from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.ethereum_transaction_flattened_trace module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.ethereum_transaction_flattened_trace.EthereumTransactionFlattenedTrace(**data)

Bases: BaseModel

block_hash: Optional[StrictStr]

block_number: Optional[StrictInt]

call_type: Optional[StrictStr]

error: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of EthereumTransactionFlattenedTrace from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EthereumTransactionFlattenedTrace from a JSON string

Return type:

Optional[Self]

gas: Optional[StrictInt]

gas_used: Optional[StrictInt]

input: Optional[StrictStr]

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

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

output: Optional[StrictStr]

status: Optional[StrictInt]

sub_traces: Optional[StrictInt]

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

trace_address: Optional[List[StrictInt]]

trace_id: Optional[StrictStr]

trace_type: Optional[StrictStr]

transaction_hash: Optional[StrictStr]

transaction_index: Optional[StrictInt]

type: Optional[StrictStr]

value: Optional[StrictStr]

var_from: Optional[StrictStr]

cdp.client.models.ethereum_validator_metadata module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.ethereum_validator_metadata.EthereumValidatorMetadata(**data)

Bases: BaseModel

An Ethereum validator.

activation_epoch: StrictStr

balance: Balance

effective_balance: Balance

exit_epoch: StrictStr

classmethod from_dict(obj)

Create an instance of EthereumValidatorMetadata from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of EthereumValidatorMetadata from a JSON string

Return type:

Optional[Self]

index: StrictStr

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

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

public_key: StrictStr

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

withdrawable_epoch: StrictStr

withdrawal_address: StrictStr

cdp.client.models.faucet_transaction module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.faucet_transaction.FaucetTransaction(**data)

Bases: BaseModel

The faucet transaction

classmethod from_dict(obj)

Create an instance of FaucetTransaction from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FaucetTransaction from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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: Transaction

transaction_hash: StrictStr

transaction_link: StrictStr

cdp.client.models.feature_set module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.feature_set.FeatureSet(**data)

Bases: BaseModel

faucet: StrictBool

classmethod from_dict(obj)

Create an instance of FeatureSet from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FeatureSet from a JSON string

Return type:

Optional[Self]

gasless_send: StrictBool

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

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

server_signer: StrictBool

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

trade: StrictBool

transfer: StrictBool

cdp.client.models.fetch_historical_staking_balances200_response module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.fetch_historical_staking_balances200_response.FetchHistoricalStakingBalances200Response(**data)

Bases: BaseModel

data: List[StakingBalance]

classmethod from_dict(obj)

Create an instance of FetchHistoricalStakingBalances200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FetchHistoricalStakingBalances200Response from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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.client.models.fetch_staking_rewards200_response module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.fetch_staking_rewards200_response.FetchStakingRewards200Response(**data)

Bases: BaseModel

data: List[StakingReward]

classmethod from_dict(obj)

Create an instance of FetchStakingRewards200Response from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FetchStakingRewards200Response from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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.client.models.fetch_staking_rewards_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.fetch_staking_rewards_request.FetchStakingRewardsRequest(**data)

Bases: BaseModel

address_ids: List[StrictStr]

asset_id: StrictStr

end_time: datetime

format: StakingRewardFormat

classmethod from_dict(obj)

Create an instance of FetchStakingRewardsRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FetchStakingRewardsRequest from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

start_time: 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.client.models.fiat_amount module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.fiat_amount.FiatAmount(**data)

Bases: BaseModel

An amount in fiat currency

amount: StrictStr

currency: StrictStr

classmethod from_dict(obj)

Create an instance of FiatAmount from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FiatAmount from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.fund_operation module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.fund_operation.FundOperation(**data)

Bases: BaseModel

An operation to fund a wallet with crypto

address_id: StrictStr

crypto_amount: CryptoAmount

fees: FundOperationFees

fiat_amount: FiatAmount

classmethod from_dict(obj)

Create an instance of FundOperation from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FundOperation from a JSON string

Return type:

Optional[Self]

fund_operation_id: StrictStr

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

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

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

wallet_id: StrictStr

cdp.client.models.fund_operation_fees module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.fund_operation_fees.FundOperationFees(**data)

Bases: BaseModel

The fees for a fund operation.

buy_fee: FiatAmount

classmethod from_dict(obj)

Create an instance of FundOperationFees from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FundOperationFees from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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

transfer_fee: CryptoAmount

cdp.client.models.fund_operation_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.fund_operation_list.FundOperationList(**data)

Bases: BaseModel

Paginated list of fund operations

data: List[FundOperation]

classmethod from_dict(obj)

Create an instance of FundOperationList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FundOperationList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.fund_quote module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.fund_quote.FundQuote(**data)

Bases: BaseModel

A quote for a fund operation

address_id: StrictStr

crypto_amount: CryptoAmount

expires_at: datetime

fees: FundOperationFees

fiat_amount: FiatAmount

classmethod from_dict(obj)

Create an instance of FundQuote from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of FundQuote from a JSON string

Return type:

Optional[Self]

fund_quote_id: StrictStr

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

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

network_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

wallet_id: StrictStr

cdp.client.models.get_staking_context_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.get_staking_context_request.GetStakingContextRequest(**data)

Bases: BaseModel

address_id: StrictStr

asset_id: StrictStr

classmethod from_dict(obj)

Create an instance of GetStakingContextRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of GetStakingContextRequest from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

options: Dict[str, 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.client.models.historical_balance module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.historical_balance.HistoricalBalance(**data)

Bases: BaseModel

The balance of an asset onchain at a particular block

amount: StrictStr

asset: Asset

block_hash: StrictStr

block_height: StrictStr

classmethod from_dict(obj)

Create an instance of HistoricalBalance from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of HistoricalBalance from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.multi_token_contract_options module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.multi_token_contract_options.MultiTokenContractOptions(**data)

Bases: BaseModel

Options for multi-token contract creation

classmethod from_dict(obj)

Create an instance of MultiTokenContractOptions from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of MultiTokenContractOptions from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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

uri: StrictStr

cdp.client.models.network module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.network.Network(**data)

Bases: BaseModel

address_path_prefix: Optional[StrictStr]

chain_id: StrictInt

display_name: StrictStr

feature_set: FeatureSet

classmethod from_dict(obj)

Create an instance of Network from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Network from a JSON string

Return type:

Optional[Self]

id: NetworkIdentifier

is_testnet: StrictBool

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

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

native_asset: Asset

protocol_family: StrictStr

classmethod protocol_family_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.client.models.network_identifier module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.network_identifier.NetworkIdentifier(value)

Bases: str, Enum

The ID of the blockchain network. This is unique across all networks, and takes the form of <blockchain>-<network>.

ARBITRUM_MINUS_MAINNET = 'arbitrum-mainnet'

BASE_MINUS_MAINNET = 'base-mainnet'

BASE_MINUS_SEPOLIA = 'base-sepolia'

ETHEREUM_MINUS_HOLESKY = 'ethereum-holesky'

ETHEREUM_MINUS_MAINNET = 'ethereum-mainnet'

POLYGON_MINUS_MAINNET = 'polygon-mainnet'

SOLANA_MINUS_DEVNET = 'solana-devnet'

SOLANA_MINUS_MAINNET = 'solana-mainnet'

classmethod from_json(json_str)

Create an instance of NetworkIdentifier from a JSON string

Return type:

Self

cdp.client.models.nft_contract_options module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.nft_contract_options.NFTContractOptions(**data)

Bases: BaseModel

Options for NFT contract creation

base_uri: StrictStr

classmethod from_dict(obj)

Create an instance of NFTContractOptions from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of NFTContractOptions from a JSON string

Return type:

Optional[Self]

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

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

name: StrictStr

symbol: 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.client.models.onchain_name module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.onchain_name.OnchainName(**data)

Bases: BaseModel

A representation of an onchain stored name from name systems i.e. ENS or Basenames

avatar: Optional[StrictStr]

domain: StrictStr

expires_at: datetime

classmethod from_dict(obj)

Create an instance of OnchainName from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainName from a JSON string

Return type:

Optional[Self]

is_primary: StrictBool

manager_address: StrictStr

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

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

network_id: StrictStr

owner_address: StrictStr

primary_address: Optional[StrictStr]

text_records: Optional[Dict[str, 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_id: StrictStr

cdp.client.models.onchain_name_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.onchain_name_list.OnchainNameList(**data)

Bases: BaseModel

A list of onchain events with pagination information

data: List[OnchainName]

classmethod from_dict(obj)

Create an instance of OnchainNameList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainNameList from a JSON string

Return type:

Optional[Self]

has_more: Optional[StrictBool]

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

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

next_page: 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_count: Optional[StrictInt]

cdp.client.models.onchain_name_text_records_inner module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.onchain_name_text_records_inner.OnchainNameTextRecordsInner(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of OnchainNameTextRecordsInner from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of OnchainNameTextRecordsInner from a JSON string

Return type:

Optional[Self]

key: Optional[StrictStr]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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: Optional[StrictStr]

cdp.client.models.payload_signature module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.payload_signature.PayloadSignature(**data)

Bases: BaseModel

A payload signed by an address.

address_id: StrictStr

classmethod from_dict(obj)

Create an instance of PayloadSignature from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of PayloadSignature from a JSON string

Return type:

Optional[Self]

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

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

payload_signature_id: StrictStr

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

unsigned_payload: StrictStr

wallet_id: StrictStr

cdp.client.models.payload_signature_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.payload_signature_list.PayloadSignatureList(**data)

Bases: BaseModel

data: List[PayloadSignature]

classmethod from_dict(obj)

Create an instance of PayloadSignatureList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of PayloadSignatureList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.read_contract_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.read_contract_request.ReadContractRequest(**data)

Bases: BaseModel

abi: Optional[StrictStr]

args: StrictStr

classmethod from_dict(obj)

Create an instance of ReadContractRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ReadContractRequest from a JSON string

Return type:

Optional[Self]

method: StrictStr

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.read_smart_contract_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.read_smart_contract_request.ReadSmartContractRequest(**data)

Bases: BaseModel

abi: Optional[StrictStr]

args: List[StrictStr]

classmethod from_dict(obj)

Create an instance of ReadSmartContractRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ReadSmartContractRequest from a JSON string

Return type:

Optional[Self]

method: StrictStr

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.seed_creation_event module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.seed_creation_event.SeedCreationEvent(**data)

Bases: BaseModel

An event representing a seed creation.

classmethod from_dict(obj)

Create an instance of SeedCreationEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SeedCreationEvent from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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_id: StrictStr

wallet_user_id: StrictStr

cdp.client.models.seed_creation_event_result module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.seed_creation_event_result.SeedCreationEventResult(**data)

Bases: BaseModel

The result to a SeedCreationEvent.

extended_public_key: StrictStr

classmethod from_dict(obj)

Create an instance of SeedCreationEventResult from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SeedCreationEventResult from a JSON string

Return type:

Optional[Self]

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

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

seed_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

wallet_id: StrictStr

wallet_user_id: StrictStr

cdp.client.models.server_signer module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.server_signer.ServerSigner(**data)

Bases: BaseModel

A Server-Signer assigned to sign transactions in a wallet.

classmethod from_dict(obj)

Create an instance of ServerSigner from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ServerSigner from a JSON string

Return type:

Optional[Self]

is_mpc: StrictBool

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

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

server_signer_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

wallets: Optional[List[StrictStr]]

cdp.client.models.server_signer_event module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.server_signer_event.ServerSignerEvent(**data)

Bases: BaseModel

An event that is waiting to be processed by a Server-Signer.

event: ServerSignerEventEvent

classmethod from_dict(obj)

Create an instance of ServerSignerEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ServerSignerEvent from a JSON string

Return type:

Optional[Self]

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

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

server_signer_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.client.models.server_signer_event_event module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.server_signer_event_event.ServerSignerEventEvent(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[SeedCreationEvent, SignatureCreationEvent]]

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

oneof_schema_2_validator: Optional[SignatureCreationEvent]

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], SeedCreationEvent, SignatureCreationEvent, 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.client.models.server_signer_event_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.server_signer_event_list.ServerSignerEventList(**data)

Bases: BaseModel

data: List[ServerSignerEvent]

classmethod from_dict(obj)

Create an instance of ServerSignerEventList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ServerSignerEventList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.server_signer_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.server_signer_list.ServerSignerList(**data)

Bases: BaseModel

data: List[ServerSigner]

classmethod from_dict(obj)

Create an instance of ServerSignerList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ServerSignerList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.signature_creation_event module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.signature_creation_event.SignatureCreationEvent(**data)

Bases: BaseModel

An event representing a signature creation.

address_id: StrictStr

address_index: StrictInt

classmethod from_dict(obj)

Create an instance of SignatureCreationEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignatureCreationEvent from a JSON string

Return type:

Optional[Self]

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

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

seed_id: StrictStr

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

transaction_id: StrictStr

transaction_type: TransactionType

wallet_id: StrictStr

wallet_user_id: StrictStr

cdp.client.models.signature_creation_event_result module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.signature_creation_event_result.SignatureCreationEventResult(**data)

Bases: BaseModel

The result to a SignatureCreationEvent.

address_id: StrictStr

classmethod from_dict(obj)

Create an instance of SignatureCreationEventResult from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignatureCreationEventResult from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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

transaction_id: StrictStr

transaction_type: TransactionType

wallet_id: StrictStr

wallet_user_id: StrictStr

cdp.client.models.signed_voluntary_exit_message_metadata module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.signed_voluntary_exit_message_metadata.SignedVoluntaryExitMessageMetadata(**data)

Bases: BaseModel

Signed voluntary exit message metadata to be provided to beacon chain to exit a validator.

fork: StrictStr

classmethod from_dict(obj)

Create an instance of SignedVoluntaryExitMessageMetadata from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SignedVoluntaryExitMessageMetadata from a JSON string

Return type:

Optional[Self]

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

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

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

validator_pub_key: StrictStr

cdp.client.models.smart_contract module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.smart_contract.SmartContract(**data)

Bases: BaseModel

Represents a smart contract on the blockchain

abi: StrictStr

contract_address: StrictStr

contract_name: StrictStr

deployer_address: StrictStr

classmethod from_dict(obj)

Create an instance of SmartContract from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SmartContract from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

options: SmartContractOptions

smart_contract_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

transaction: Transaction

type: SmartContractType

wallet_id: StrictStr

cdp.client.models.smart_contract_activity_event module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.smart_contract_activity_event.SmartContractActivityEvent(**data)

Bases: BaseModel

Represents an event triggered by a smart contract activity on the blockchain. Contains information about the function, transaction, block, and involved addresses.

block_hash: Optional[StrictStr]

block_number: Optional[StrictInt]

block_time: Optional[datetime]

contract_address: Optional[StrictStr]

contract_name: Optional[StrictStr]

event_type: Optional[StrictStr]

four_bytes: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of SmartContractActivityEvent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SmartContractActivityEvent from a JSON string

Return type:

Optional[Self]

func: Optional[StrictStr]

log_index: Optional[StrictInt]

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

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

network: Optional[StrictStr]

project_name: Optional[StrictStr]

sig: Optional[StrictStr]

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

transaction_hash: Optional[StrictStr]

transaction_index: Optional[StrictInt]

value: Optional[StrictInt]

var_from: Optional[StrictStr]

webhook_id: Optional[StrictStr]

cdp.client.models.smart_contract_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.smart_contract_list.SmartContractList(**data)

Bases: BaseModel

data: List[SmartContract]

classmethod from_dict(obj)

Create an instance of SmartContractList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SmartContractList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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.client.models.smart_contract_options module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.smart_contract_options.SmartContractOptions(*args, **kwargs)

Bases: BaseModel

Options for smart contract creation

actual_instance: Optional[Union[MultiTokenContractOptions, NFTContractOptions, TokenContractOptions]]

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

oneof_schema_2_validator: Optional[NFTContractOptions]

oneof_schema_3_validator: Optional[MultiTokenContractOptions]

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], MultiTokenContractOptions, NFTContractOptions, TokenContractOptions, 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.client.models.smart_contract_type module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.smart_contract_type.SmartContractType(value)

Bases: str, Enum

The type of the smart contract.

CUSTOM = 'custom'

ERC1155 = 'erc1155'

ERC20 = 'erc20'

ERC721 = 'erc721'

classmethod from_json(json_str)

Create an instance of SmartContractType from a JSON string

Return type:

Self

cdp.client.models.solidity_value module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.solidity_value.SolidityValue(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of SolidityValue from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SolidityValue from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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

classmethod type_validate_enum(value)

Validates the enum

value: Optional[StrictStr]

values: Optional[List[SolidityValue]]

cdp.client.models.sponsored_send module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.sponsored_send.SponsoredSend(**data)

Bases: BaseModel

An onchain sponsored gasless send.

classmethod from_dict(obj)

Create an instance of SponsoredSend from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of SponsoredSend from a JSON string

Return type:

Optional[Self]

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

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

raw_typed_data: StrictStr

signature: Optional[StrictStr]

status: StrictStr

classmethod status_validate_enum(value)

Validates the enum

to_address_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

transaction_hash: Optional[StrictStr]

transaction_link: Optional[StrictStr]

typed_data_hash: StrictStr

cdp.client.models.staking_balance module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.staking_balance.StakingBalance(**data)

Bases: BaseModel

The staking balances for an address.

address: StrictStr

bonded_stake: Balance

classmethod from_dict(obj)

Create an instance of StakingBalance from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of StakingBalance from a JSON string

Return type:

Optional[Self]

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

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

participant_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

unbonded_balance: Balance

var_date: datetime

cdp.client.models.staking_context module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.staking_context.StakingContext(**data)

Bases: BaseModel

Context needed to perform a staking operation

context: StakingContextContext

classmethod from_dict(obj)

Create an instance of StakingContext from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of StakingContext from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.staking_context_context module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.staking_context_context.StakingContextContext(**data)

Bases: BaseModel

claimable_balance: Balance

classmethod from_dict(obj)

Create an instance of StakingContextContext from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of StakingContextContext from a JSON string

Return type:

Optional[Self]

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

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

stakeable_balance: Balance

to_dict()

Return the dictionary representation of the model using alias.

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

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

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

unstakeable_balance: Balance

cdp.client.models.staking_operation module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.staking_operation.StakingOperation(**data)

Bases: BaseModel

A list of onchain transactions to help realize a staking action.

address_id: StrictStr

classmethod from_dict(obj)

Create an instance of StakingOperation from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of StakingOperation from a JSON string

Return type:

Optional[Self]

id: StrictStr

metadata: Optional[StakingOperationMetadata]

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

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

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

transactions: List[Transaction]

wallet_id: Optional[StrictStr]

cdp.client.models.staking_operation_metadata module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.staking_operation_metadata.StakingOperationMetadata(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[List[SignedVoluntaryExitMessageMetadata]]]

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[List[SignedVoluntaryExitMessageMetadata]]

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], List[SignedVoluntaryExitMessageMetadata], 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.client.models.staking_reward module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.staking_reward.StakingReward(**data)

Bases: BaseModel

The staking rewards for an address.

address_id: StrictStr

amount: StrictStr

format: StakingRewardFormat

classmethod from_dict(obj)

Create an instance of StakingReward from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of StakingReward from a JSON string

Return type:

Optional[Self]

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

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

state: StrictStr

classmethod state_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

usd_value: StakingRewardUSDValue

var_date: datetime

cdp.client.models.staking_reward_format module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.staking_reward_format.StakingRewardFormat(value)

Bases: str, Enum

The format in which the rewards are to be fetched i.e native or in equivalent USD

NATIVE = 'native'

USD = 'usd'

classmethod from_json(json_str)

Create an instance of StakingRewardFormat from a JSON string

Return type:

Self

cdp.client.models.staking_reward_usd_value module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.staking_reward_usd_value.StakingRewardUSDValue(**data)

Bases: BaseModel

The USD value of the reward

amount: StrictStr

conversion_price: StrictStr

conversion_time: datetime

classmethod from_dict(obj)

Create an instance of StakingRewardUSDValue from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of StakingRewardUSDValue from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.token_contract_options module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.token_contract_options.TokenContractOptions(**data)

Bases: BaseModel

Options for token contract creation

classmethod from_dict(obj)

Create an instance of TokenContractOptions from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TokenContractOptions from a JSON string

Return type:

Optional[Self]

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

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

name: StrictStr

symbol: 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_supply: StrictStr

cdp.client.models.token_transfer_type module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.token_transfer_type.TokenTransferType(value)

Bases: str, Enum

The type of the token transfer.

ERC1155 = 'erc1155'

ERC20 = 'erc20'

ERC721 = 'erc721'

UNKNOWN = 'unknown'

classmethod from_json(json_str)

Create an instance of TokenTransferType from a JSON string

Return type:

Self

cdp.client.models.trade module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.trade.Trade(**data)

Bases: BaseModel

A trade of an asset to another asset

address_id: StrictStr

approve_transaction: Optional[Transaction]

from_amount: StrictStr

from_asset: Asset

classmethod from_dict(obj)

Create an instance of Trade from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Trade from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

to_amount: StrictStr

to_asset: Asset

to_dict()

Return the dictionary representation of the model using alias.

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

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

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

trade_id: StrictStr

transaction: Transaction

wallet_id: StrictStr

cdp.client.models.trade_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.trade_list.TradeList(**data)

Bases: BaseModel

data: List[Trade]

classmethod from_dict(obj)

Create an instance of TradeList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TradeList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.transaction module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.transaction.Transaction(**data)

Bases: BaseModel

An onchain transaction.

block_hash: Optional[StrictStr]

block_height: Optional[StrictStr]

content: Optional[TransactionContent]

from_address_id: StrictStr

classmethod from_dict(obj)

Create an instance of Transaction from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Transaction from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

signed_payload: Optional[StrictStr]

status: StrictStr

classmethod status_validate_enum(value)

Validates the enum

to_address_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

transaction_hash: Optional[StrictStr]

transaction_link: Optional[StrictStr]

unsigned_payload: StrictStr

cdp.client.models.transaction_content module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.transaction_content.TransactionContent(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[EthereumTransaction]]

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

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], EthereumTransaction, 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.client.models.transaction_type module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.transaction_type.TransactionType(value)

Bases: str, Enum

TRANSFER = 'transfer'

classmethod from_json(json_str)

Create an instance of TransactionType from a JSON string

Return type:

Self

cdp.client.models.transfer module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.transfer.Transfer(**data)

Bases: BaseModel

A transfer of an asset from one address to another

address_id: StrictStr

amount: StrictStr

asset: Asset

asset_id: StrictStr

destination: StrictStr

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]

gasless: StrictBool

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

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

network_id: StrictStr

signed_payload: Optional[StrictStr]

sponsored_send: Optional[SponsoredSend]

status: Optional[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: Optional[Transaction]

transaction_hash: Optional[StrictStr]

transfer_id: StrictStr

unsigned_payload: Optional[StrictStr]

wallet_id: StrictStr

cdp.client.models.transfer_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.transfer_list.TransferList(**data)

Bases: BaseModel

data: List[Transfer]

classmethod from_dict(obj)

Create an instance of TransferList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of TransferList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.update_webhook_request module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.update_webhook_request.UpdateWebhookRequest(**data)

Bases: BaseModel

event_filters: Optional[List[WebhookEventFilter]]

event_type_filter: Optional[WebhookEventTypeFilter]

classmethod from_dict(obj)

Create an instance of UpdateWebhookRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of UpdateWebhookRequest from a JSON string

Return type:

Optional[Self]

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

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

notification_uri: 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.client.models.user module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.user.User(**data)

Bases: BaseModel

display_name: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of User from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of User from a JSON string

Return type:

Optional[Self]

id: StrictStr

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.validator module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.validator.Validator(**data)

Bases: BaseModel

A validator onchain.

asset_id: StrictStr

details: Optional[ValidatorDetails]

classmethod from_dict(obj)

Create an instance of Validator from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Validator from a JSON string

Return type:

Optional[Self]

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

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

network_id: StrictStr

status: ValidatorStatus

to_dict()

Return the dictionary representation of the model using alias.

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

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

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

validator_id: StrictStr

cdp.client.models.validator_details module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.validator_details.ValidatorDetails(*args, **kwargs)

Bases: BaseModel

actual_instance: Optional[Union[EthereumValidatorMetadata]]

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

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], EthereumValidatorMetadata, 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.client.models.validator_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.validator_list.ValidatorList(**data)

Bases: BaseModel

data: List[Validator]

classmethod from_dict(obj)

Create an instance of ValidatorList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ValidatorList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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.client.models.validator_status module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.validator_status.ValidatorStatus(value)

Bases: str, Enum

The status of the validator.

ACTIVE = 'active'

ACTIVE_SLASHED = 'active_slashed'

DEPOSITED = 'deposited'

EXITED = 'exited'

EXITED_SLASHED = 'exited_slashed'

EXITING = 'exiting'

PENDING_ACTIVATION = 'pending_activation'

PROVISIONED = 'provisioned'

PROVISIONING = 'provisioning'

REAPED = 'reaped'

UNKNOWN = 'unknown'

WITHDRAWAL_AVAILABLE = 'withdrawal_available'

WITHDRAWAL_COMPLETE = 'withdrawal_complete'

classmethod from_json(json_str)

Create an instance of ValidatorStatus from a JSON string

Return type:

Self

cdp.client.models.wallet module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.wallet.Wallet(**data)

Bases: BaseModel

default_address: Optional[Address]

feature_set: FeatureSet

classmethod from_dict(obj)

Create an instance of Wallet from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Wallet from a JSON string

Return type:

Optional[Self]

id: StrictStr

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

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

network_id: StrictStr

server_signer_status: Optional[StrictStr]

classmethod server_signer_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

cdp.client.models.wallet_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.wallet_list.WalletList(**data)

Bases: BaseModel

Paginated list of wallets

data: List[Wallet]

classmethod from_dict(obj)

Create an instance of WalletList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WalletList from a JSON string

Return type:

Optional[Self]

has_more: StrictBool

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

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

next_page: 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_count: StrictInt

cdp.client.models.webhook module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.webhook.Webhook(**data)

Bases: BaseModel

Webhook that is used for getting notifications when monitored events occur.

created_at: Optional[datetime]

event_filters: Optional[List[WebhookEventFilter]]

event_type: Optional[WebhookEventType]

event_type_filter: Optional[WebhookEventTypeFilter]

classmethod from_dict(obj)

Create an instance of Webhook from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Webhook from a JSON string

Return type:

Optional[Self]

id: Optional[StrictStr]

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

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

network_id: Optional[StrictStr]

notification_uri: Optional[StrictStr]

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

updated_at: Optional[datetime]

cdp.client.models.webhook_event_filter module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.webhook_event_filter.WebhookEventFilter(**data)

Bases: BaseModel

The event_filter parameter specifies the criteria to filter events from the blockchain. It allows filtering events by contract address, sender address and receiver address. For a single event filter, not all of the properties need to be presented.

contract_address: Optional[StrictStr]

from_address: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of WebhookEventFilter from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookEventFilter from a JSON string

Return type:

Optional[Self]

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

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

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

cdp.client.models.webhook_event_type module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.webhook_event_type.WebhookEventType(value)

Bases: str, Enum

ERC20_TRANSFER = 'erc20_transfer'

ERC721_TRANSFER = 'erc721_transfer'

SMART_CONTRACT_EVENT_ACTIVITY = 'smart_contract_event_activity'

UNSPECIFIED = 'unspecified'

WALLET_ACTIVITY = 'wallet_activity'

classmethod from_json(json_str)

Create an instance of WebhookEventType from a JSON string

Return type:

Self

cdp.client.models.webhook_event_type_filter module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.webhook_event_type_filter.WebhookEventTypeFilter(*args, **kwargs)

Bases: BaseModel

The event_type_filter parameter specifies the criteria to filter events based on event type.

actual_instance: Optional[Union[WebhookSmartContractEventFilter, WebhookWalletActivityFilter]]

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

oneof_schema_2_validator: Optional[WebhookSmartContractEventFilter]

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], WebhookSmartContractEventFilter, WebhookWalletActivityFilter, 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.client.models.webhook_list module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.webhook_list.WebhookList(**data)

Bases: BaseModel

data: List[Webhook]

classmethod from_dict(obj)

Create an instance of WebhookList from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookList from a JSON string

Return type:

Optional[Self]

has_more: Optional[StrictBool]

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

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

next_page: 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.client.models.webhook_smart_contract_event_filter module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.webhook_smart_contract_event_filter.WebhookSmartContractEventFilter(**data)

Bases: BaseModel

Filter for smart contract events. This filter allows the client to specify smart contract addresses to monitor for activities such as contract function calls.

contract_addresses: List[StrictStr]

classmethod from_dict(obj)

Create an instance of WebhookSmartContractEventFilter from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookSmartContractEventFilter from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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.client.models.webhook_wallet_activity_filter module

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class cdp.client.models.webhook_wallet_activity_filter.WebhookWalletActivityFilter(**data)

Bases: BaseModel

Filter for wallet activity events. This filter allows the client to specify one or more wallet addresses to monitor for activities such as transactions, transfers, or other types of events that are associated with the specified addresses.

addresses: Optional[List[StrictStr]]

classmethod from_dict(obj)

Create an instance of WebhookWalletActivityFilter from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of WebhookWalletActivityFilter from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': 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_id: StrictStr

Module contents

Coinbase Platform API

This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.

The version of the OpenAPI document: 0.0.1-alpha Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.