Skip to content

withdraw_networks

Withdrawal Networks Response.

This module contains the type definitions for the response of the withdrawal networks endpoint.

Classes

  • WithdrawNetworkInfo: A TypedDict that represents the structure of the network information.
  • WithdrawalNetworksResponse: A TypedDict that represents the structure of the withdrawal networks response.

WithdrawNetworkInfo

Bases: TypedDict

Network Information.

Attributes:

Name Type Description
network_id int

Network ID.
network_name str

Network name.
network_layer str

Network layer.
min_withdraw str

Min withdraw.
max_withdraw str

Max withdraw.
fee str

Fee.
address_regex str

Address regex.
memo_regex str

Memo regex.

Examples:

>>> WithdrawNetworkInfo(
...     network_id=1,
...     network_name="network_name",
...     network_layer="network_layer",
...     min_withdraw="min_withdraw",
...     max_withdraw="max_withdraw",
...     fee="fee",
...     address_regex="address_regex",
...     memo_regex="memo_regex",
... )
{
    'network_id': 1,
    'network_name': 'network_name',
    'network_layer': 'network_layer',
    'min_withdraw': 'min_withdraw',
    'max_withdraw': 'max_withdraw',
    'fee': 'fee',
    'address_regex': 'address_regex',
    'memo_regex': 'memo_regex'
}
Source code in src/bit24/types/responses/withdraw_networks.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class WithdrawNetworkInfo(TypedDict):
    """
    Network Information.

    Attributes:
        network_id (int): Network ID.
        network_name (str): Network name.
        network_layer (str): Network layer.
        min_withdraw (str): Min withdraw.
        max_withdraw (str): Max withdraw.
        fee (str): Fee.
        address_regex (str): Address regex.
        memo_regex (str): Memo regex.

    Examples:
        >>> WithdrawNetworkInfo(
        ...     network_id=1,
        ...     network_name="network_name",
        ...     network_layer="network_layer",
        ...     min_withdraw="min_withdraw",
        ...     max_withdraw="max_withdraw",
        ...     fee="fee",
        ...     address_regex="address_regex",
        ...     memo_regex="memo_regex",
        ... )
        {
            'network_id': 1,
            'network_name': 'network_name',
            'network_layer': 'network_layer',
            'min_withdraw': 'min_withdraw',
            'max_withdraw': 'max_withdraw',
            'fee': 'fee',
            'address_regex': 'address_regex',
            'memo_regex': 'memo_regex'
        }
    """

    network_id: int
    network_name: str
    network_layer: str
    min_withdraw: str
    max_withdraw: str | None
    fee: str
    address_regex: str
    memo_regex: str | None

WithdrawalNetworksResponse

Bases: TypedDict

Withdrawal Networks Response.

Attributes:

Name Type Description
balance str

Balance.
networks list[NetworkInfo]

Networks.

Examples:

>>> WithdrawalNetworksResponse(
...     balance="balance",
...     networks=[
...         WithdrawNetworkInfo(
...             network_id=1,
...             network_name="network_name",
...             network_layer="network_layer",
...             min_withdraw="min_withdraw",
...             max_withdraw="max_withdraw",
...             fee="fee",
...             address_regex="address_regex",
...             memo_regex="memo_regex",
...         )
...     ],
... )
{
    'balance': 'balance',
    'networks': [
        {
            'network_id': 1,
            'network_name': 'network_name',
            'network_layer': 'network_layer',
            'min_withdraw': 'min_withdraw',
            'max_withdraw': 'max_withdraw',
            'fee': 'fee',
            'address_regex': 'address_regex',
            'memo_regex': 'memo_regex'
        }
    ]
}
Source code in src/bit24/types/responses/withdraw_networks.py 
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
class WithdrawalNetworksResponse(TypedDict):
    """
    Withdrawal Networks Response.

    Attributes:
        balance (str): Balance.
        networks (list[NetworkInfo]): Networks.

    Examples:
        >>> WithdrawalNetworksResponse(
        ...     balance="balance",
        ...     networks=[
        ...         WithdrawNetworkInfo(
        ...             network_id=1,
        ...             network_name="network_name",
        ...             network_layer="network_layer",
        ...             min_withdraw="min_withdraw",
        ...             max_withdraw="max_withdraw",
        ...             fee="fee",
        ...             address_regex="address_regex",
        ...             memo_regex="memo_regex",
        ...         )
        ...     ],
        ... )
        {
            'balance': 'balance',
            'networks': [
                {
                    'network_id': 1,
                    'network_name': 'network_name',
                    'network_layer': 'network_layer',
                    'min_withdraw': 'min_withdraw',
                    'max_withdraw': 'max_withdraw',
                    'fee': 'fee',
                    'address_regex': 'address_regex',
                    'memo_regex': 'memo_regex'
                }
            ]
        }
    """

    balance: str
    networks: list[WithdrawNetworkInfo]