cdp.openapi_client.models package¶
Submodules¶
cdp.openapi_client.models.abi_function module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.abi_function.AbiFunction(**data)¶
Bases:
BaseModelABI function type for contract functions.
- constant: Optional[StrictBool]¶
- classmethod from_dict(obj)¶
Create an instance of AbiFunction from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of AbiFunction from a JSON string
- Return type:
Optional[Self]
- gas: Optional[StrictInt]¶
- inputs: List[AbiParameter]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: StrictStr¶
- outputs: List[AbiParameter]¶
- payable: Optional[StrictBool]¶
- state_mutability: AbiStateMutability¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.abi_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.abi_inner.AbiInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[AbiFunction, AbiInput]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[AbiFunction]¶
- oneof_schema_2_validator: Optional[AbiInput]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],AbiFunction,AbiInput,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.abi_input module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.abi_input.AbiInput(**data)¶
Bases:
BaseModelGeneric ABI item type encapsulating all other types besides function.
- additional_properties: Optional[Any]¶
- classmethod from_dict(obj)¶
Create an instance of AbiInput from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of AbiInput from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.abi_parameter module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.abi_parameter.AbiParameter(**data)¶
Bases:
BaseModelParameter definition for ABI functions, errors, and constructors.
- components: Optional[List[AbiParameter]]¶
- classmethod from_dict(obj)¶
Create an instance of AbiParameter from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of AbiParameter from a JSON string
- Return type:
Optional[Self]
- internal_type: Optional[StrictStr]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
cdp.openapi_client.models.abi_state_mutability module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.abi_state_mutability.AbiStateMutability(value)¶
Bases:
str,EnumState mutability of a function in Solidity.
- NONPAYABLE = 'nonpayable'¶
- PAYABLE = 'payable'¶
- PURE = 'pure'¶
- VIEW = 'view'¶
- classmethod from_json(json_str)¶
Create an instance of AbiStateMutability from a JSON string
- Return type:
Self
cdp.openapi_client.models.account_token_addresses_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.account_token_addresses_response.AccountTokenAddressesResponse(**data)¶
Bases:
BaseModelResponse containing token addresses that an account has received.
- account_address: Optional[StrictStr]¶
- classmethod from_dict(obj)¶
Create an instance of AccountTokenAddressesResponse from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of AccountTokenAddressesResponse from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- token_addresses: Optional[List[Annotated[str, Field(strict=True)]]]¶
- total_count: Optional[Annotated[int, Field(strict=True, ge=0)]]¶
cdp.openapi_client.models.authentication_method module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.authentication_method.AuthenticationMethod(*args, **kwargs)¶
Bases:
BaseModelInformation about how the end user is authenticated.
- actual_instance: Optional[Union[DeveloperJWTAuthentication, EmailAuthentication, SmsAuthentication]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[EmailAuthentication]¶
- oneof_schema_2_validator: Optional[SmsAuthentication]¶
- oneof_schema_3_validator: Optional[DeveloperJWTAuthentication]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],DeveloperJWTAuthentication,EmailAuthentication,SmsAuthentication,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.common_swap_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.common_swap_response.CommonSwapResponse(**data)¶
Bases:
BaseModel- block_number: Annotated[str, Field(strict=True)]¶
- classmethod block_number_validate_regular_expression(value)¶
Validates the regular expression
- fees: CommonSwapResponseFees¶
- from_amount: Annotated[str, Field(strict=True)]¶
- classmethod from_amount_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of CommonSwapResponse from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CommonSwapResponse from a JSON string
- Return type:
Optional[Self]
- from_token: Annotated[str, Field(strict=True)]¶
- classmethod from_token_validate_regular_expression(value)¶
Validates the regular expression
- issues: CommonSwapResponseIssues¶
- liquidity_available: StrictBool¶
- min_to_amount: Annotated[str, Field(strict=True)]¶
- classmethod min_to_amount_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_amount: Annotated[str, Field(strict=True)]¶
- classmethod to_amount_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_token: Annotated[str, Field(strict=True)]¶
- classmethod to_token_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.common_swap_response_fees module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.common_swap_response_fees.CommonSwapResponseFees(**data)¶
Bases:
BaseModelThe estimated fees for the swap.
- classmethod from_dict(obj)¶
Create an instance of CommonSwapResponseFees from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CommonSwapResponseFees from a JSON string
- Return type:
Optional[Self]
- gas_fee: Optional[TokenFee]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- protocol_fee: Optional[TokenFee]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.common_swap_response_issues module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.common_swap_response_issues.CommonSwapResponseIssues(**data)¶
Bases:
BaseModelAn object containing potential issues discovered during validation that could prevent the swap from being executed successfully.
- allowance: Optional[CommonSwapResponseIssuesAllowance]¶
- balance: Optional[CommonSwapResponseIssuesBalance]¶
- classmethod from_dict(obj)¶
Create an instance of CommonSwapResponseIssues from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CommonSwapResponseIssues from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- simulation_incomplete: StrictBool¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.common_swap_response_issues_allowance module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.common_swap_response_issues_allowance.CommonSwapResponseIssuesAllowance(**data)¶
Bases:
BaseModelDetails of the allowances that the taker must set in order to execute the swap successfully. Null if no allowance is required.
- current_allowance: Annotated[str, Field(strict=True)]¶
- classmethod current_allowance_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of CommonSwapResponseIssuesAllowance from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CommonSwapResponseIssuesAllowance from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- spender: Annotated[str, Field(strict=True)]¶
- classmethod spender_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.common_swap_response_issues_balance module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.common_swap_response_issues_balance.CommonSwapResponseIssuesBalance(**data)¶
Bases:
BaseModelDetails of the balance of the fromToken that the taker must hold. Null if the taker has a sufficient balance.
- current_balance: Annotated[str, Field(strict=True)]¶
- classmethod current_balance_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of CommonSwapResponseIssuesBalance from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CommonSwapResponseIssuesBalance from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- required_balance: Annotated[str, Field(strict=True)]¶
- classmethod required_balance_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- token: Annotated[str, Field(strict=True)]¶
- classmethod token_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.create_evm_account_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_evm_account_request.CreateEvmAccountRequest(**data)¶
Bases:
BaseModel- account_policy: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod account_policy_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of CreateEvmAccountRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateEvmAccountRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_evm_smart_account_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_evm_smart_account_request.CreateEvmSmartAccountRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of CreateEvmSmartAccountRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateEvmSmartAccountRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- owners: List[Annotated[str, Field(strict=True)]]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_evm_swap_quote_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_evm_swap_quote_request.CreateEvmSwapQuoteRequest(**data)¶
Bases:
BaseModel- from_amount: Annotated[str, Field(strict=True)]¶
- classmethod from_amount_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of CreateEvmSwapQuoteRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateEvmSwapQuoteRequest from a JSON string
- Return type:
Optional[Self]
- from_token: Annotated[str, Field(strict=True)]¶
- classmethod from_token_validate_regular_expression(value)¶
Validates the regular expression
- gas_price: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod gas_price_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: EvmSwapsNetwork¶
- signer_address: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod signer_address_validate_regular_expression(value)¶
Validates the regular expression
- slippage_bps: Optional[Annotated[int, Field(le=10000, strict=True, ge=0)]]¶
- taker: Annotated[str, Field(strict=True)]¶
- classmethod taker_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_token: Annotated[str, Field(strict=True)]¶
- classmethod to_token_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.create_onramp_order201_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_onramp_order201_response.CreateOnrampOrder201Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of CreateOnrampOrder201Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateOnrampOrder201Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- order: OnrampOrder¶
- payment_link: Optional[OnrampPaymentLink]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_onramp_order_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_onramp_order_request.CreateOnrampOrderRequest(**data)¶
Bases:
BaseModel- agreement_accepted_at: datetime¶
- destination_address: StrictStr¶
- destination_network: StrictStr¶
- email: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of CreateOnrampOrderRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateOnrampOrderRequest from a JSON string
- Return type:
Optional[Self]
- is_quote: Optional[StrictBool]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- partner_order_ref: Optional[StrictStr]¶
- partner_user_ref: StrictStr¶
- payment_amount: Optional[StrictStr]¶
- payment_currency: StrictStr¶
- payment_method: OnrampOrderPaymentMethodTypeId¶
- phone_number: StrictStr¶
- phone_number_verified_at: datetime¶
- purchase_amount: Optional[StrictStr]¶
- purchase_currency: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_onramp_session201_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_onramp_session201_response.CreateOnrampSession201Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of CreateOnrampSession201Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateOnrampSession201Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- quote: Optional[OnrampQuote]¶
- session: OnrampSession¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_onramp_session_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_onramp_session_request.CreateOnrampSessionRequest(**data)¶
Bases:
BaseModel- country: Optional[StrictStr]¶
- destination_address: StrictStr¶
- destination_network: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of CreateOnrampSessionRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateOnrampSessionRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- payment_amount: Optional[StrictStr]¶
- payment_currency: Optional[StrictStr]¶
- payment_method: Optional[OnrampQuotePaymentMethodTypeId]¶
- purchase_currency: StrictStr¶
- redirect_url: Optional[StrictStr]¶
- subdivision: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_payment_transfer_quote201_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_payment_transfer_quote201_response.CreatePaymentTransferQuote201Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of CreatePaymentTransferQuote201Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreatePaymentTransferQuote201Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transfer: Transfer¶
cdp.openapi_client.models.create_payment_transfer_quote_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_payment_transfer_quote_request.CreatePaymentTransferQuoteRequest(**data)¶
Bases:
BaseModel- amount: StrictStr¶
- currency: StrictStr¶
- execute: Optional[StrictBool]¶
- classmethod from_dict(obj)¶
Create an instance of CreatePaymentTransferQuoteRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreatePaymentTransferQuoteRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- source: TransferSource¶
- source_type: StrictStr¶
- classmethod source_type_validate_enum(value)¶
Validates the enum
- target: TransferTarget¶
- target_type: StrictStr¶
- classmethod target_type_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_policy_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_policy_request.CreatePolicyRequest(**data)¶
Bases:
BaseModel- description: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod description_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of CreatePolicyRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreatePolicyRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- rules: List[Rule]¶
- scope: StrictStr¶
- classmethod scope_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_solana_account_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_solana_account_request.CreateSolanaAccountRequest(**data)¶
Bases:
BaseModel- account_policy: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod account_policy_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of CreateSolanaAccountRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateSolanaAccountRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_spend_permission_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_spend_permission_request.CreateSpendPermissionRequest(**data)¶
Bases:
BaseModelRequest parameters for creating a Spend Permission.
- allowance: StrictStr¶
- end: StrictStr¶
- extra_data: Optional[StrictStr]¶
- classmethod from_dict(obj)¶
Create an instance of CreateSpendPermissionRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateSpendPermissionRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: SpendPermissionNetwork¶
- paymaster_url: Optional[StrictStr]¶
- period: StrictStr¶
- salt: Optional[StrictStr]¶
- spender: Annotated[str, Field(strict=True)]¶
- classmethod spender_validate_regular_expression(value)¶
Validates the regular expression
- start: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- token: Annotated[str, Field(strict=True)]¶
- classmethod token_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.create_swap_quote_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_swap_quote_response.CreateSwapQuoteResponse(**data)¶
Bases:
BaseModel- block_number: Annotated[str, Field(strict=True)]¶
- classmethod block_number_validate_regular_expression(value)¶
Validates the regular expression
- fees: CommonSwapResponseFees¶
- from_amount: Annotated[str, Field(strict=True)]¶
- classmethod from_amount_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of CreateSwapQuoteResponse from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateSwapQuoteResponse from a JSON string
- Return type:
Optional[Self]
- from_token: Annotated[str, Field(strict=True)]¶
- classmethod from_token_validate_regular_expression(value)¶
Validates the regular expression
- issues: CommonSwapResponseIssues¶
- liquidity_available: StrictBool¶
- min_to_amount: Annotated[str, Field(strict=True)]¶
- classmethod min_to_amount_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- permit2: Optional[CreateSwapQuoteResponseAllOfPermit2]¶
- to_amount: Annotated[str, Field(strict=True)]¶
- classmethod to_amount_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_token: Annotated[str, Field(strict=True)]¶
- classmethod to_token_validate_regular_expression(value)¶
Validates the regular expression
- transaction: CreateSwapQuoteResponseAllOfTransaction¶
cdp.openapi_client.models.create_swap_quote_response_all_of_permit2 module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_swap_quote_response_all_of_permit2.CreateSwapQuoteResponseAllOfPermit2(**data)¶
Bases:
BaseModelThe approval object which contains the necessary fields to submit an approval for this transaction. Null if the fromToken is the native token or the transaction is a native token wrap / unwrap.
- eip712: EIP712Message¶
- classmethod from_dict(obj)¶
Create an instance of CreateSwapQuoteResponseAllOfPermit2 from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateSwapQuoteResponseAllOfPermit2 from a JSON string
- Return type:
Optional[Self]
- hash: Annotated[str, Field(strict=True)]¶
- classmethod hash_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.create_swap_quote_response_all_of_transaction module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_swap_quote_response_all_of_transaction.CreateSwapQuoteResponseAllOfTransaction(**data)¶
Bases:
BaseModelThe details of the transaction to be signed and submitted to execute the swap.
- data: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of CreateSwapQuoteResponseAllOfTransaction from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CreateSwapQuoteResponseAllOfTransaction from a JSON string
- Return type:
Optional[Self]
- gas: Annotated[str, Field(strict=True)]¶
- gas_price: Annotated[str, Field(strict=True)]¶
- classmethod gas_price_validate_regular_expression(value)¶
Validates the regular expression
- classmethod gas_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to: Annotated[str, Field(strict=True)]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- classmethod to_validate_regular_expression(value)¶
Validates the regular expression
- value: Annotated[str, Field(strict=True)]¶
- classmethod value_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.create_swap_quote_response_wrapper module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.create_swap_quote_response_wrapper.CreateSwapQuoteResponseWrapper(*args, **kwargs)¶
Bases:
BaseModelA wrapper for the response of a swap quote operation.
- actual_instance: Optional[Union[CreateSwapQuoteResponse, SwapUnavailableResponse]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[CreateSwapQuoteResponse]¶
- oneof_schema_2_validator: Optional[SwapUnavailableResponse]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],CreateSwapQuoteResponse,SwapUnavailableResponse,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.crypto_rail module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.crypto_rail.CryptoRail(**data)¶
Bases:
BaseModelThe crypto rails available.
- actions: List[PaymentRailAction]¶
- currency: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of CryptoRail from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CryptoRail from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: StrictStr¶
- networks: List[CryptoRailNetworksInner]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.crypto_rail_address module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.crypto_rail_address.CryptoRailAddress(**data)¶
Bases:
BaseModelThe crypto rail input object which specifies the symbol, network, and address which is the source or destination wallet address.
- address: StrictStr¶
- currency: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of CryptoRailAddress from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CryptoRailAddress from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.crypto_rail_networks_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.crypto_rail_networks_inner.CryptoRailNetworksInner(**data)¶
Bases:
BaseModelThe networks of the asset.
- chain_id: Optional[StrictInt]¶
- contract_address: Optional[StrictStr]¶
- classmethod from_dict(obj)¶
Create an instance of CryptoRailNetworksInner from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of CryptoRailNetworksInner from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.developer_jwt_authentication module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.developer_jwt_authentication.DeveloperJWTAuthentication(**data)¶
Bases:
BaseModelInformation about an end user who authenticates using a JWT issued by the developer.
- classmethod from_dict(obj)¶
Create an instance of DeveloperJWTAuthentication from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of DeveloperJWTAuthentication from a JSON string
- Return type:
Optional[Self]
- kid: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- sub: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.eip712_domain module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.eip712_domain.EIP712Domain(**data)¶
Bases:
BaseModelThe domain of the EIP-712 typed data.
- chain_id: Optional[StrictInt]¶
- classmethod from_dict(obj)¶
Create an instance of EIP712Domain from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EIP712Domain from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[StrictStr]¶
- salt: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod salt_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- verifying_contract: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod verifying_contract_validate_regular_expression(value)¶
Validates the regular expression
- version: Optional[StrictStr]¶
cdp.openapi_client.models.eip712_message module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.eip712_message.EIP712Message(**data)¶
Bases:
BaseModelThe message to sign using EIP-712.
- domain: EIP712Domain¶
- classmethod from_dict(obj)¶
Create an instance of EIP712Message from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EIP712Message from a JSON string
- Return type:
Optional[Self]
- message: Dict[str, Any]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- primary_type: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- types: Dict[str, Any]¶
cdp.openapi_client.models.email_authentication module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.email_authentication.EmailAuthentication(**data)¶
Bases:
BaseModelInformation about an end user who authenticates using a one-time password sent to their email address.
- email: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of EmailAuthentication from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EmailAuthentication from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.end_user module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.end_user.EndUser(**data)¶
Bases:
BaseModelInformation about the end user.
- authentication_methods: List[AuthenticationMethod]¶
- evm_accounts: List[Annotated[str, Field(strict=True)]]¶
- evm_smart_accounts: List[Annotated[str, Field(strict=True)]]¶
- classmethod from_dict(obj)¶
Create an instance of EndUser from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EndUser from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- solana_accounts: List[Annotated[str, Field(strict=True)]]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- user_id: Annotated[str, Field(strict=True)]¶
- classmethod user_id_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.error module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.error.Error(**data)¶
Bases:
BaseModelAn error response including the code for the type of error and a human-readable message describing the error.
- correlation_id: Optional[StrictStr]¶
- error_link: Optional[StrictStr]¶
- error_message: StrictStr¶
- error_type: ErrorType¶
- classmethod from_dict(obj)¶
Create an instance of Error from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of Error from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.error_type module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.error_type.ErrorType(value)¶
Bases:
str,EnumThe code that indicates the type of error that occurred. These error codes can be used to determine how to handle the error.
- ACCOUNT_LIMIT_EXCEEDED = 'account_limit_exceeded'¶
- ALREADY_EXISTS = 'already_exists'¶
- BAD_GATEWAY = 'bad_gateway'¶
- DOCUMENT_VERIFICATION_FAILED = 'document_verification_failed'¶
- FAUCET_LIMIT_EXCEEDED = 'faucet_limit_exceeded'¶
- FORBIDDEN = 'forbidden'¶
- GUEST_PERMISSION_DENIED = 'guest_permission_denied'¶
- GUEST_REGION_FORBIDDEN = 'guest_region_forbidden'¶
- GUEST_TRANSACTION_COUNT = 'guest_transaction_count'¶
- GUEST_TRANSACTION_LIMIT = 'guest_transaction_limit'¶
- IDEMPOTENCY_ERROR = 'idempotency_error'¶
- INTERNAL_SERVER_ERROR = 'internal_server_error'¶
- INVALID_REQUEST = 'invalid_request'¶
- INVALID_SIGNATURE = 'invalid_signature'¶
- INVALID_SQL_QUERY = 'invalid_sql_query'¶
- MALFORMED_TRANSACTION = 'malformed_transaction'¶
- NETWORK_NOT_TRADABLE = 'network_not_tradable'¶
- NOT_FOUND = 'not_found'¶
- PAYMENT_METHOD_REQUIRED = 'payment_method_required'¶
- PHONE_NUMBER_VERIFICATION_EXPIRED = 'phone_number_verification_expired'¶
- POLICY_IN_USE = 'policy_in_use'¶
- POLICY_VIOLATION = 'policy_violation'¶
- RATE_LIMIT_EXCEEDED = 'rate_limit_exceeded'¶
- RECIPIENT_ALLOWLIST_PENDING = 'recipient_allowlist_pending'¶
- RECIPIENT_ALLOWLIST_VIOLATION = 'recipient_allowlist_violation'¶
- REQUEST_CANCELED = 'request_canceled'¶
- SERVICE_UNAVAILABLE = 'service_unavailable'¶
- TIMED_OUT = 'timed_out'¶
- TRAVEL_RULES_RECIPIENT_VIOLATION = 'travel_rules_recipient_violation'¶
- UNAUTHORIZED = 'unauthorized'¶
- classmethod from_json(json_str)¶
Create an instance of ErrorType from a JSON string
- Return type:
Self
cdp.openapi_client.models.eth_value_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.eth_value_criterion.EthValueCriterion(**data)¶
Bases:
BaseModelA schema for specifying a criterion for the value field of an EVM transaction.
- eth_value: Annotated[str, Field(strict=True)]¶
- classmethod eth_value_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of EthValueCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EthValueCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.evm_account module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_account.EvmAccount(**data)¶
Bases:
BaseModel- address: Annotated[str, Field(strict=True)]¶
- classmethod address_validate_regular_expression(value)¶
Validates the regular expression
- created_at: Optional[datetime]¶
- classmethod from_dict(obj)¶
Create an instance of EvmAccount from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmAccount from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- policies: Optional[List[Annotated[str, Field(strict=True)]]]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- updated_at: Optional[datetime]¶
cdp.openapi_client.models.evm_address_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_address_criterion.EvmAddressCriterion(**data)¶
Bases:
BaseModelA schema for specifying a criterion for the to field of an EVM transaction.
- addresses: List[Annotated[str, Field(strict=True)]]¶
- classmethod from_dict(obj)¶
Create an instance of EvmAddressCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmAddressCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.evm_call module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_call.EvmCall(**data)¶
Bases:
BaseModel- data: Annotated[str, Field(strict=True)]¶
- classmethod data_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of EvmCall from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmCall from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to: Annotated[str, Field(strict=True)]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- classmethod to_validate_regular_expression(value)¶
Validates the regular expression
- value: StrictStr¶
cdp.openapi_client.models.evm_data_condition module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_data_condition.EvmDataCondition(**data)¶
Bases:
BaseModelA single condition to apply against the function and encoded arguments in the transaction’s data field. Each parameter configuration must be successfully evaluated against the corresponding function argument in order for a policy to be accepted.
- classmethod from_dict(obj)¶
Create an instance of EvmDataCondition from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmDataCondition from a JSON string
- Return type:
Optional[Self]
- function: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- params: Optional[List[EvmDataConditionParamsInner]]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.evm_data_condition_params_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_data_condition_params_inner.EvmDataConditionParamsInner(*args, **kwargs)¶
Bases:
BaseModelA list of parameter conditions to apply against encoded arguments in the transaction’s data field.
- actual_instance: Optional[Union[EvmDataParameterCondition, EvmDataParameterConditionList]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[EvmDataParameterCondition]¶
- oneof_schema_2_validator: Optional[EvmDataParameterConditionList]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],EvmDataParameterCondition,EvmDataParameterConditionList,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.evm_data_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_data_criterion.EvmDataCriterion(**data)¶
Bases:
BaseModelA schema for specifying a criterion for the data field of an EVM transaction.
- abi: EvmDataCriterionAbi¶
- conditions: List[EvmDataCondition]¶
- classmethod from_dict(obj)¶
Create an instance of EvmDataCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmDataCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.evm_data_criterion_abi module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_data_criterion_abi.EvmDataCriterionAbi(*args, **kwargs)¶
Bases:
BaseModelThe ABI of the smart contract being called. This can be a partial structure with only specific functions.
- actual_instance: Optional[Union[KnownAbiType, List[AbiInner]]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[KnownAbiType]¶
- oneof_schema_2_validator: Optional[List[AbiInner]]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],KnownAbiType,List[AbiInner],None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.evm_data_parameter_condition module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_data_parameter_condition.EvmDataParameterCondition(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of EvmDataParameterCondition from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmDataParameterCondition from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: StrictStr¶
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- value: StrictStr¶
cdp.openapi_client.models.evm_data_parameter_condition_list module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_data_parameter_condition_list.EvmDataParameterConditionList(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of EvmDataParameterConditionList from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmDataParameterConditionList from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: StrictStr¶
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- values: List[StrictStr]¶
cdp.openapi_client.models.evm_message_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_message_criterion.EvmMessageCriterion(**data)¶
Bases:
BaseModelA schema for specifying a criterion for the message being signed.
- classmethod from_dict(obj)¶
Create an instance of EvmMessageCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmMessageCriterion from a JSON string
- Return type:
Optional[Self]
- match: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.evm_network_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_network_criterion.EvmNetworkCriterion(**data)¶
Bases:
BaseModelA schema for specifying a criterion for the intended network of an EVM transaction.
- classmethod from_dict(obj)¶
Create an instance of EvmNetworkCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmNetworkCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- networks: List[StrictStr]¶
- classmethod networks_validate_enum(value)¶
Validates the enum
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.evm_smart_account module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_smart_account.EvmSmartAccount(**data)¶
Bases:
BaseModel- address: Annotated[str, Field(strict=True)]¶
- classmethod address_validate_regular_expression(value)¶
Validates the regular expression
- created_at: Optional[datetime]¶
- classmethod from_dict(obj)¶
Create an instance of EvmSmartAccount from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmSmartAccount from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- owners: List[Annotated[str, Field(strict=True)]]¶
- policies: Optional[List[Annotated[str, Field(strict=True)]]]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- updated_at: Optional[datetime]¶
cdp.openapi_client.models.evm_swaps_network module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_swaps_network.EvmSwapsNetwork(value)¶
Bases:
str,EnumThe network on which to perform the swap.
- ARBITRUM = 'arbitrum'¶
- BASE = 'base'¶
- ETHEREUM = 'ethereum'¶
- OPTIMISM = 'optimism'¶
- classmethod from_json(json_str)¶
Create an instance of EvmSwapsNetwork from a JSON string
- Return type:
Self
cdp.openapi_client.models.evm_typed_address_condition module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_typed_address_condition.EvmTypedAddressCondition(**data)¶
Bases:
BaseModelA schema for specifying criterion for an address field of an EVM typed message. The address can be deeply nested within the typed data’s message.
- addresses: List[Annotated[str, Field(strict=True)]]¶
- classmethod from_dict(obj)¶
Create an instance of EvmTypedAddressCondition from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmTypedAddressCondition from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- path: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.evm_typed_numerical_condition module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_typed_numerical_condition.EvmTypedNumericalCondition(**data)¶
Bases:
BaseModelA schema for specifying criterion for a numerical field of an EVM typed message. The value can be deeply nested within the typed data’s message.
- classmethod from_dict(obj)¶
Create an instance of EvmTypedNumericalCondition from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmTypedNumericalCondition from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- path: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- value: Annotated[str, Field(strict=True)]¶
- classmethod value_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.evm_typed_string_condition module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_typed_string_condition.EvmTypedStringCondition(**data)¶
Bases:
BaseModelA schema for specifying criterion for a string field of an EVM typed message. The value can be deeply nested within the typed data’s message.
- classmethod from_dict(obj)¶
Create an instance of EvmTypedStringCondition from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmTypedStringCondition from a JSON string
- Return type:
Optional[Self]
- match: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- path: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.evm_user_operation module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_user_operation.EvmUserOperation(**data)¶
Bases:
BaseModel- calls: List[EvmCall]¶
- classmethod from_dict(obj)¶
Create an instance of EvmUserOperation from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of EvmUserOperation from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: EvmUserOperationNetwork¶
- receipts: Optional[List[UserOperationReceipt]]¶
- status: StrictStr¶
- classmethod status_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction_hash: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod transaction_hash_validate_regular_expression(value)¶
Validates the regular expression
- user_op_hash: Annotated[str, Field(strict=True)]¶
- classmethod user_op_hash_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.evm_user_operation_network module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.evm_user_operation_network.EvmUserOperationNetwork(value)¶
Bases:
str,EnumThe network the user operation is for.
- ARBITRUM = 'arbitrum'¶
- AVALANCHE = 'avalanche'¶
- BASE = 'base'¶
- BASE_MINUS_SEPOLIA = 'base-sepolia'¶
- BNB = 'bnb'¶
- ETHEREUM = 'ethereum'¶
- ETHEREUM_MINUS_SEPOLIA = 'ethereum-sepolia'¶
- OPTIMISM = 'optimism'¶
- POLYGON = 'polygon'¶
- ZORA = 'zora'¶
- classmethod from_json(json_str)¶
Create an instance of EvmUserOperationNetwork from a JSON string
- Return type:
Self
cdp.openapi_client.models.export_evm_account200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.export_evm_account200_response.ExportEvmAccount200Response(**data)¶
Bases:
BaseModel- encrypted_private_key: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of ExportEvmAccount200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ExportEvmAccount200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.export_evm_account_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.export_evm_account_request.ExportEvmAccountRequest(**data)¶
Bases:
BaseModel- export_encryption_key: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of ExportEvmAccountRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ExportEvmAccountRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.export_solana_account200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.export_solana_account200_response.ExportSolanaAccount200Response(**data)¶
Bases:
BaseModel- encrypted_private_key: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of ExportSolanaAccount200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ExportSolanaAccount200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.fee module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.fee.Fee(**data)¶
Bases:
BaseModelThe fee for the transfer.
- amount: StrictStr¶
- currency: StrictStr¶
- description: Optional[StrictStr]¶
- classmethod from_dict(obj)¶
Create an instance of Fee from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of Fee from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.get_onramp_order_by_id200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.get_onramp_order_by_id200_response.GetOnrampOrderById200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of GetOnrampOrderById200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of GetOnrampOrderById200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- order: OnrampOrder¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.get_swap_price_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.get_swap_price_response.GetSwapPriceResponse(**data)¶
Bases:
BaseModel- block_number: Annotated[str, Field(strict=True)]¶
- classmethod block_number_validate_regular_expression(value)¶
Validates the regular expression
- fees: CommonSwapResponseFees¶
- from_amount: Annotated[str, Field(strict=True)]¶
- classmethod from_amount_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of GetSwapPriceResponse from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of GetSwapPriceResponse from a JSON string
- Return type:
Optional[Self]
- from_token: Annotated[str, Field(strict=True)]¶
- classmethod from_token_validate_regular_expression(value)¶
Validates the regular expression
- gas: Optional[Annotated[str, Field(strict=True)]]¶
- gas_price: Annotated[str, Field(strict=True)]¶
- classmethod gas_price_validate_regular_expression(value)¶
Validates the regular expression
- classmethod gas_validate_regular_expression(value)¶
Validates the regular expression
- issues: CommonSwapResponseIssues¶
- liquidity_available: StrictBool¶
- min_to_amount: Annotated[str, Field(strict=True)]¶
- classmethod min_to_amount_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_amount: Annotated[str, Field(strict=True)]¶
- classmethod to_amount_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_token: Annotated[str, Field(strict=True)]¶
- classmethod to_token_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.get_swap_price_response_wrapper module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.get_swap_price_response_wrapper.GetSwapPriceResponseWrapper(*args, **kwargs)¶
Bases:
BaseModelA wrapper for the response of a swap price operation.
- actual_instance: Optional[Union[GetSwapPriceResponse, SwapUnavailableResponse]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[GetSwapPriceResponse]¶
- oneof_schema_2_validator: Optional[SwapUnavailableResponse]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],GetSwapPriceResponse,SwapUnavailableResponse,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.idl module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.idl.Idl(**data)¶
Bases:
BaseModelIDL Specification following Anchor’s IDL format v0.30+.
- address: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of Idl from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of Idl from a JSON string
- Return type:
Optional[Self]
- instructions: List[IdlInstructionsInner]¶
- metadata: Optional[IdlMetadata]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- types: Optional[List[Dict[str, Any]]]¶
cdp.openapi_client.models.idl_instructions_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.idl_instructions_inner.IdlInstructionsInner(**data)¶
Bases:
BaseModel- accounts: Optional[List[IdlInstructionsInnerAccountsInner]]¶
- args: List[IdlInstructionsInnerArgsInner]¶
- discriminator: Annotated[List[Annotated[int, Field(le=255, strict=True, ge=0)]], Field(min_length=8, max_length=8)]¶
- classmethod from_dict(obj)¶
Create an instance of IdlInstructionsInner from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of IdlInstructionsInner from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.idl_instructions_inner_accounts_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.idl_instructions_inner_accounts_inner.IdlInstructionsInnerAccountsInner(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of IdlInstructionsInnerAccountsInner from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of IdlInstructionsInnerAccountsInner from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: StrictStr¶
- signer: Optional[StrictBool]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- writable: Optional[StrictBool]¶
cdp.openapi_client.models.idl_instructions_inner_args_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.idl_instructions_inner_args_inner.IdlInstructionsInnerArgsInner(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of IdlInstructionsInnerArgsInner from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of IdlInstructionsInnerArgsInner from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
cdp.openapi_client.models.idl_metadata module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.idl_metadata.IdlMetadata(**data)¶
Bases:
BaseModelOptional metadata about the IDL.
- classmethod from_dict(obj)¶
Create an instance of IdlMetadata from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of IdlMetadata from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[StrictStr]¶
- spec: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- version: Optional[StrictStr]¶
cdp.openapi_client.models.import_evm_account_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.import_evm_account_request.ImportEvmAccountRequest(**data)¶
Bases:
BaseModel- account_policy: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod account_policy_validate_regular_expression(value)¶
Validates the regular expression
- encrypted_private_key: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of ImportEvmAccountRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ImportEvmAccountRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.import_solana_account_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.import_solana_account_request.ImportSolanaAccountRequest(**data)¶
Bases:
BaseModel- encrypted_private_key: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of ImportSolanaAccountRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ImportSolanaAccountRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.known_abi_type module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.known_abi_type.KnownAbiType(value)¶
Bases:
str,EnumA reference to an established EIP standard. When referencing a KnownAbiType within a policy rule configuring an EvmDataCriterion, criteria will only decode function data officially documented in the standard. For more information on supported token standards, see the links below. - [erc20 - Token Standard](https://eips.ethereum.org/EIPS/eip-20). - [erc721 - Non-Fungible Token Standard](https://eips.ethereum.org/EIPS/eip-721). - [erc1155 - Multi Token Standard](https://eips.ethereum.org/EIPS/eip-1155).
- ERC1155 = 'erc1155'¶
- ERC20 = 'erc20'¶
- ERC721 = 'erc721'¶
- classmethod from_json(json_str)¶
Create an instance of KnownAbiType from a JSON string
- Return type:
Self
cdp.openapi_client.models.known_idl_type module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.known_idl_type.KnownIdlType(value)¶
Bases:
str,EnumA reference to an established Solana program. When referencing a KnownIdlType within a policy rule configuring an SolDataCriterion, criteria will decode instruction data as documented in the programs. For more information on supported programs, see the links below. - [SystemProgram](https://docs.rs/solana-program/latest/solana_program/system_instruction/enum.SystemInstruction.html). - [TokenProgram](https://docs.rs/spl-token/latest/spl_token/instruction/enum.TokenInstruction.html). - [AssociatedTokenProgram](https://docs.rs/spl-associated-token-account/latest/spl_associated_token_account/instruction/index.html).
- ASSOCIATEDTOKENPROGRAM = 'AssociatedTokenProgram'¶
- SYSTEMPROGRAM = 'SystemProgram'¶
- TOKENPROGRAM = 'TokenProgram'¶
- classmethod from_json(json_str)¶
Create an instance of KnownIdlType from a JSON string
- Return type:
Self
cdp.openapi_client.models.list_evm_accounts200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_evm_accounts200_response.ListEvmAccounts200Response(**data)¶
Bases:
BaseModel- accounts: List[EvmAccount]¶
- classmethod from_dict(obj)¶
Create an instance of ListEvmAccounts200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ListEvmAccounts200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- next_page_token: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.list_evm_smart_accounts200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_evm_smart_accounts200_response.ListEvmSmartAccounts200Response(**data)¶
Bases:
BaseModel- accounts: List[EvmSmartAccount]¶
- classmethod from_dict(obj)¶
Create an instance of ListEvmSmartAccounts200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ListEvmSmartAccounts200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- next_page_token: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.list_evm_token_balances200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_evm_token_balances200_response.ListEvmTokenBalances200Response(**data)¶
Bases:
BaseModel- balances: List[TokenBalance]¶
- classmethod from_dict(obj)¶
Create an instance of ListEvmTokenBalances200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ListEvmTokenBalances200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- next_page_token: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.list_evm_token_balances_network module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_evm_token_balances_network.ListEvmTokenBalancesNetwork(value)¶
Bases:
str,EnumThe name of the supported EVM networks in human-readable format.
- BASE = 'base'¶
- BASE_MINUS_SEPOLIA = 'base-sepolia'¶
- ETHEREUM = 'ethereum'¶
- classmethod from_json(json_str)¶
Create an instance of ListEvmTokenBalancesNetwork from a JSON string
- Return type:
Self
cdp.openapi_client.models.list_policies200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_policies200_response.ListPolicies200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of ListPolicies200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ListPolicies200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- next_page_token: Optional[StrictStr]¶
- policies: List[Policy]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.list_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_response.ListResponse(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of ListResponse from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ListResponse from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- next_page_token: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.list_solana_accounts200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_solana_accounts200_response.ListSolanaAccounts200Response(**data)¶
Bases:
BaseModel- accounts: List[SolanaAccount]¶
- classmethod from_dict(obj)¶
Create an instance of ListSolanaAccounts200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ListSolanaAccounts200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- next_page_token: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.list_solana_token_balances200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_solana_token_balances200_response.ListSolanaTokenBalances200Response(**data)¶
Bases:
BaseModel- balances: List[SolanaTokenBalance]¶
- classmethod from_dict(obj)¶
Create an instance of ListSolanaTokenBalances200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ListSolanaTokenBalances200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- next_page_token: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.list_solana_token_balances_network module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_solana_token_balances_network.ListSolanaTokenBalancesNetwork(value)¶
Bases:
str,EnumThe name of the supported Solana networks in human-readable format.
- SOLANA = 'solana'¶
- SOLANA_MINUS_DEVNET = 'solana-devnet'¶
- classmethod from_json(json_str)¶
Create an instance of ListSolanaTokenBalancesNetwork from a JSON string
- Return type:
Self
cdp.openapi_client.models.list_spend_permissions200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.list_spend_permissions200_response.ListSpendPermissions200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of ListSpendPermissions200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ListSpendPermissions200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- next_page_token: Optional[StrictStr]¶
- spend_permissions: List[SpendPermissionResponseObject]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.mint_address_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.mint_address_criterion.MintAddressCriterion(**data)¶
Bases:
BaseModelThe criterion for the token mint addresses of a Solana transaction’s SPL token transfer instructions.
- addresses: List[Annotated[str, Field(strict=True)]]¶
- classmethod from_dict(obj)¶
Create an instance of MintAddressCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of MintAddressCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.net_usd_change_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.net_usd_change_criterion.NetUSDChangeCriterion(**data)¶
Bases:
BaseModelA schema for specifying a criterion for the USD denominated asset transfer or exposure for a transaction. This includes native transfers, as well as token transfers.
- change_cents: StrictInt¶
- classmethod from_dict(obj)¶
Create an instance of NetUSDChangeCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of NetUSDChangeCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.onchain_data_query module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onchain_data_query.OnchainDataQuery(**data)¶
Bases:
BaseModelRequest to execute a SQL query against indexed blockchain data.
- classmethod from_dict(obj)¶
Create an instance of OnchainDataQuery from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnchainDataQuery from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- sql: Annotated[str, Field(min_length=1, strict=True, max_length=10000)]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.onchain_data_result module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onchain_data_result.OnchainDataResult(**data)¶
Bases:
BaseModelResult of executing a SQL query.
- classmethod from_dict(obj)¶
Create an instance of OnchainDataResult from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnchainDataResult from a JSON string
- Return type:
Optional[Self]
- metadata: Optional[OnchainDataResultMetadata]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- result: Optional[List[Dict[str, Any]]]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- var_schema: Optional[OnchainDataResultSchema]¶
cdp.openapi_client.models.onchain_data_result_metadata module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onchain_data_result_metadata.OnchainDataResultMetadata(**data)¶
Bases:
BaseModelMetadata about query execution.
- cached: Optional[StrictBool]¶
- execution_time_ms: Optional[StrictInt]¶
- classmethod from_dict(obj)¶
Create an instance of OnchainDataResultMetadata from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnchainDataResultMetadata from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- row_count: Optional[StrictInt]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.onchain_data_result_schema module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onchain_data_result_schema.OnchainDataResultSchema(**data)¶
Bases:
BaseModelSchema information for the query result. This is a derived schema from the query result, so types may not match the underlying table.
- columns: Optional[List[OnchainDataResultSchemaColumnsInner]]¶
- classmethod from_dict(obj)¶
Create an instance of OnchainDataResultSchema from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnchainDataResultSchema from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.onchain_data_result_schema_columns_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onchain_data_result_schema_columns_inner.OnchainDataResultSchemaColumnsInner(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of OnchainDataResultSchemaColumnsInner from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnchainDataResultSchemaColumnsInner from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: Optional[StrictStr]¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.onramp_order module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onramp_order.OnrampOrder(**data)¶
Bases:
BaseModelAn Onramp order.
- created_at: StrictStr¶
- destination_address: StrictStr¶
- destination_network: StrictStr¶
- exchange_rate: StrictStr¶
- fees: List[OnrampOrderFee]¶
- classmethod from_dict(obj)¶
Create an instance of OnrampOrder from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnrampOrder from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- order_id: StrictStr¶
- payment_currency: StrictStr¶
- payment_method: OnrampOrderPaymentMethodTypeId¶
- payment_subtotal: StrictStr¶
- payment_total: StrictStr¶
- purchase_amount: StrictStr¶
- purchase_currency: StrictStr¶
- status: OnrampOrderStatus¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- tx_hash: Optional[StrictStr]¶
- updated_at: StrictStr¶
cdp.openapi_client.models.onramp_order_fee module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onramp_order_fee.OnrampOrderFee(**data)¶
Bases:
BaseModelA fee associated with an order.
- amount: StrictStr¶
- currency: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of OnrampOrderFee from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnrampOrderFee from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.onramp_order_payment_method_type_id module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onramp_order_payment_method_type_id.OnrampOrderPaymentMethodTypeId(value)¶
Bases:
str,EnumThe type of payment method to be used to complete an onramp order.
- GUEST_CHECKOUT_APPLE_PAY = 'GUEST_CHECKOUT_APPLE_PAY'¶
- classmethod from_json(json_str)¶
Create an instance of OnrampOrderPaymentMethodTypeId from a JSON string
- Return type:
Self
cdp.openapi_client.models.onramp_order_status module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onramp_order_status.OnrampOrderStatus(value)¶
Bases:
str,EnumThe status of an onramp order.
- ONRAMP_ORDER_STATUS_COMPLETED = 'ONRAMP_ORDER_STATUS_COMPLETED'¶
- ONRAMP_ORDER_STATUS_FAILED = 'ONRAMP_ORDER_STATUS_FAILED'¶
- ONRAMP_ORDER_STATUS_PENDING_AUTH = 'ONRAMP_ORDER_STATUS_PENDING_AUTH'¶
- ONRAMP_ORDER_STATUS_PENDING_PAYMENT = 'ONRAMP_ORDER_STATUS_PENDING_PAYMENT'¶
- ONRAMP_ORDER_STATUS_PROCESSING = 'ONRAMP_ORDER_STATUS_PROCESSING'¶
- classmethod from_json(json_str)¶
Create an instance of OnrampOrderStatus from a JSON string
- Return type:
Self
cdp.openapi_client.models.onramp_payment_link module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onramp_payment_link.OnrampPaymentLink(**data)¶
Bases:
BaseModelA payment link to pay for an order. Please refer to the [Onramp docs](https://docs.cdp.coinbase.com/onramp-&-offramp/onramp-apis/onramp-overview) for details on how to integrate with the different payment link types.
- classmethod from_dict(obj)¶
Create an instance of OnrampPaymentLink from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnrampPaymentLink from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- payment_link_type: OnrampPaymentLinkType¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- url: StrictStr¶
cdp.openapi_client.models.onramp_payment_link_type module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onramp_payment_link_type.OnrampPaymentLinkType(value)¶
Bases:
str,EnumThe type of payment link.
- PAYMENT_LINK_TYPE_APPLE_PAY_BUTTON = 'PAYMENT_LINK_TYPE_APPLE_PAY_BUTTON'¶
- classmethod from_json(json_str)¶
Create an instance of OnrampPaymentLinkType from a JSON string
- Return type:
Self
cdp.openapi_client.models.onramp_quote module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onramp_quote.OnrampQuote(**data)¶
Bases:
BaseModelQuote information with pricing details for the crypto purchase.
- destination_network: StrictStr¶
- exchange_rate: StrictStr¶
- fees: List[OnrampOrderFee]¶
- classmethod from_dict(obj)¶
Create an instance of OnrampQuote from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnrampQuote from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- payment_currency: StrictStr¶
- payment_subtotal: StrictStr¶
- payment_total: StrictStr¶
- purchase_amount: StrictStr¶
- purchase_currency: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.onramp_quote_payment_method_type_id module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onramp_quote_payment_method_type_id.OnrampQuotePaymentMethodTypeId(value)¶
Bases:
str,EnumThe type of payment method used to generate the onramp quote.
- ACH = 'ACH'¶
- APPLE_PAY = 'APPLE_PAY'¶
- CARD = 'CARD'¶
- CRYPTO_WALLET = 'CRYPTO_WALLET'¶
- FIAT_WALLET = 'FIAT_WALLET'¶
- PAYPAL = 'PAYPAL'¶
- classmethod from_json(json_str)¶
Create an instance of OnrampQuotePaymentMethodTypeId from a JSON string
- Return type:
Self
cdp.openapi_client.models.onramp_session module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.onramp_session.OnrampSession(**data)¶
Bases:
BaseModelAn onramp session containing a ready-to-use onramp URL.
- classmethod from_dict(obj)¶
Create an instance of OnrampSession from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of OnrampSession from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- onramp_url: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.payment_method module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.payment_method.PaymentMethod(**data)¶
Bases:
BaseModelThe fiat payment method object.
- actions: List[PaymentRailAction]¶
- currency: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of PaymentMethod from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of PaymentMethod from a JSON string
- Return type:
Optional[Self]
- id: Annotated[str, Field(strict=True)]¶
- classmethod id_validate_regular_expression(value)¶
Validates the regular expression
- limits: Optional[PaymentMethodLimits]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.payment_method_limits module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.payment_method_limits.PaymentMethodLimits(**data)¶
Bases:
BaseModelThe limits of the payment method.
- classmethod from_dict(obj)¶
Create an instance of PaymentMethodLimits from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of PaymentMethodLimits from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- source_limit: Optional[PaymentMethodLimitsSourceLimit]¶
- target_limit: Optional[PaymentMethodLimitsTargetLimit]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.payment_method_limits_source_limit module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.payment_method_limits_source_limit.PaymentMethodLimitsSourceLimit(**data)¶
Bases:
BaseModelThe limit for this payment method being used as a source for transfers.
- amount: Optional[StrictStr]¶
- currency: Optional[StrictStr]¶
- classmethod from_dict(obj)¶
Create an instance of PaymentMethodLimitsSourceLimit from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of PaymentMethodLimitsSourceLimit from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.payment_method_limits_target_limit module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.payment_method_limits_target_limit.PaymentMethodLimitsTargetLimit(**data)¶
Bases:
BaseModelThe limit for this payment method being used as a target for transfers.
- amount: Optional[StrictStr]¶
- currency: Optional[StrictStr]¶
- classmethod from_dict(obj)¶
Create an instance of PaymentMethodLimitsTargetLimit from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of PaymentMethodLimitsTargetLimit from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.payment_method_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.payment_method_request.PaymentMethodRequest(**data)¶
Bases:
BaseModelThe fiat payment method request object.
- classmethod from_dict(obj)¶
Create an instance of PaymentMethodRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of PaymentMethodRequest from a JSON string
- Return type:
Optional[Self]
- id: Annotated[str, Field(strict=True)]¶
- classmethod id_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.payment_rail_action module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
cdp.openapi_client.models.policy module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.policy.Policy(**data)¶
Bases:
BaseModel- created_at: StrictStr¶
- description: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod description_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of Policy from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of Policy from a JSON string
- Return type:
Optional[Self]
- id: Annotated[str, Field(strict=True)]¶
- classmethod id_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- rules: List[Rule]¶
- scope: StrictStr¶
- classmethod scope_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- updated_at: StrictStr¶
cdp.openapi_client.models.prepare_user_operation_criteria_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.prepare_user_operation_criteria_inner.PrepareUserOperationCriteriaInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[EthValueCriterion, EvmAddressCriterion, EvmDataCriterion, EvmNetworkCriterion]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[EthValueCriterion]¶
- oneof_schema_2_validator: Optional[EvmAddressCriterion]¶
- oneof_schema_3_validator: Optional[EvmNetworkCriterion]¶
- oneof_schema_4_validator: Optional[EvmDataCriterion]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],EthValueCriterion,EvmAddressCriterion,EvmDataCriterion,EvmNetworkCriterion,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.prepare_user_operation_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.prepare_user_operation_request.PrepareUserOperationRequest(**data)¶
Bases:
BaseModel- calls: List[EvmCall]¶
- classmethod from_dict(obj)¶
Create an instance of PrepareUserOperationRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of PrepareUserOperationRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: EvmUserOperationNetwork¶
- paymaster_url: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.prepare_user_operation_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.prepare_user_operation_rule.PrepareUserOperationRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- criteria: List[PrepareUserOperationCriteriaInner]¶
- classmethod from_dict(obj)¶
Create an instance of PrepareUserOperationRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of PrepareUserOperationRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.program_id_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.program_id_criterion.ProgramIdCriterion(**data)¶
Bases:
BaseModelThe criterion for the program IDs of a Solana transaction’s instructions.
- classmethod from_dict(obj)¶
Create an instance of ProgramIdCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ProgramIdCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- program_ids: List[Annotated[str, Field(strict=True)]]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.request_evm_faucet200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.request_evm_faucet200_response.RequestEvmFaucet200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of RequestEvmFaucet200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of RequestEvmFaucet200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction_hash: StrictStr¶
cdp.openapi_client.models.request_evm_faucet_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.request_evm_faucet_request.RequestEvmFaucetRequest(**data)¶
Bases:
BaseModel- address: Annotated[str, Field(strict=True)]¶
- classmethod address_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of RequestEvmFaucetRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of RequestEvmFaucetRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: StrictStr¶
- classmethod network_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- token: StrictStr¶
- classmethod token_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.request_solana_faucet200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.request_solana_faucet200_response.RequestSolanaFaucet200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of RequestSolanaFaucet200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of RequestSolanaFaucet200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction_signature: StrictStr¶
cdp.openapi_client.models.request_solana_faucet_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.request_solana_faucet_request.RequestSolanaFaucetRequest(**data)¶
Bases:
BaseModel- address: Annotated[str, Field(strict=True)]¶
- classmethod address_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of RequestSolanaFaucetRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of RequestSolanaFaucetRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- token: StrictStr¶
- classmethod token_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.revoke_spend_permission_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.revoke_spend_permission_request.RevokeSpendPermissionRequest(**data)¶
Bases:
BaseModelRequest parameters for revoking a Spend Permission.
- classmethod from_dict(obj)¶
Create an instance of RevokeSpendPermissionRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of RevokeSpendPermissionRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: SpendPermissionNetwork¶
- paymaster_url: Optional[StrictStr]¶
- permission_hash: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.rule.Rule(*args, **kwargs)¶
Bases:
BaseModelA rule that limits the behavior of an account.
- actual_instance: Optional[Union[PrepareUserOperationRule, SendEvmTransactionRule, SendSolTransactionRule, SendUserOperationRule, SignEvmHashRule, SignEvmMessageRule, SignEvmTransactionRule, SignEvmTypedDataRule, SignSolMessageRule, SignSolTransactionRule]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_10_validator: Optional[SendUserOperationRule]¶
- oneof_schema_1_validator: Optional[SignEvmTransactionRule]¶
- oneof_schema_2_validator: Optional[SendEvmTransactionRule]¶
- oneof_schema_3_validator: Optional[SignEvmMessageRule]¶
- oneof_schema_4_validator: Optional[SignEvmTypedDataRule]¶
- oneof_schema_5_validator: Optional[SignSolTransactionRule]¶
- oneof_schema_6_validator: Optional[SendSolTransactionRule]¶
- oneof_schema_7_validator: Optional[SignSolMessageRule]¶
- oneof_schema_8_validator: Optional[SignEvmHashRule]¶
- oneof_schema_9_validator: Optional[PrepareUserOperationRule]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],PrepareUserOperationRule,SendEvmTransactionRule,SendSolTransactionRule,SendUserOperationRule,SignEvmHashRule,SignEvmMessageRule,SignEvmTransactionRule,SignEvmTypedDataRule,SignSolMessageRule,SignSolTransactionRule,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.send_evm_transaction200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_evm_transaction200_response.SendEvmTransaction200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SendEvmTransaction200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SendEvmTransaction200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction_hash: StrictStr¶
cdp.openapi_client.models.send_evm_transaction_criteria_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_evm_transaction_criteria_inner.SendEvmTransactionCriteriaInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[EthValueCriterion, EvmAddressCriterion, EvmDataCriterion, EvmNetworkCriterion, NetUSDChangeCriterion]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[EthValueCriterion]¶
- oneof_schema_2_validator: Optional[EvmAddressCriterion]¶
- oneof_schema_3_validator: Optional[EvmNetworkCriterion]¶
- oneof_schema_4_validator: Optional[EvmDataCriterion]¶
- oneof_schema_5_validator: Optional[NetUSDChangeCriterion]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],EthValueCriterion,EvmAddressCriterion,EvmDataCriterion,EvmNetworkCriterion,NetUSDChangeCriterion,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.send_evm_transaction_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_evm_transaction_request.SendEvmTransactionRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SendEvmTransactionRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SendEvmTransactionRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: StrictStr¶
- classmethod network_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction: StrictStr¶
cdp.openapi_client.models.send_evm_transaction_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_evm_transaction_rule.SendEvmTransactionRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- criteria: List[SendEvmTransactionCriteriaInner]¶
- classmethod from_dict(obj)¶
Create an instance of SendEvmTransactionRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SendEvmTransactionRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.send_sol_transaction_criteria_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_sol_transaction_criteria_inner.SendSolTransactionCriteriaInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[MintAddressCriterion, ProgramIdCriterion, SolAddressCriterion, SolDataCriterion, SolNetworkCriterion, SolValueCriterion, SplAddressCriterion, SplValueCriterion]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[SolAddressCriterion]¶
- oneof_schema_2_validator: Optional[SolValueCriterion]¶
- oneof_schema_3_validator: Optional[SplAddressCriterion]¶
- oneof_schema_4_validator: Optional[SplValueCriterion]¶
- oneof_schema_5_validator: Optional[MintAddressCriterion]¶
- oneof_schema_6_validator: Optional[SolDataCriterion]¶
- oneof_schema_7_validator: Optional[ProgramIdCriterion]¶
- oneof_schema_8_validator: Optional[SolNetworkCriterion]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],MintAddressCriterion,ProgramIdCriterion,SolAddressCriterion,SolDataCriterion,SolNetworkCriterion,SolValueCriterion,SplAddressCriterion,SplValueCriterion,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.send_sol_transaction_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_sol_transaction_rule.SendSolTransactionRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- criteria: List[SendSolTransactionCriteriaInner]¶
- classmethod from_dict(obj)¶
Create an instance of SendSolTransactionRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SendSolTransactionRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.send_solana_transaction200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_solana_transaction200_response.SendSolanaTransaction200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SendSolanaTransaction200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SendSolanaTransaction200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction_signature: StrictStr¶
cdp.openapi_client.models.send_solana_transaction_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_solana_transaction_request.SendSolanaTransactionRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SendSolanaTransactionRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SendSolanaTransactionRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: StrictStr¶
- classmethod network_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction: StrictStr¶
cdp.openapi_client.models.send_user_operation_criteria_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_user_operation_criteria_inner.SendUserOperationCriteriaInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[EthValueCriterion, EvmAddressCriterion, EvmDataCriterion]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[EthValueCriterion]¶
- oneof_schema_2_validator: Optional[EvmAddressCriterion]¶
- oneof_schema_3_validator: Optional[EvmDataCriterion]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],EthValueCriterion,EvmAddressCriterion,EvmDataCriterion,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.send_user_operation_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_user_operation_request.SendUserOperationRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SendUserOperationRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SendUserOperationRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- signature: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.send_user_operation_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.send_user_operation_rule.SendUserOperationRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- criteria: List[SendUserOperationCriteriaInner]¶
- classmethod from_dict(obj)¶
Create an instance of SendUserOperationRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SendUserOperationRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.settle_x402_payment200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.settle_x402_payment200_response.SettleX402Payment200Response(**data)¶
Bases:
BaseModel- error_reason: Optional[X402SettleErrorReason]¶
- classmethod from_dict(obj)¶
Create an instance of SettleX402Payment200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SettleX402Payment200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: StrictStr¶
- payer: Annotated[str, Field(strict=True)]¶
- classmethod payer_validate_regular_expression(value)¶
Validates the regular expression
- success: StrictBool¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction: Annotated[str, Field(strict=True)]¶
- classmethod transaction_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.sign_evm_hash200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_hash200_response.SignEvmHash200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignEvmHash200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmHash200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- signature: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_hash_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_hash_request.SignEvmHashRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignEvmHashRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmHashRequest from a JSON string
- Return type:
Optional[Self]
- hash: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_hash_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_hash_rule.SignEvmHashRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- classmethod from_dict(obj)¶
Create an instance of SignEvmHashRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmHashRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_message200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_message200_response.SignEvmMessage200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignEvmMessage200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmMessage200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- signature: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_message_criteria_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_message_criteria_inner.SignEvmMessageCriteriaInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[EvmMessageCriterion]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[EvmMessageCriterion]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],EvmMessageCriterion,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.sign_evm_message_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_message_request.SignEvmMessageRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignEvmMessageRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmMessageRequest from a JSON string
- Return type:
Optional[Self]
- message: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_message_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_message_rule.SignEvmMessageRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- criteria: List[SignEvmMessageCriteriaInner]¶
- classmethod from_dict(obj)¶
Create an instance of SignEvmMessageRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmMessageRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_transaction200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_transaction200_response.SignEvmTransaction200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignEvmTransaction200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmTransaction200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- signed_transaction: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_transaction_criteria_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_transaction_criteria_inner.SignEvmTransactionCriteriaInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[EthValueCriterion, EvmAddressCriterion, EvmDataCriterion, NetUSDChangeCriterion]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[EthValueCriterion]¶
- oneof_schema_2_validator: Optional[EvmAddressCriterion]¶
- oneof_schema_3_validator: Optional[EvmDataCriterion]¶
- oneof_schema_4_validator: Optional[NetUSDChangeCriterion]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],EthValueCriterion,EvmAddressCriterion,EvmDataCriterion,NetUSDChangeCriterion,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.sign_evm_transaction_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_transaction_request.SignEvmTransactionRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignEvmTransactionRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmTransactionRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction: StrictStr¶
cdp.openapi_client.models.sign_evm_transaction_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_transaction_rule.SignEvmTransactionRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- criteria: List[SignEvmTransactionCriteriaInner]¶
- classmethod from_dict(obj)¶
Create an instance of SignEvmTransactionRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmTransactionRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_typed_data200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_typed_data200_response.SignEvmTypedData200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignEvmTypedData200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmTypedData200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- signature: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_typed_data_criteria_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_typed_data_criteria_inner.SignEvmTypedDataCriteriaInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[SignEvmTypedDataFieldCriterion, SignEvmTypedDataVerifyingContractCriterion]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[SignEvmTypedDataFieldCriterion]¶
- oneof_schema_2_validator: Optional[SignEvmTypedDataVerifyingContractCriterion]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],SignEvmTypedDataFieldCriterion,SignEvmTypedDataVerifyingContractCriterion,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.sign_evm_typed_data_field_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_typed_data_field_criterion.SignEvmTypedDataFieldCriterion(**data)¶
Bases:
BaseModel- conditions: List[SignEvmTypedDataFieldCriterionConditionsInner]¶
- classmethod from_dict(obj)¶
Create an instance of SignEvmTypedDataFieldCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmTypedDataFieldCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
- types: SignEvmTypedDataFieldCriterionTypes¶
cdp.openapi_client.models.sign_evm_typed_data_field_criterion_conditions_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_typed_data_field_criterion_conditions_inner.SignEvmTypedDataFieldCriterionConditionsInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[EvmTypedAddressCondition, EvmTypedNumericalCondition, EvmTypedStringCondition]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[EvmTypedAddressCondition]¶
- oneof_schema_2_validator: Optional[EvmTypedNumericalCondition]¶
- oneof_schema_3_validator: Optional[EvmTypedStringCondition]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],EvmTypedAddressCondition,EvmTypedNumericalCondition,EvmTypedStringCondition,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.sign_evm_typed_data_field_criterion_types module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_typed_data_field_criterion_types.SignEvmTypedDataFieldCriterionTypes(**data)¶
Bases:
BaseModelAn object containing EIP-712 type definitions, as well as a primary type for the root message object.
- classmethod from_dict(obj)¶
Create an instance of SignEvmTypedDataFieldCriterionTypes from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmTypedDataFieldCriterionTypes from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- primary_type: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- types: Dict[str, List[SignEvmTypedDataFieldCriterionTypesTypesValueInner]]¶
cdp.openapi_client.models.sign_evm_typed_data_field_criterion_types_types_value_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_typed_data_field_criterion_types_types_value_inner.SignEvmTypedDataFieldCriterionTypesTypesValueInner(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignEvmTypedDataFieldCriterionTypesTypesValueInner from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmTypedDataFieldCriterionTypesTypesValueInner from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: Optional[StrictStr]¶
cdp.openapi_client.models.sign_evm_typed_data_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_typed_data_rule.SignEvmTypedDataRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- criteria: List[SignEvmTypedDataCriteriaInner]¶
- classmethod from_dict(obj)¶
Create an instance of SignEvmTypedDataRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmTypedDataRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_evm_typed_data_verifying_contract_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_evm_typed_data_verifying_contract_criterion.SignEvmTypedDataVerifyingContractCriterion(**data)¶
Bases:
BaseModelA schema for specifying criterion for a domain’s verifying contract.
- addresses: List[Annotated[str, Field(strict=True)]]¶
- classmethod from_dict(obj)¶
Create an instance of SignEvmTypedDataVerifyingContractCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignEvmTypedDataVerifyingContractCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.sign_sol_message_criteria_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_sol_message_criteria_inner.SignSolMessageCriteriaInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[SolMessageCriterion]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[SolMessageCriterion]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],SolMessageCriterion,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.sign_sol_message_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_sol_message_rule.SignSolMessageRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- criteria: List[SignSolMessageCriteriaInner]¶
- classmethod from_dict(obj)¶
Create an instance of SignSolMessageRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignSolMessageRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_sol_transaction_criteria_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_sol_transaction_criteria_inner.SignSolTransactionCriteriaInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[MintAddressCriterion, ProgramIdCriterion, SolAddressCriterion, SolDataCriterion, SolValueCriterion, SplAddressCriterion, SplValueCriterion]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[SolAddressCriterion]¶
- oneof_schema_2_validator: Optional[SolValueCriterion]¶
- oneof_schema_3_validator: Optional[SplAddressCriterion]¶
- oneof_schema_4_validator: Optional[SplValueCriterion]¶
- oneof_schema_5_validator: Optional[MintAddressCriterion]¶
- oneof_schema_6_validator: Optional[SolDataCriterion]¶
- oneof_schema_7_validator: Optional[ProgramIdCriterion]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],MintAddressCriterion,ProgramIdCriterion,SolAddressCriterion,SolDataCriterion,SolValueCriterion,SplAddressCriterion,SplValueCriterion,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.sign_sol_transaction_rule module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_sol_transaction_rule.SignSolTransactionRule(**data)¶
Bases:
BaseModel- action: StrictStr¶
- classmethod action_validate_enum(value)¶
Validates the enum
- criteria: List[SignSolTransactionCriteriaInner]¶
- classmethod from_dict(obj)¶
Create an instance of SignSolTransactionRule from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignSolTransactionRule from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operation: StrictStr¶
- classmethod operation_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_solana_message200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_solana_message200_response.SignSolanaMessage200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignSolanaMessage200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignSolanaMessage200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- signature: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_solana_message_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_solana_message_request.SignSolanaMessageRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignSolanaMessageRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignSolanaMessageRequest from a JSON string
- Return type:
Optional[Self]
- message: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_solana_transaction200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_solana_transaction200_response.SignSolanaTransaction200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignSolanaTransaction200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignSolanaTransaction200Response from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- signed_transaction: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sign_solana_transaction_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sign_solana_transaction_request.SignSolanaTransactionRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SignSolanaTransactionRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SignSolanaTransactionRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction: StrictStr¶
cdp.openapi_client.models.sms_authentication module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sms_authentication.SmsAuthentication(**data)¶
Bases:
BaseModelInformation about an end user who authenticates using a one-time password sent to their phone number via SMS.
- classmethod from_dict(obj)¶
Create an instance of SmsAuthentication from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SmsAuthentication from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- phone_number: Annotated[str, Field(strict=True)]¶
- classmethod phone_number_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.sol_address_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_address_criterion.SolAddressCriterion(**data)¶
Bases:
BaseModelThe criterion for the recipient addresses of a Solana transaction’s native transfer instruction.
- addresses: List[Annotated[str, Field(strict=True)]]¶
- classmethod from_dict(obj)¶
Create an instance of SolAddressCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolAddressCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.sol_data_condition module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_data_condition.SolDataCondition(**data)¶
Bases:
BaseModelA single condition to apply against a specific instruction type and its parameters.
- classmethod from_dict(obj)¶
Create an instance of SolDataCondition from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolDataCondition from a JSON string
- Return type:
Optional[Self]
- instruction: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- params: Optional[List[SolDataConditionParamsInner]]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.sol_data_condition_params_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_data_condition_params_inner.SolDataConditionParamsInner(*args, **kwargs)¶
Bases:
BaseModelA list of parameter conditions to apply against a specific instruction’s data.
- actual_instance: Optional[Union[SolDataParameterCondition, SolDataParameterConditionList]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[SolDataParameterCondition]¶
- oneof_schema_2_validator: Optional[SolDataParameterConditionList]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],SolDataParameterCondition,SolDataParameterConditionList,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.sol_data_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_data_criterion.SolDataCriterion(**data)¶
Bases:
BaseModelA schema for specifying criterion for instruction data in a Solana transaction.
- conditions: List[SolDataCondition]¶
- classmethod from_dict(obj)¶
Create an instance of SolDataCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolDataCriterion from a JSON string
- Return type:
Optional[Self]
- idls: List[SolDataCriterionIdlsInner]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.sol_data_criterion_idls_inner module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_data_criterion_idls_inner.SolDataCriterionIdlsInner(*args, **kwargs)¶
Bases:
BaseModel- actual_instance: Optional[Union[Idl, KnownIdlType]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[KnownIdlType]¶
- oneof_schema_2_validator: Optional[Idl]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],Idl,KnownIdlType,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.sol_data_parameter_condition module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_data_parameter_condition.SolDataParameterCondition(**data)¶
Bases:
BaseModelA single parameter condition to apply against a specific instruction’s parameters.
- classmethod from_dict(obj)¶
Create an instance of SolDataParameterCondition from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolDataParameterCondition from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: StrictStr¶
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- value: StrictStr¶
cdp.openapi_client.models.sol_data_parameter_condition_list module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_data_parameter_condition_list.SolDataParameterConditionList(**data)¶
Bases:
BaseModelA single parameter condition to apply against a specific instruction’s parameters.
- classmethod from_dict(obj)¶
Create an instance of SolDataParameterConditionList from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolDataParameterConditionList from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: StrictStr¶
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- values: List[StrictStr]¶
cdp.openapi_client.models.sol_message_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_message_criterion.SolMessageCriterion(**data)¶
Bases:
BaseModelThe criterion for the message of a Solana transaction.
- classmethod from_dict(obj)¶
Create an instance of SolMessageCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolMessageCriterion from a JSON string
- Return type:
Optional[Self]
- match: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.sol_network_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_network_criterion.SolNetworkCriterion(**data)¶
Bases:
BaseModelThe criterion for the Solana network of a transaction.
- classmethod from_dict(obj)¶
Create an instance of SolNetworkCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolNetworkCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- networks: List[StrictStr]¶
- classmethod networks_validate_enum(value)¶
Validates the enum
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.sol_value_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.sol_value_criterion.SolValueCriterion(**data)¶
Bases:
BaseModelThe criterion for the SOL value in lamports of a native transfer instruction in a Solana transaction.
- classmethod from_dict(obj)¶
Create an instance of SolValueCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolValueCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- sol_value: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.solana_account module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.solana_account.SolanaAccount(**data)¶
Bases:
BaseModel- address: Annotated[str, Field(strict=True)]¶
- classmethod address_validate_regular_expression(value)¶
Validates the regular expression
- created_at: Optional[datetime]¶
- classmethod from_dict(obj)¶
Create an instance of SolanaAccount from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolanaAccount from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- policies: Optional[List[Annotated[str, Field(strict=True)]]]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- updated_at: Optional[datetime]¶
cdp.openapi_client.models.solana_token module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.solana_token.SolanaToken(**data)¶
Bases:
BaseModelGeneral information about a Solana token. Includes the mint address, and other identifying information.
- classmethod from_dict(obj)¶
Create an instance of SolanaToken from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolanaToken from a JSON string
- Return type:
Optional[Self]
- mint_address: Annotated[str, Field(strict=True)]¶
- classmethod mint_address_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[StrictStr]¶
- symbol: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.solana_token_amount module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.solana_token_amount.SolanaTokenAmount(**data)¶
Bases:
BaseModelAmount of a given Solana token.
- amount: Annotated[str, Field(strict=True)]¶
- classmethod amount_validate_regular_expression(value)¶
Validates the regular expression
- decimals: StrictInt¶
- classmethod from_dict(obj)¶
Create an instance of SolanaTokenAmount from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolanaTokenAmount from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.solana_token_balance module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.solana_token_balance.SolanaTokenBalance(**data)¶
Bases:
BaseModel- amount: SolanaTokenAmount¶
- classmethod from_dict(obj)¶
Create an instance of SolanaTokenBalance from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SolanaTokenBalance from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- token: SolanaToken¶
cdp.openapi_client.models.spend_permission module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.spend_permission.SpendPermission(**data)¶
Bases:
BaseModelThe core spend permission.
- account: Annotated[str, Field(strict=True)]¶
- classmethod account_validate_regular_expression(value)¶
Validates the regular expression
- allowance: StrictStr¶
- end: StrictStr¶
- extra_data: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of SpendPermission from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SpendPermission from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- period: StrictStr¶
- salt: StrictStr¶
- spender: Annotated[str, Field(strict=True)]¶
- classmethod spender_validate_regular_expression(value)¶
Validates the regular expression
- start: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- token: Annotated[str, Field(strict=True)]¶
- classmethod token_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.spend_permission_network module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.spend_permission_network.SpendPermissionNetwork(value)¶
Bases:
str,EnumThe network the spend permission is on.
- ARBITRUM = 'arbitrum'¶
- AVALANCHE = 'avalanche'¶
- BASE = 'base'¶
- BASE_MINUS_SEPOLIA = 'base-sepolia'¶
- ETHEREUM = 'ethereum'¶
- ETHEREUM_MINUS_SEPOLIA = 'ethereum-sepolia'¶
- OPTIMISM = 'optimism'¶
- POLYGON = 'polygon'¶
- classmethod from_json(json_str)¶
Create an instance of SpendPermissionNetwork from a JSON string
- Return type:
Self
cdp.openapi_client.models.spend_permission_response_object module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.spend_permission_response_object.SpendPermissionResponseObject(**data)¶
Bases:
BaseModel- created_at: datetime¶
- classmethod from_dict(obj)¶
Create an instance of SpendPermissionResponseObject from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SpendPermissionResponseObject from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: SpendPermissionNetwork¶
- permission: SpendPermission¶
- permission_hash: StrictStr¶
- revoked: StrictBool¶
- revoked_at: Optional[datetime]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.spl_address_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.spl_address_criterion.SplAddressCriterion(**data)¶
Bases:
BaseModelThe criterion for the recipient addresses of a Solana transaction’s SPL token transfer instructions.
- addresses: List[Annotated[str, Field(strict=True)]]¶
- classmethod from_dict(obj)¶
Create an instance of SplAddressCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SplAddressCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.spl_value_criterion module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.spl_value_criterion.SplValueCriterion(**data)¶
Bases:
BaseModelThe criterion for the SPL token value of a SPL token transfer instruction in a Solana transaction.
- classmethod from_dict(obj)¶
Create an instance of SplValueCriterion from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SplValueCriterion from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- operator: StrictStr¶
- classmethod operator_validate_enum(value)¶
Validates the enum
- spl_value: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- type: StrictStr¶
- classmethod type_validate_enum(value)¶
Validates the enum
cdp.openapi_client.models.supported_x402_payment_kinds200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.supported_x402_payment_kinds200_response.SupportedX402PaymentKinds200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of SupportedX402PaymentKinds200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of SupportedX402PaymentKinds200Response from a JSON string
- Return type:
Optional[Self]
- kinds: List[X402SupportedPaymentKind]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.token module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.token.Token(**data)¶
Bases:
BaseModelGeneral information about a token. Includes the type, the network, and other identifying information.
- contract_address: Annotated[str, Field(strict=True)]¶
- classmethod contract_address_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of Token from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of Token from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[StrictStr]¶
- network: ListEvmTokenBalancesNetwork¶
- symbol: Optional[StrictStr]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.token_amount module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.token_amount.TokenAmount(**data)¶
Bases:
BaseModelAmount of a given token.
- amount: Annotated[str, Field(strict=True)]¶
- classmethod amount_validate_regular_expression(value)¶
Validates the regular expression
- decimals: StrictInt¶
- classmethod from_dict(obj)¶
Create an instance of TokenAmount from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of TokenAmount from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.token_balance module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.token_balance.TokenBalance(**data)¶
Bases:
BaseModel- amount: TokenAmount¶
- classmethod from_dict(obj)¶
Create an instance of TokenBalance from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of TokenBalance from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- token: Token¶
cdp.openapi_client.models.token_fee module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.token_fee.TokenFee(**data)¶
Bases:
BaseModel- amount: Annotated[str, Field(strict=True)]¶
- classmethod amount_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of TokenFee from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of TokenFee from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- token: Annotated[str, Field(strict=True)]¶
- classmethod token_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.transfer module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.transfer.Transfer(**data)¶
Bases:
BaseModelThe transfer object.
- created_at: StrictStr¶
- fees: List[Fee]¶
- 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]
- id: Annotated[str, Field(strict=True)]¶
- classmethod id_validate_regular_expression(value)¶
Validates the regular expression
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- source: TransferSource¶
- source_amount: StrictStr¶
- source_currency: StrictStr¶
- source_type: StrictStr¶
- classmethod source_type_validate_enum(value)¶
Validates the enum
- status: StrictStr¶
- classmethod status_validate_enum(value)¶
Validates the enum
- target: TransferTarget¶
- target_amount: StrictStr¶
- target_currency: StrictStr¶
- target_type: StrictStr¶
- classmethod target_type_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction_hash: Optional[StrictStr]¶
- updated_at: StrictStr¶
- user_amount: StrictStr¶
- user_currency: StrictStr¶
cdp.openapi_client.models.transfer_source module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.transfer_source.TransferSource(*args, **kwargs)¶
Bases:
BaseModelThe source of the transfer.
- actual_instance: Optional[Union[PaymentMethodRequest]]¶
- 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[PaymentMethodRequest]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],PaymentMethodRequest,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.transfer_target module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.transfer_target.TransferTarget(*args, **kwargs)¶
Bases:
BaseModelThe target of the transfer.
- actual_instance: Optional[Union[CryptoRailAddress]]¶
- 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[CryptoRailAddress]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],CryptoRailAddress,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.update_evm_account_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.update_evm_account_request.UpdateEvmAccountRequest(**data)¶
Bases:
BaseModel- account_policy: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod account_policy_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of UpdateEvmAccountRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of UpdateEvmAccountRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.update_evm_smart_account_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.update_evm_smart_account_request.UpdateEvmSmartAccountRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of UpdateEvmSmartAccountRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of UpdateEvmSmartAccountRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.update_policy_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.update_policy_request.UpdatePolicyRequest(**data)¶
Bases:
BaseModel- description: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod description_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of UpdatePolicyRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of UpdatePolicyRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- rules: List[Rule]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.update_solana_account_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.update_solana_account_request.UpdateSolanaAccountRequest(**data)¶
Bases:
BaseModel- account_policy: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod account_policy_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of UpdateSolanaAccountRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of UpdateSolanaAccountRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod name_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.user_operation_receipt module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.user_operation_receipt.UserOperationReceipt(**data)¶
Bases:
BaseModelThe receipt that contains information about the execution of user operation.
- block_hash: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod block_hash_validate_regular_expression(value)¶
Validates the regular expression
- block_number: Optional[StrictInt]¶
- classmethod from_dict(obj)¶
Create an instance of UserOperationReceipt from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of UserOperationReceipt from a JSON string
- Return type:
Optional[Self]
- gas_used: Optional[StrictStr]¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- revert: Optional[UserOperationReceiptRevert]¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction_hash: Optional[Annotated[str, Field(strict=True)]]¶
- classmethod transaction_hash_validate_regular_expression(value)¶
Validates the regular expression
cdp.openapi_client.models.user_operation_receipt_revert module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.user_operation_receipt_revert.UserOperationReceiptRevert(**data)¶
Bases:
BaseModelThe revert data if the user operation has reverted.
- data: Annotated[str, Field(strict=True)]¶
- classmethod data_validate_regular_expression(value)¶
Validates the regular expression
- classmethod from_dict(obj)¶
Create an instance of UserOperationReceiptRevert from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of UserOperationReceiptRevert from a JSON string
- Return type:
Optional[Self]
- message: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.validate_end_user_access_token_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.validate_end_user_access_token_request.ValidateEndUserAccessTokenRequest(**data)¶
Bases:
BaseModelThe request body for a developer to verify an end user’s access token.
- access_token: StrictStr¶
- classmethod from_dict(obj)¶
Create an instance of ValidateEndUserAccessTokenRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of ValidateEndUserAccessTokenRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.verify_x402_payment200_response module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.verify_x402_payment200_response.VerifyX402Payment200Response(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of VerifyX402Payment200Response from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of VerifyX402Payment200Response from a JSON string
- Return type:
Optional[Self]
- invalid_reason: Optional[X402VerifyInvalidReason]¶
- is_valid: StrictBool¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- payer: Annotated[str, Field(strict=True)]¶
- classmethod payer_validate_regular_expression(value)¶
Validates the regular expression
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.verify_x402_payment_request module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.verify_x402_payment_request.VerifyX402PaymentRequest(**data)¶
Bases:
BaseModel- classmethod from_dict(obj)¶
Create an instance of VerifyX402PaymentRequest from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of VerifyX402PaymentRequest from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- payment_payload: X402PaymentPayload¶
- payment_requirements: X402PaymentRequirements¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- x402_version: X402Version¶
cdp.openapi_client.models.x402_exact_evm_payload module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.x402_exact_evm_payload.X402ExactEvmPayload(**data)¶
Bases:
BaseModelThe x402 protocol exact scheme payload for EVM networks. The scheme is implemented using ERC-3009. For more details, please see [EVM Exact Scheme Details](https://github.com/coinbase/x402/blob/main/specs/schemes/exact/scheme_exact_evm.md).
- authorization: X402ExactEvmPayloadAuthorization¶
- classmethod from_dict(obj)¶
Create an instance of X402ExactEvmPayload from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of X402ExactEvmPayload from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- signature: StrictStr¶
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.x402_exact_solana_payload module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.x402_exact_solana_payload.X402ExactSolanaPayload(**data)¶
Bases:
BaseModelThe x402 protocol exact scheme payload for Solana networks. For more details, please see [Solana Exact Scheme Details](https://github.com/coinbase/x402/blob/main/specs/schemes/exact/scheme_exact_svm.md).
- classmethod from_dict(obj)¶
Create an instance of X402ExactSolanaPayload from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of X402ExactSolanaPayload from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- transaction: StrictStr¶
cdp.openapi_client.models.x402_payment_payload module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.x402_payment_payload.X402PaymentPayload(**data)¶
Bases:
BaseModelThe x402 protocol payment payload that the client attaches to x402-paid API requests to the resource server in the X-PAYMENT header.
- classmethod from_dict(obj)¶
Create an instance of X402PaymentPayload from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of X402PaymentPayload from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: StrictStr¶
- classmethod network_validate_enum(value)¶
Validates the enum
- payload: X402PaymentPayloadPayload¶
- scheme: StrictStr¶
- classmethod scheme_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- x402_version: X402Version¶
cdp.openapi_client.models.x402_payment_payload_payload module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.x402_payment_payload_payload.X402PaymentPayloadPayload(*args, **kwargs)¶
Bases:
BaseModelThe payload of the payment depending on the x402Version, scheme, and network.
- actual_instance: Optional[Union[X402ExactEvmPayload, X402ExactSolanaPayload]]¶
- classmethod actual_instance_must_validate_oneof(v)¶
- classmethod from_dict(obj)¶
- Return type:
Self
- classmethod from_json(json_str)¶
Returns the object represented by the json string
- Return type:
Self
- model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- one_of_schemas: Set[str]¶
- oneof_schema_1_validator: Optional[X402ExactEvmPayload]¶
- oneof_schema_2_validator: Optional[X402ExactSolanaPayload]¶
- to_dict()¶
Returns the dict representation of the actual instance
- Return type:
Union[Dict[str,Any],X402ExactEvmPayload,X402ExactSolanaPayload,None]
- to_json()¶
Returns the JSON representation of the actual instance
- Return type:
str
- to_str()¶
Returns the string representation of the actual instance
- Return type:
str
cdp.openapi_client.models.x402_payment_requirements module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.x402_payment_requirements.X402PaymentRequirements(**data)¶
Bases:
BaseModelThe x402 protocol payment requirements that the resource server expects the client’s payment payload to meet.
- asset: Annotated[str, Field(strict=True)]¶
- classmethod asset_validate_regular_expression(value)¶
Validates the regular expression
- description: StrictStr¶
- extra: Optional[Dict[str, Any]]¶
- classmethod from_dict(obj)¶
Create an instance of X402PaymentRequirements from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of X402PaymentRequirements from a JSON string
- Return type:
Optional[Self]
- max_amount_required: StrictStr¶
- max_timeout_seconds: StrictInt¶
- mime_type: StrictStr¶
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: StrictStr¶
- classmethod network_validate_enum(value)¶
Validates the enum
- output_schema: Optional[Dict[str, Any]]¶
- pay_to: Annotated[str, Field(strict=True)]¶
- classmethod pay_to_validate_regular_expression(value)¶
Validates the regular expression
- resource: StrictStr¶
- scheme: StrictStr¶
- classmethod scheme_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
cdp.openapi_client.models.x402_settle_error_reason module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.x402_settle_error_reason.X402SettleErrorReason(value)¶
Bases:
str,EnumThe reason the payment settlement errored on the x402 protocol.
- INSUFFICIENT_FUNDS = 'insufficient_funds'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_FROM_ADDRESS_KYT = 'invalid_exact_evm_payload_authorization_from_address_kyt'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_TO_ADDRESS_KYT = 'invalid_exact_evm_payload_authorization_to_address_kyt'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_TYPED_DATA_MESSAGE = 'invalid_exact_evm_payload_authorization_typed_data_message'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALID_AFTER = 'invalid_exact_evm_payload_authorization_valid_after'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALID_BEFORE = 'invalid_exact_evm_payload_authorization_valid_before'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALUE = 'invalid_exact_evm_payload_authorization_value'¶
- INVALID_EXACT_EVM_PAYLOAD_SIGNATURE_ADDRESS = 'invalid_exact_evm_payload_signature_address'¶
- INVALID_NETWORK = 'invalid_network'¶
- INVALID_PAYLOAD = 'invalid_payload'¶
- INVALID_PAYMENT_REQUIREMENTS = 'invalid_payment_requirements'¶
- INVALID_SCHEME = 'invalid_scheme'¶
- INVALID_X402_VERSION = 'invalid_x402_version'¶
- SETTLE_EXACT_SVM_BLOCK_HEIGHT_EXCEEDED = 'settle_exact_svm_block_height_exceeded'¶
- SETTLE_EXACT_SVM_TRANSACTION_CONFIRMATION_TIMED_OUT = 'settle_exact_svm_transaction_confirmation_timed_out'¶
- classmethod from_json(json_str)¶
Create an instance of X402SettleErrorReason from a JSON string
- Return type:
Self
cdp.openapi_client.models.x402_supported_payment_kind module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.x402_supported_payment_kind.X402SupportedPaymentKind(**data)¶
Bases:
BaseModelThe supported payment kind for the x402 protocol. A kind is comprised of a scheme and a network, which together uniquely identify a way to move money on the x402 protocol. For more details, please see [x402 Schemes](https://github.com/coinbase/x402?tab=readme-ov-file#schemes).
- extra: Optional[Dict[str, Any]]¶
- classmethod from_dict(obj)¶
Create an instance of X402SupportedPaymentKind from a dict
- Return type:
Optional[Self]
- classmethod from_json(json_str)¶
Create an instance of X402SupportedPaymentKind from a JSON string
- Return type:
Optional[Self]
- model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- network: StrictStr¶
- classmethod network_validate_enum(value)¶
Validates the enum
- scheme: StrictStr¶
- classmethod scheme_validate_enum(value)¶
Validates the enum
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True): :rtype:
Dict[str,Any]None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- x402_version: X402Version¶
cdp.openapi_client.models.x402_verify_invalid_reason module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class cdp.openapi_client.models.x402_verify_invalid_reason.X402VerifyInvalidReason(value)¶
Bases:
str,EnumThe reason the payment is invalid on the x402 protocol.
- INSUFFICIENT_FUNDS = 'insufficient_funds'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_FROM_ADDRESS_KYT = 'invalid_exact_evm_payload_authorization_from_address_kyt'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_TO_ADDRESS_KYT = 'invalid_exact_evm_payload_authorization_to_address_kyt'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_TYPED_DATA_MESSAGE = 'invalid_exact_evm_payload_authorization_typed_data_message'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALID_AFTER = 'invalid_exact_evm_payload_authorization_valid_after'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALID_BEFORE = 'invalid_exact_evm_payload_authorization_valid_before'¶
- INVALID_EXACT_EVM_PAYLOAD_AUTHORIZATION_VALUE = 'invalid_exact_evm_payload_authorization_value'¶
- INVALID_EXACT_EVM_PAYLOAD_SIGNATURE = 'invalid_exact_evm_payload_signature'¶
- INVALID_EXACT_EVM_PAYLOAD_SIGNATURE_ADDRESS = 'invalid_exact_evm_payload_signature_address'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION = 'invalid_exact_svm_payload_transaction'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_AMOUNT_MISMATCH = 'invalid_exact_svm_payload_transaction_amount_mismatch'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CANNOT_DERIVE_RECEIVER_ATA = 'invalid_exact_svm_payload_transaction_cannot_derive_receiver_ata'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CREATE_ATA_INSTRUCTION = 'invalid_exact_svm_payload_transaction_create_ata_instruction'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CREATE_ATA_INSTRUCTION_INCORRECT_ASSET = 'invalid_exact_svm_payload_transaction_create_ata_instruction_incorrect_asset'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_CREATE_ATA_INSTRUCTION_INCORRECT_PAYEE = 'invalid_exact_svm_payload_transaction_create_ata_instruction_incorrect_payee'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS = 'invalid_exact_svm_payload_transaction_instructions'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_LIMIT_INSTRUCTION = 'invalid_exact_svm_payload_transaction_instructions_compute_limit_instruction'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION = 'invalid_exact_svm_payload_transaction_instructions_compute_price_instruction'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_COMPUTE_PRICE_INSTRUCTION_TOO_HIGH = 'invalid_exact_svm_payload_transaction_instructions_compute_price_instruction_too_high'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTIONS_LENGTH = 'invalid_exact_svm_payload_transaction_instructions_length'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTION_NOT_SPL_TOKEN_TRANSFER_CHECKED = 'invalid_exact_svm_payload_transaction_instruction_not_spl_token_transfer_checked'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_INSTRUCTION_NOT_TOKEN_2022_TRANSFER_CHECKED = 'invalid_exact_svm_payload_transaction_instruction_not_token_2022_transfer_checked'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_NOT_A_TRANSFER_INSTRUCTION = 'invalid_exact_svm_payload_transaction_not_a_transfer_instruction'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_RECEIVER_ATA_NOT_FOUND = 'invalid_exact_svm_payload_transaction_receiver_ata_not_found'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_SENDER_ATA_NOT_FOUND = 'invalid_exact_svm_payload_transaction_sender_ata_not_found'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_SIMULATION_FAILED = 'invalid_exact_svm_payload_transaction_simulation_failed'¶
- INVALID_EXACT_SVM_PAYLOAD_TRANSACTION_TRANSFER_TO_INCORRECT_ATA = 'invalid_exact_svm_payload_transaction_transfer_to_incorrect_ata'¶
- INVALID_NETWORK = 'invalid_network'¶
- INVALID_PAYLOAD = 'invalid_payload'¶
- INVALID_PAYMENT_REQUIREMENTS = 'invalid_payment_requirements'¶
- INVALID_SCHEME = 'invalid_scheme'¶
- INVALID_X402_VERSION = 'invalid_x402_version'¶
- classmethod from_json(json_str)¶
Create an instance of X402VerifyInvalidReason from a JSON string
- Return type:
Self
cdp.openapi_client.models.x402_version module¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
Module contents¶
Coinbase Developer Platform APIs
The Coinbase Developer Platform APIs - leading the world’s transition onchain.
The version of the OpenAPI document: 2.0.0 Contact: cdp@coinbase.com Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.