Skip to content

responses

Responses Type

This module contains the endpoints for the client.

AssetInfo

Bases: TypedDict, CoinInfo

Asset Information.

Attributes:

Name Type Description
coin_type int

Coin type.
each_price str

Each price.
change_24hr str

Change 24hr.
balance str

Balance.
available_balance str

Available balance.
in_orders str

In orders.
balance_irt str

Balance IRT.
balance_usdt str

Balance USDT.
markets list[AssetMarketInfo]

Markets.

Examples:

>>> AssetInfo(
...     coin_type=1,
...     each_price="each_price",
...     change_24hr="change_24hr",
...     balance="balance",
...     available_balance="available_balance",
...     in_orders="in_orders",
...     balance_irt="balance_irt",
...     balance_usdt="balance_usdt",
...     markets=[...],  # AssetMarketInfo
... )
{
    'coin_type': 1,
    'each_price': 'each_price',
    'change_24hr': 'change_24hr',
    'balance': 'balance',
    'available_balance': 'available_balance',
    'in_orders': 'in_orders',
    'balance_irt': 'balance_irt',
    'balance_usdt': 'balance_usdt',
    'markets': [...] # AssetMarketInfo
}
Source code in src/bit24/types/responses/assets_information.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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
class AssetInfo(TypedDict, CoinInfo):
    """
    Asset Information.

    Attributes:
        coin_type (int): Coin type.
        each_price (str): Each price.
        change_24hr (str): Change 24hr.
        balance (str): Balance.
        available_balance (str): Available balance.
        in_orders (str): In orders.
        balance_irt (str): Balance IRT.
        balance_usdt (str): Balance USDT.
        markets (list[AssetMarketInfo]): Markets.

    Examples:
        >>> AssetInfo(
        ...     coin_type=1,
        ...     each_price="each_price",
        ...     change_24hr="change_24hr",
        ...     balance="balance",
        ...     available_balance="available_balance",
        ...     in_orders="in_orders",
        ...     balance_irt="balance_irt",
        ...     balance_usdt="balance_usdt",
        ...     markets=[...],  # AssetMarketInfo
        ... )
        {
            'coin_type': 1,
            'each_price': 'each_price',
            'change_24hr': 'change_24hr',
            'balance': 'balance',
            'available_balance': 'available_balance',
            'in_orders': 'in_orders',
            'balance_irt': 'balance_irt',
            'balance_usdt': 'balance_usdt',
            'markets': [...] # AssetMarketInfo
        }
    """

    coin_type: int
    each_price: str
    change_24hr: str
    balance: str
    available_balance: str
    in_orders: str
    balance_irt: str
    balance_usdt: str
    markets: list[AssetMarketInfo]

AssetInformationResponse

Bases: TypedDict

Asset Information Response.

Attributes:

Name Type Description
message str

Message.
asset list[AssetInfo]

Asset.

Examples:

>>> AssetInformationResponse(
...     message="message",
...     asset=[...],  # AssetInfo
... )
{
    'message': 'message',
    'asset': [...] # AssetInfo
}
Source code in src/bit24/types/responses/assets_information.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
class AssetInformationResponse(TypedDict):
    """
    Asset Information Response.

    Attributes:
        message (str): Message.
        asset (list[AssetInfo]): Asset.

    Examples:
        >>> AssetInformationResponse(
        ...     message="message",
        ...     asset=[...],  # AssetInfo
        ... )
        {
            'message': 'message',
            'asset': [...] # AssetInfo
        }
    """

    message: str
    asset: list[AssetInfo]

AssetMarketInfo

Bases: TypedDict

Market Information.

Attributes:

Name Type Description
base_coin_symbol str

Base coin symbol.
quote_coin_symbol str

Quote coin symbol.
is_active int

Is active.

Examples:

>>> AssetMarketInfo(
...     base_coin_symbol="base_coin_symbol",
...     quote_coin_symbol="quote_coin_symbol",
...     is_active=1,
... )
{
    'base_coin_symbol': 'base_coin_symbol',
    'quote_coin_symbol': 'quote_coin_symbol',
    'is_active': 1
}
Source code in src/bit24/types/responses/assets_information.py 
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
class AssetMarketInfo(TypedDict):
    """
    Market Information.

    Attributes:
        base_coin_symbol (str): Base coin symbol.
        quote_coin_symbol (str): Quote coin symbol.
        is_active (int): Is active.

    Examples:
        >>> AssetMarketInfo(
        ...     base_coin_symbol="base_coin_symbol",
        ...     quote_coin_symbol="quote_coin_symbol",
        ...     is_active=1,
        ... )
        {
            'base_coin_symbol': 'base_coin_symbol',
            'quote_coin_symbol': 'quote_coin_symbol',
            'is_active': 1
        }
    """

    base_coin_symbol: str
    quote_coin_symbol: str
    is_active: int

AssetsHistoryResponse

Bases: TypedDict

Assets history response.

Attributes:

Name Type Description
message str

Message.
has_paginate int

Has paginate.
total_data int

Total data.
current_page int

Current page.
from_ int

From.
to int

To.
per_page int

Per page.
results list[Transaction]

Results.

Examples:

>>> AssetsHistoryResponse(
...     message="message",
...     has_paginate=1,
...     total_data=1,
...     current_page=1,
...     from_=1,
...     to=1,
...     per_page=1,
...     results=[
...         {
...             "id": 1,
...             "name": "name",
...             "fa_name": "fa_name",
...             "symbol": "symbol",
...             "logo": "logo",
...             "value": "value",
...             "done_value": "done_value",
...             "type": 1,
...             "transaction_code": "transaction_code",
...             "type_text": "type_text",
...             "reason_type": "reason_type",
...             "reason_text": "reason_text",
...             "reason_type_text": "reason_type_text",
...             "reason_id": 1,
...             "balance_status": 1,
...             "balance_status_text": "balance_status_text",
...             "commission": 1,
...             "created_at": "created_at",
...             "created_at_jalali": "created_at_jalali",
...         }
...     ],
... )
{
    "message": "message",
    "has_paginate": 1,
    "total_data": 1,
    "current_page": 1,
    "from_": 1,
    "to": 1,
    "per_page": 1,
    "results": [
        {
            "id": 1,
            "name": "name",
            "fa_name": "fa_name",
            "symbol": "symbol",
            "logo": "logo",
            "value": "value",
            "done_value": "done_value",
            "type": 1,
            "transaction_code": "transaction_code",
            "type_text": "type_text",
            "reason_type": "reason_type",
            "reason_text": "reason_text",
            "reason_type_text": "reason_type_text",
            "reason_id": 1,
            "balance_status": 1,
            "balance_status_text": "balance_status_text",
            "commission": 1,
            "created_at": "created_at",
            "created_at_jalali": "created_at_jalali"
        }
    ]
}
Source code in src/bit24/types/responses/assets_history.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
class AssetsHistoryResponse(TypedDict):
    """
    Assets history response.

    Attributes:
        message (str): Message.
        has_paginate (int): Has paginate.
        total_data (int): Total data.
        current_page (int): Current page.
        from_ (int): From.
        to (int): To.
        per_page (int): Per page.
        results (list[Transaction]): Results.

    Examples:
        >>> AssetsHistoryResponse(
        ...     message="message",
        ...     has_paginate=1,
        ...     total_data=1,
        ...     current_page=1,
        ...     from_=1,
        ...     to=1,
        ...     per_page=1,
        ...     results=[
        ...         {
        ...             "id": 1,
        ...             "name": "name",
        ...             "fa_name": "fa_name",
        ...             "symbol": "symbol",
        ...             "logo": "logo",
        ...             "value": "value",
        ...             "done_value": "done_value",
        ...             "type": 1,
        ...             "transaction_code": "transaction_code",
        ...             "type_text": "type_text",
        ...             "reason_type": "reason_type",
        ...             "reason_text": "reason_text",
        ...             "reason_type_text": "reason_type_text",
        ...             "reason_id": 1,
        ...             "balance_status": 1,
        ...             "balance_status_text": "balance_status_text",
        ...             "commission": 1,
        ...             "created_at": "created_at",
        ...             "created_at_jalali": "created_at_jalali",
        ...         }
        ...     ],
        ... )
        {
            "message": "message",
            "has_paginate": 1,
            "total_data": 1,
            "current_page": 1,
            "from_": 1,
            "to": 1,
            "per_page": 1,
            "results": [
                {
                    "id": 1,
                    "name": "name",
                    "fa_name": "fa_name",
                    "symbol": "symbol",
                    "logo": "logo",
                    "value": "value",
                    "done_value": "done_value",
                    "type": 1,
                    "transaction_code": "transaction_code",
                    "type_text": "type_text",
                    "reason_type": "reason_type",
                    "reason_text": "reason_text",
                    "reason_type_text": "reason_type_text",
                    "reason_id": 1,
                    "balance_status": 1,
                    "balance_status_text": "balance_status_text",
                    "commission": 1,
                    "created_at": "created_at",
                    "created_at_jalali": "created_at_jalali"
                }
            ]
        }
    """

    message: str
    has_paginate: int
    total_data: int
    current_page: int
    from_: int
    to: int
    per_page: int
    results: list[Transaction]

BaseResponse

Bases: TypedDict, Generic[T]

Base Response.

Attributes:

Name Type Description
data T

Data.
error dict[str, str] | None

Error.
status_code int

Status code.
success bool

Success.

Examples:

>>> BaseResponse(data=..., error=..., status_code=..., success=...)
{
    'data': ...,
    'error': ...,
    'status_code': ...,
    'success': ...
}
Source code in src/bit24/types/responses/base.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
class BaseResponse(TypedDict, Generic[T]):
    """
    Base Response.

    Attributes:
        data (T): Data.
        error (dict[str, str] | None): Error.
        status_code (int): Status code.
        success (bool): Success.

    Examples:
        >>> BaseResponse(data=..., error=..., status_code=..., success=...)
        {
            'data': ...,
            'error': ...,
            'status_code': ...,
            'success': ...
        }
    """

    data: T
    error: Error | None
    status_code: int
    success: bool

CancelOrderResponse

Bases: TypedDict

Cancel Order Response.

Attributes:

Name Type Description
message str

Message.

Examples:

>>> CancelOrderResponse(message="message")
{'message': 'message'}
Source code in src/bit24/types/responses/cancel_order.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class CancelOrderResponse(TypedDict):
    """
    Cancel Order Response.

    Attributes:
        message (str): Message.

    Examples:
        >>> CancelOrderResponse(message="message")
        {'message': 'message'}
    """

    message: str

CreateOrderResponse

Bases: TypedDict

Create Order Response.

Attributes:

Name Type Description
message str

Message.
order OrderInfo

Order.

Examples:

>>> CreateOrderResponse(
...     message="message",
...     order=OrderInfo(
...         id=1,
...         type=1,
...         each_price="each_price",
...         stop_price="stop_price",
...         trigger_price="trigger_price",
...         amount="amount",
...         available_amount="available_amount",
...         done_value="done_value",
...         done_percent="done_percent",
...         mean_value=1,
...         commission="commission",
...         total="total",
...         created_at="created_at",
...         created_at_jalali="created_at_jalali",
...         base_coin=CoinInfo(
...             id=1,
...             symbol="symbol",
...             name="name",
...             fa_name="fa_name",
...             web_icon="web_icon",
...             app_icon="app_icon",
...         ),
...         quote_coin=CoinInfo(
...             id=1,
...             symbol="symbol",
...             name="name",
...             fa_name="fa_name",
...             web_icon="web_icon",
...             app_icon="app_icon",
...         ),
...         status=1,
...         status_text="status_text",
...         category_type="category_type",
...         category_type_text="category_type_text",
...         conditions="conditions",
...         triggered_category_type="triggered_category_type",
...         is_trade=1,
...     ),
... )
{
    "message": "message",
    "order": {
        "id": 1,
        "type": 1,
        "each_price": "each_price",
        "stop_price": "stop_price",
        "trigger_price": "trigger_price",
        "amount": "amount",
        "available_amount": "available_amount",
        "done_value": "done_value",
        "done_percent": "done_percent",
        "mean_value": 1,
        "commission": "commission",
        "total": "total",
        "created_at": "created_at",
        "created_at_jalali": "created_at_jalali",
        "base_coin": {
            "id": 1,
            "symbol": "symbol",
            "name": "name",
            "fa_name": "fa_name",
            "web_icon": "web_icon",
            "app_icon": "app_icon"
        },
        "quote_coin": {
            "id": 1,
            "symbol": "symbol",
            "name": "name",
            "fa_name": "fa_name",
            "web_icon": "web_icon",
            "app_icon": "app_icon"
        },
        "status": 1,
        "status_text": "status_text",
        "category_type": "category_type",
        "category_type_text": "category_type_text",
        "conditions": "conditions",
        "triggered_category_type": "triggered_category_type",
        "is_trade": 1
    }
}
Source code in src/bit24/types/responses/create_order.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
class CreateOrderResponse(TypedDict):
    """
    Create Order Response.

    Attributes:
        message (str): Message.
        order (OrderInfo): Order.

    Examples:
        >>> CreateOrderResponse(
        ...     message="message",
        ...     order=OrderInfo(
        ...         id=1,
        ...         type=1,
        ...         each_price="each_price",
        ...         stop_price="stop_price",
        ...         trigger_price="trigger_price",
        ...         amount="amount",
        ...         available_amount="available_amount",
        ...         done_value="done_value",
        ...         done_percent="done_percent",
        ...         mean_value=1,
        ...         commission="commission",
        ...         total="total",
        ...         created_at="created_at",
        ...         created_at_jalali="created_at_jalali",
        ...         base_coin=CoinInfo(
        ...             id=1,
        ...             symbol="symbol",
        ...             name="name",
        ...             fa_name="fa_name",
        ...             web_icon="web_icon",
        ...             app_icon="app_icon",
        ...         ),
        ...         quote_coin=CoinInfo(
        ...             id=1,
        ...             symbol="symbol",
        ...             name="name",
        ...             fa_name="fa_name",
        ...             web_icon="web_icon",
        ...             app_icon="app_icon",
        ...         ),
        ...         status=1,
        ...         status_text="status_text",
        ...         category_type="category_type",
        ...         category_type_text="category_type_text",
        ...         conditions="conditions",
        ...         triggered_category_type="triggered_category_type",
        ...         is_trade=1,
        ...     ),
        ... )
        {
            "message": "message",
            "order": {
                "id": 1,
                "type": 1,
                "each_price": "each_price",
                "stop_price": "stop_price",
                "trigger_price": "trigger_price",
                "amount": "amount",
                "available_amount": "available_amount",
                "done_value": "done_value",
                "done_percent": "done_percent",
                "mean_value": 1,
                "commission": "commission",
                "total": "total",
                "created_at": "created_at",
                "created_at_jalali": "created_at_jalali",
                "base_coin": {
                    "id": 1,
                    "symbol": "symbol",
                    "name": "name",
                    "fa_name": "fa_name",
                    "web_icon": "web_icon",
                    "app_icon": "app_icon"
                },
                "quote_coin": {
                    "id": 1,
                    "symbol": "symbol",
                    "name": "name",
                    "fa_name": "fa_name",
                    "web_icon": "web_icon",
                    "app_icon": "app_icon"
                },
                "status": 1,
                "status_text": "status_text",
                "category_type": "category_type",
                "category_type_text": "category_type_text",
                "conditions": "conditions",
                "triggered_category_type": "triggered_category_type",
                "is_trade": 1
            }
        }
    """

    message: str
    order: OrderInfo

DepositNetworkInfo

Bases: TypedDict

Network Information.

Attributes:

Name Type Description
network_name (str

Network name.
network_layer str

Network layer.
description_deposit str

Description deposit.
min_deposit str

Min deposit.
address str

Address.
memo str

Memo.

Examples:

>>> DepositNetworkInfo(
...     network_name="network_name",
...     network_layer="network_layer",
...     description_deposit="description_deposit",
...     min_deposit="min_deposit",
...     address="address",
...     memo="memo",
... )
{
    'network_name': 'network_name',
    'network_layer': 'network_layer',
    'description_deposit': 'description_deposit',
    'min_deposit': 'min_deposit',
    'address': 'address',
    'memo': 'memo'
}
Source code in src/bit24/types/responses/deposit_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
class DepositNetworkInfo(TypedDict):
    """
    Network Information.

    Attributes:
        network_name  (str): Network name.
        network_layer (str): Network layer.
        description_deposit (str): Description deposit.
        min_deposit (str): Min deposit.
        address (str): Address.
        memo (str): Memo.

    Examples:
        >>> DepositNetworkInfo(
        ...     network_name="network_name",
        ...     network_layer="network_layer",
        ...     description_deposit="description_deposit",
        ...     min_deposit="min_deposit",
        ...     address="address",
        ...     memo="memo",
        ... )
        {
            'network_name': 'network_name',
            'network_layer': 'network_layer',
            'description_deposit': 'description_deposit',
            'min_deposit': 'min_deposit',
            'address': 'address',
            'memo': 'memo'
        }
    """

    network_name: str
    network_layer: str
    description_deposit: str
    min_deposit: str
    address: str
    memo: str | None

DepositNetworksResponse

Bases: TypedDict

Deposit Networks Response.

Attributes:

Name Type Description
networks list[DepositNetworkInfo]

Networks.

Examples:

>>> DepositNetworksResponse(
...     networks=[
...         DepositNetworkInfo(
...             network_name="network_name",
...             network_layer="network_layer",
...             description_deposit="description_deposit",
...             min_deposit="min_deposit",
...             address="address",
...             memo="memo",
...         )
...     ]
... )
{
    'networks': [
        {
            'network_name': 'network_name',
            'network_layer': 'network_layer',
            'description_deposit': 'description_deposit',
            'min_deposit': 'min_deposit',
            'address': 'address',
            'memo': 'memo'
        }
    ]
}
Source code in src/bit24/types/responses/deposit_networks.py 
56
57
58
59
60
61
62
63
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
class DepositNetworksResponse(TypedDict):
    """
    Deposit Networks Response.

    Attributes:
        networks (list[DepositNetworkInfo]): Networks.

    Examples:
        >>> DepositNetworksResponse(
        ...     networks=[
        ...         DepositNetworkInfo(
        ...             network_name="network_name",
        ...             network_layer="network_layer",
        ...             description_deposit="description_deposit",
        ...             min_deposit="min_deposit",
        ...             address="address",
        ...             memo="memo",
        ...         )
        ...     ]
        ... )
        {
            'networks': [
                {
                    'network_name': 'network_name',
                    'network_layer': 'network_layer',
                    'description_deposit': 'description_deposit',
                    'min_deposit': 'min_deposit',
                    'address': 'address',
                    'memo': 'memo'
                }
            ]
        }
    """

    networks: list[DepositNetworkInfo]

Error

Bases: TypedDict

Error.

Attributes:

Name Type Description
message str

Message.
errors list[ErrorInformation]

Errors.

Examples:

>>> Error(message=..., errors=...)
{
    'message': ...,
    'errors': ...
}
Source code in src/bit24/types/responses/base.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
class Error(TypedDict):
    """
    Error.

    Attributes:
        message (str): Message.
        errors (list[ErrorInformation]): Errors.

    Examples:
        >>> Error(message=..., errors=...)
        {
            'message': ...,
            'errors': ...
        }
    """

    message: str
    errors: list[ErrorInformation] | None

ErrorInformation

Bases: TypedDict

Error Information.

Attributes:

Name Type Description
reason str

Reason.
message str

Message.

Examples:

>>> ErrorInformation(reason=..., message=...)
{
    'reason': ...,
    'message': ...
}
Source code in src/bit24/types/responses/base.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class ErrorInformation(TypedDict):
    """
    Error Information.

    Attributes:
        reason (str): Reason.
        message (str): Message.

    Examples:
        >>> ErrorInformation(reason=..., message=...)
        {
            'reason': ...,
            'message': ...
        }
    """

    reason: str
    message: str

MarketInfo

Bases: TypedDict

Market Information.

Attributes:

Name Type Description
id int

Market ID.
base_coin_id int

Base coin ID.
base_coin_name str

Base coin name.
base_coin_fa_name str

Base coin Farsi name.
base_coin_symbol str

Base coin symbol.
quote_coin_id int

Quote coin ID.
quote_coin_symbol str

Quote coin symbol.
quote_coin_name str

Quote coin name.
quote_coin_fa_name str

Quote coin Farsi name.
each_price str

Each price.
other_side_each_price str

Other side each price.
quote_coin_volume str

Quote coin volume.
base_coin_volume str

Base coin volume.
_24h_change str

24-hour change.
_24h_change_volume str

24-hour change volume.
total_min str

Total min.
market_order_quote_coin_total_min str

Market order quote coin total min.
market_order_base_coin_total_min str

Market order base coin total min.
web_icon str

Web icon.
app_icon str

App icon.
quote_web_icon str

Quote web icon.
quote_app_icon str

Quote app icon.
is_active int

Is active.
first_order str

First order.
last_order str

Last order.
min_price str

Min price.
max_price str

Max price.
base_coin_decimal int

Base coin decimal.
quote_coin_decimal int

Quote coin decimal.
daily_chart_icon str

Daily chart icon.
is_favorite bool

Is favorite.

Examples:

>>> MarketInfo(
...     id=1,
...     base_coin_id=1,
...     base_coin_name="base_coin_name",
...     base_coin_fa_name="base_coin_fa_name",
...     base_coin_symbol="base_coin_symbol",
...     quote_coin_id=1,
...     quote_coin_symbol="quote_coin_symbol",
...     quote_coin_name="quote_coin_name",
...     quote_coin_fa_name="quote_coin_fa_name",
...     each_price="each_price",
...     other_side_each_price="other_side_each_price",
...     quote_coin_volume="quote_coin_volume",
...     base_coin_volume="base_coin_volume",
...     _24h_change="_24h_change",
...     _24h_change_volume="_24h_change_volume",
...     total_min="total_min",
...     market_order_quote_coin_total_min="market_order_quote_coin_total_min",
...     market_order_base_coin_total_min="market_order_base_coin_total_min",
...     web_icon="web_icon",
...     app_icon="app_icon",
...     quote_web_icon="quote_web_icon",
...     quote_app_icon="quote_app_icon",
...     is_active=1,
...     first_order="first_order",
...     last_order="last_order",
...     min_price="min_price",
...     max_price="max_price",
...     base_coin_decimal=1,
...     quote_coin_decimal=1,
...     daily_chart_icon="daily_chart_icon",
...     is_favorite=True,
... )
{
    'id': 1,
    'base_coin_id': 1,
    'base_coin_name': 'base_coin_name',
    'base_coin_fa_name': 'base_coin_fa_name',
    'base_coin_symbol': 'base_coin_symbol',
    'quote_coin_id': 1,
    'quote_coin_symbol': 'quote_coin_symbol',
    'quote_coin_name': 'quote_coin_name',
    'quote_coin_fa_name': 'quote_coin_fa_name',
    'each_price': 'each_price',
    'other_side_each_price': 'other_side_each_price',
    'quote_coin_volume': 'quote_coin_volume',
    'base_coin_volume': 'base_coin_volume',
    '_24h_change': '_24h_change',
    '_24h_change_volume': '_24h_change_volume',
    'total_min': 'total_min',
    'market_order_quote_coin_total_min': 'market_order_quote_coin_total_min',
    'market_order_base_coin_total_min': 'market_order_base_coin_total_min',
    'web_icon': 'web_icon',
    'app_icon': 'app_icon',
    'quote_web_icon': 'quote_web_icon',
    'quote_app_icon': 'quote_app_icon',
    'is_active': 1,
    'first_order': 'first_order',
    'last_order': 'last_order',
    'min_price': 'min_price',
    'max_price': 'max_price',
    'base_coin_decimal': 1,
    'quote_coin_decimal': 1,
    'daily_chart_icon': 'daily_chart_icon',
    'is_favorite': True
}
Source code in src/bit24/types/responses/markets_info.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
 62
 63
 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
class MarketInfo(TypedDict):
    """
    Market Information.

    Attributes:
        id (int): Market ID.
        base_coin_id (int): Base coin ID.
        base_coin_name (str): Base coin name.
        base_coin_fa_name (str): Base coin Farsi name.
        base_coin_symbol (str): Base coin symbol.
        quote_coin_id (int): Quote coin ID.
        quote_coin_symbol (str): Quote coin symbol.
        quote_coin_name (str): Quote coin name.
        quote_coin_fa_name (str): Quote coin Farsi name.
        each_price (str): Each price.
        other_side_each_price (str): Other side each price.
        quote_coin_volume (str): Quote coin volume.
        base_coin_volume (str): Base coin volume.
        _24h_change (str): 24-hour change.
        _24h_change_volume (str): 24-hour change volume.
        total_min (str): Total min.
        market_order_quote_coin_total_min (str): Market order quote coin total min.
        market_order_base_coin_total_min (str): Market order base coin total min.
        web_icon (str): Web icon.
        app_icon (str): App icon.
        quote_web_icon (str): Quote web icon.
        quote_app_icon (str): Quote app icon.
        is_active (int): Is active.
        first_order (str): First order.
        last_order (str): Last order.
        min_price (str): Min price.
        max_price (str): Max price.
        base_coin_decimal (int): Base coin decimal.
        quote_coin_decimal (int): Quote coin decimal.
        daily_chart_icon (str): Daily chart icon.
        is_favorite (bool): Is favorite.

    Examples:
        >>> MarketInfo(
        ...     id=1,
        ...     base_coin_id=1,
        ...     base_coin_name="base_coin_name",
        ...     base_coin_fa_name="base_coin_fa_name",
        ...     base_coin_symbol="base_coin_symbol",
        ...     quote_coin_id=1,
        ...     quote_coin_symbol="quote_coin_symbol",
        ...     quote_coin_name="quote_coin_name",
        ...     quote_coin_fa_name="quote_coin_fa_name",
        ...     each_price="each_price",
        ...     other_side_each_price="other_side_each_price",
        ...     quote_coin_volume="quote_coin_volume",
        ...     base_coin_volume="base_coin_volume",
        ...     _24h_change="_24h_change",
        ...     _24h_change_volume="_24h_change_volume",
        ...     total_min="total_min",
        ...     market_order_quote_coin_total_min="market_order_quote_coin_total_min",
        ...     market_order_base_coin_total_min="market_order_base_coin_total_min",
        ...     web_icon="web_icon",
        ...     app_icon="app_icon",
        ...     quote_web_icon="quote_web_icon",
        ...     quote_app_icon="quote_app_icon",
        ...     is_active=1,
        ...     first_order="first_order",
        ...     last_order="last_order",
        ...     min_price="min_price",
        ...     max_price="max_price",
        ...     base_coin_decimal=1,
        ...     quote_coin_decimal=1,
        ...     daily_chart_icon="daily_chart_icon",
        ...     is_favorite=True,
        ... )
        {
            'id': 1,
            'base_coin_id': 1,
            'base_coin_name': 'base_coin_name',
            'base_coin_fa_name': 'base_coin_fa_name',
            'base_coin_symbol': 'base_coin_symbol',
            'quote_coin_id': 1,
            'quote_coin_symbol': 'quote_coin_symbol',
            'quote_coin_name': 'quote_coin_name',
            'quote_coin_fa_name': 'quote_coin_fa_name',
            'each_price': 'each_price',
            'other_side_each_price': 'other_side_each_price',
            'quote_coin_volume': 'quote_coin_volume',
            'base_coin_volume': 'base_coin_volume',
            '_24h_change': '_24h_change',
            '_24h_change_volume': '_24h_change_volume',
            'total_min': 'total_min',
            'market_order_quote_coin_total_min': 'market_order_quote_coin_total_min',
            'market_order_base_coin_total_min': 'market_order_base_coin_total_min',
            'web_icon': 'web_icon',
            'app_icon': 'app_icon',
            'quote_web_icon': 'quote_web_icon',
            'quote_app_icon': 'quote_app_icon',
            'is_active': 1,
            'first_order': 'first_order',
            'last_order': 'last_order',
            'min_price': 'min_price',
            'max_price': 'max_price',
            'base_coin_decimal': 1,
            'quote_coin_decimal': 1,
            'daily_chart_icon': 'daily_chart_icon',
            'is_favorite': True
        }
    """

    id: int
    base_coin_id: int
    base_coin_name: str
    base_coin_fa_name: str
    base_coin_symbol: str
    quote_coin_id: int
    quote_coin_symbol: str
    quote_coin_name: str
    quote_coin_fa_name: str
    each_price: str
    other_side_each_price: str
    quote_coin_volume: str
    base_coin_volume: str
    _24h_change: str
    _24h_change_volume: str
    total_min: str
    market_order_quote_coin_total_min: str
    market_order_base_coin_total_min: str
    web_icon: str
    app_icon: str
    quote_web_icon: str
    quote_app_icon: str
    is_active: int
    first_order: str
    last_order: str
    min_price: str
    max_price: str
    base_coin_decimal: int
    quote_coin_decimal: int
    daily_chart_icon: str
    is_favorite: bool

MarketListResponse

Bases: TypedDict

Market List Response.

Attributes:

Name Type Description
message str

Message.
has_paginate int

Has paginate.
total_data int

Total data.
current_page int

Current page.
from_ int

From.
to int

To.
per_page int

Per page.
results list[MarketInfo]

Results.

Examples:

>>> MarketListResponse(
...     message="message",
...     has_paginate=1,
...     total_data=1,
...     current_page=1,
...     from_=1,
...     to=1,
...     per_page=1,
...     results=[
...         MarketInfo(
...             id=1,
...             base_coin_id=1,
...             base_coin_name="base_coin_name",
...             base_coin_fa_name="base_coin_fa_name",
...             base_coin_symbol="base_coin_symbol",
...             quote_coin_id=1,
...             quote_coin_symbol="quote_coin_symbol",
...             quote_coin_name="quote_coin_name",
...             quote_coin_fa_name="quote_coin_fa_name",
...             each_price="each_price",
...             other_side_each_price="other_side_each_price",
...             quote_coin_volume="quote_coin_volume",
...             base_coin_volume="base_coin_volume",
...             _24h_change="_24h_change",
...             _24h_change_volume="_24h_change_volume",
...             total_min="total_min",
...             market_order_quote_coin_total_min="market_order_quote_coin_total_min",
...             market_order_base_coin_total_min="market_order_base_coin_total_min",
...             web_icon="web_icon",
...             app_icon="app_icon",
...             quote_web_icon="quote_web_icon",
...             quote_app_icon="quote_app_icon",
...             is_active=1,
...             first_order="first_order",
...             last_order="last_order",
...             min_price="min_price",
...             max_price="max_price",
...             base_coin_decimal=1,
...             quote_coin_decimal=1,
...             daily_chart_icon="daily_chart_icon",
...             is_favorite=True
...     ]
... )
{
    'message': 'message',
    'has_paginate': 1,
    'total_data': 1,
    'current_page': 1,
    'from': 1,
    'to': 1,
    'per_page': 1,
    'results': [
        {
            'id': 1,
            'base_coin_id': 1,
            'base_coin_name
            ...
        }
    ]
}
Source code in src/bit24/types/responses/markets_info.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
class MarketListResponse(TypedDict):
    """
    Market List Response.

    Attributes:
        message (str): Message.
        has_paginate (int): Has paginate.
        total_data (int): Total data.
        current_page (int): Current page.
        from_ (int): From.
        to (int): To.
        per_page (int): Per page.
        results (list[MarketInfo]): Results.

    Examples:
        >>> MarketListResponse(
        ...     message="message",
        ...     has_paginate=1,
        ...     total_data=1,
        ...     current_page=1,
        ...     from_=1,
        ...     to=1,
        ...     per_page=1,
        ...     results=[
        ...         MarketInfo(
        ...             id=1,
        ...             base_coin_id=1,
        ...             base_coin_name="base_coin_name",
        ...             base_coin_fa_name="base_coin_fa_name",
        ...             base_coin_symbol="base_coin_symbol",
        ...             quote_coin_id=1,
        ...             quote_coin_symbol="quote_coin_symbol",
        ...             quote_coin_name="quote_coin_name",
        ...             quote_coin_fa_name="quote_coin_fa_name",
        ...             each_price="each_price",
        ...             other_side_each_price="other_side_each_price",
        ...             quote_coin_volume="quote_coin_volume",
        ...             base_coin_volume="base_coin_volume",
        ...             _24h_change="_24h_change",
        ...             _24h_change_volume="_24h_change_volume",
        ...             total_min="total_min",
        ...             market_order_quote_coin_total_min="market_order_quote_coin_total_min",
        ...             market_order_base_coin_total_min="market_order_base_coin_total_min",
        ...             web_icon="web_icon",
        ...             app_icon="app_icon",
        ...             quote_web_icon="quote_web_icon",
        ...             quote_app_icon="quote_app_icon",
        ...             is_active=1,
        ...             first_order="first_order",
        ...             last_order="last_order",
        ...             min_price="min_price",
        ...             max_price="max_price",
        ...             base_coin_decimal=1,
        ...             quote_coin_decimal=1,
        ...             daily_chart_icon="daily_chart_icon",
        ...             is_favorite=True
        ...     ]
        ... )
        {
            'message': 'message',
            'has_paginate': 1,
            'total_data': 1,
            'current_page': 1,
            'from': 1,
            'to': 1,
            'per_page': 1,
            'results': [
                {
                    'id': 1,
                    'base_coin_id': 1,
                    'base_coin_name
                    ...
                }
            ]
        }
    """

    message: str
    has_paginate: int
    total_data: int
    current_page: int
    from_: int
    to: int
    per_page: int
    results: list[MarketInfo]

OrderBookItem

Bases: TypedDict

Order Book Item.

Attributes:

Name Type Description
market_id int

Market ID.
each_price str

Each price.
available_amount str

Available amount.

Examples:

>>> OrderBookItem(
...     market_id=1, each_price="each_price", available_amount="available_amount"
... )
{
    'market_id': 1,
    'each_price': 'each_price',
    'available_amount': 'available_amount'
}
Source code in src/bit24/types/responses/order_book.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class OrderBookItem(TypedDict):
    """
    Order Book Item.

    Attributes:
        market_id (int): Market ID.
        each_price (str): Each price.
        available_amount (str): Available amount.

    Examples:
        >>> OrderBookItem(
        ...     market_id=1, each_price="each_price", available_amount="available_amount"
        ... )
        {
            'market_id': 1,
            'each_price': 'each_price',
            'available_amount': 'available_amount'
        }
    """

    market_id: int
    each_price: str
    available_amount: str

OrderBookResponse

Bases: TypedDict

Order Book Response.

Attributes:

Name Type Description
id int

ID.
market_symbol str

Market symbol.
buy_orders list[OrderBookItem]

Buy orders.
sell_orders list[OrderBookItem]

Sell orders.

Examples:

>>> OrderBookResponse(
...     id=1,
...     market_symbol="market_symbol",
...     buy_orders=[
...         OrderBookItem(
...             market_id=1,
...             each_price="each_price",
...             available_amount="available_amount",
...         )
...     ],
...     sell_orders=[
...         OrderBookItem(
...             market_id=1,
...             each_price="each_price",
...             available_amount="available_amount",
...         )
...     ],
... )
{
    'id': 1,
    'market_symbol': 'market_symbol',
    'buy_orders': [
        {
            'market_id': 1,
            'each_price': 'each_price',
            'available_amount': 'available_amount'
        }
    ],
    'sell_orders': [
        {
            'market_id': 1,
            'each_price': 'each_price',
            'available_amount': 'available_amount'
        }
    ]
}
Source code in src/bit24/types/responses/order_book.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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
class OrderBookResponse(TypedDict):
    """
    Order Book Response.

    Attributes:
        id (int): ID.
        market_symbol (str): Market symbol.
        buy_orders (list[OrderBookItem]): Buy orders.
        sell_orders (list[OrderBookItem]): Sell orders.

    Examples:
        >>> OrderBookResponse(
        ...     id=1,
        ...     market_symbol="market_symbol",
        ...     buy_orders=[
        ...         OrderBookItem(
        ...             market_id=1,
        ...             each_price="each_price",
        ...             available_amount="available_amount",
        ...         )
        ...     ],
        ...     sell_orders=[
        ...         OrderBookItem(
        ...             market_id=1,
        ...             each_price="each_price",
        ...             available_amount="available_amount",
        ...         )
        ...     ],
        ... )
        {
            'id': 1,
            'market_symbol': 'market_symbol',
            'buy_orders': [
                {
                    'market_id': 1,
                    'each_price': 'each_price',
                    'available_amount': 'available_amount'
                }
            ],
            'sell_orders': [
                {
                    'market_id': 1,
                    'each_price': 'each_price',
                    'available_amount': 'available_amount'
                }
            ]
        }
    """

    id: int
    market_symbol: str
    buy_orders: list[OrderBookItem]
    sell_orders: list[OrderBookItem]

OrderInfo

Bases: TypedDict

Order Information.

Attributes:

Name Type Description
id int

ID.
type int

Type.
each_price str

Each price.
stop_price str

Stop price.
trigger_price str

Trigger price.
amount str

Amount.
available_amount str

Available amount.
done_value str

Done value.
done_percent str

Done percent.
mean_value int

Mean value.
commission str

Commission.
total str

Total.
created_at str

Created at.
created_at_jalali str

Created at jalali.
base_coin CoinInfo

Base coin.
quote_coin CoinInfo

Quote coin.
status int

Status.
status_text str

Status text.
category_type str

Category type.
category_type_text str

Category type text.
conditions str

Conditions.
triggered_category_type str

Triggered category type.
is_trade int

Is trade.

Examples:

>>> OrderInfo(
...     id=1,
...     type=1,
...     each_price="each_price",
...     stop_price="stop_price",
...     trigger_price="trigger_price",
...     amount="amount",
...     available_amount="available_amount",
...     done_value="done_value",
...     done_percent="done_percent",
...     mean_value=1,
...     commission="commission",
...     total="total",
...     created_at="created_at",
...     created_at_jalali="created_at_jalali",
...     base_coin=CoinInfo(
...         id=1,
...         symbol="symbol",
...         name="name",
...         fa_name="fa_name",
...         web_icon="web_icon",
...         app_icon="app_icon",
...     ),
...     quote_coin=CoinInfo(
...         id=1,
...         symbol="symbol",
...         name="name",
...         fa_name="fa_name",
...         web_icon="web_icon",
...         app_icon="app_icon",
...     ),
...     status=1,
...     status_text="status_text",
...     category_type="category_type",
...     category_type_text="category_type_text",
...     conditions="conditions",
...     triggered_category_type="triggered_category_type",
...     is_trade=1,
... )
{
    "id": 1,
    "type": 1,
    "each_price": "each_price",
    "stop_price": "stop_price",
    "trigger_price": "trigger_price",
    "amount": "amount",
    "available_amount": "available_amount",
    "done_value": "done_value",
    "done_percent": "done_percent",
    "mean_value": 1,
    "commission": "commission",
    "total": "total",
    "created_at": "created_at",
    "created_at_jalali": "created_at_jalali",
    "base_coin": {
        "id": 1,
        "symbol": "symbol",
        "name": "name",
        "fa_name": "fa_name",
        "web_icon": "web_icon",
        "app_icon": "app_icon"
    },
    "quote_coin": {
        "id": 1,
        "symbol": "symbol",
        "name": "name",
        "fa_name": "fa_name",
        "web_icon": "web_icon",
        "app_icon": "app_icon"
    },
    "status": 1,
    "status_text": "status_text",
    "category_type": "category_type",
    "category_type_text": "category_type_text",
    "conditions": "conditions",
    "triggered_category_type": "triggered_category_type",
    "is_trade": 1
}
Source code in src/bit24/types/responses/create_order.py 
 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
 62
 63
 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
class OrderInfo(TypedDict):
    """
    Order Information.

    Attributes:
        id (int): ID.
        type (int): Type.
        each_price (str): Each price.
        stop_price (str): Stop price.
        trigger_price (str): Trigger price.
        amount (str): Amount.
        available_amount (str): Available amount.
        done_value (str): Done value.
        done_percent (str): Done percent.
        mean_value (int): Mean value.
        commission (str): Commission.
        total (str): Total.
        created_at (str): Created at.
        created_at_jalali (str): Created at jalali.
        base_coin (CoinInfo): Base coin.
        quote_coin (CoinInfo): Quote coin.
        status (int): Status.
        status_text (str): Status text.
        category_type (str): Category type.
        category_type_text (str): Category type text.
        conditions (str): Conditions.
        triggered_category_type (str): Triggered category type.
        is_trade (int): Is trade.

    Examples:
        >>> OrderInfo(
        ...     id=1,
        ...     type=1,
        ...     each_price="each_price",
        ...     stop_price="stop_price",
        ...     trigger_price="trigger_price",
        ...     amount="amount",
        ...     available_amount="available_amount",
        ...     done_value="done_value",
        ...     done_percent="done_percent",
        ...     mean_value=1,
        ...     commission="commission",
        ...     total="total",
        ...     created_at="created_at",
        ...     created_at_jalali="created_at_jalali",
        ...     base_coin=CoinInfo(
        ...         id=1,
        ...         symbol="symbol",
        ...         name="name",
        ...         fa_name="fa_name",
        ...         web_icon="web_icon",
        ...         app_icon="app_icon",
        ...     ),
        ...     quote_coin=CoinInfo(
        ...         id=1,
        ...         symbol="symbol",
        ...         name="name",
        ...         fa_name="fa_name",
        ...         web_icon="web_icon",
        ...         app_icon="app_icon",
        ...     ),
        ...     status=1,
        ...     status_text="status_text",
        ...     category_type="category_type",
        ...     category_type_text="category_type_text",
        ...     conditions="conditions",
        ...     triggered_category_type="triggered_category_type",
        ...     is_trade=1,
        ... )
        {
            "id": 1,
            "type": 1,
            "each_price": "each_price",
            "stop_price": "stop_price",
            "trigger_price": "trigger_price",
            "amount": "amount",
            "available_amount": "available_amount",
            "done_value": "done_value",
            "done_percent": "done_percent",
            "mean_value": 1,
            "commission": "commission",
            "total": "total",
            "created_at": "created_at",
            "created_at_jalali": "created_at_jalali",
            "base_coin": {
                "id": 1,
                "symbol": "symbol",
                "name": "name",
                "fa_name": "fa_name",
                "web_icon": "web_icon",
                "app_icon": "app_icon"
            },
            "quote_coin": {
                "id": 1,
                "symbol": "symbol",
                "name": "name",
                "fa_name": "fa_name",
                "web_icon": "web_icon",
                "app_icon": "app_icon"
            },
            "status": 1,
            "status_text": "status_text",
            "category_type": "category_type",
            "category_type_text": "category_type_text",
            "conditions": "conditions",
            "triggered_category_type": "triggered_category_type",
            "is_trade": 1
        }
    """

    id: int
    type: int
    each_price: str
    stop_price: str
    trigger_price: str
    amount: str
    available_amount: str
    done_value: str
    done_percent: str
    mean_value: int
    commission: str
    total: str
    created_at: str
    created_at_jalali: str
    base_coin: CoinInfo
    quote_coin: CoinInfo
    status: int
    status_text: str
    category_type: str
    category_type_text: str
    conditions: str
    triggered_category_type: str
    is_trade: int

OrdersHistoryResponse

Bases: TypedDict

Orders History Response.

Attributes:

Name Type Description
message str

Message.
has_paginate int

Has paginate.
total_data int

Total data.
current_page int

Current page.
from_ int

From.
to( int

To.
per_page int

Per page.
results list[OrderInfo]

Results.

Examples:

>>> OrdersHistoryResponse(
...     message="message",
...     has_paginate=1,
...     total_data=1,
...     current_page=1,
...     from_=1,
...     to=1,
...     per_page=1,
...     results=[...],  # OrderInfo
... )
{
    'message': 'message',
    'has_paginate': 1,
    'total_data': 1,
    'current_page': 1,
    'from_': 1,
    'to': 1,
    'per_page': 1,
    'results': [...] # OrderInfo
}
Source code in src/bit24/types/responses/orders_history.py 
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
62
class OrdersHistoryResponse(TypedDict):
    """
    Orders History Response.

    Attributes:
        message (str): Message.
        has_paginate (int): Has paginate.
        total_data (int): Total data.
        current_page (int): Current page.
        from_ (int): From.
        to( int): To.
        per_page (int): Per page.
        results (list[OrderInfo]): Results.

    Examples:
        >>> OrdersHistoryResponse(
        ...     message="message",
        ...     has_paginate=1,
        ...     total_data=1,
        ...     current_page=1,
        ...     from_=1,
        ...     to=1,
        ...     per_page=1,
        ...     results=[...],  # OrderInfo
        ... )
        {
            'message': 'message',
            'has_paginate': 1,
            'total_data': 1,
            'current_page': 1,
            'from_': 1,
            'to': 1,
            'per_page': 1,
            'results': [...] # OrderInfo
        }
    """

    message: str
    has_paginate: int
    total_data: int
    current_page: int
    from_: int
    to: int
    per_page: int
    results: list[OrderInfo]

SubmitWithdrawResponse

Bases: TypedDict

Submit Withdraw Response.

Attributes:

Name Type Description
message str

Message.

Examples:

>>> SubmitWithdrawResponse(message="message")
{
    'message': 'message'
}
Source code in src/bit24/types/responses/submit_withdraw.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class SubmitWithdrawResponse(TypedDict):
    """
    Submit Withdraw Response.

    Attributes:
        message (str): Message.

    Examples:
        >>> SubmitWithdrawResponse(message="message")
        {
            'message': 'message'
        }
    """

    message: str

Transaction

Bases: TypedDict

Transaction.

Attributes:

Name Type Description
id int

ID.
name str

Name.
fa_name str

Fa name.
symbol str

Symbol.
logo str

Logo.
value str

Value.
done_value str

Done value.
type int

Type.
transaction_code str

Transaction code.
type_text str

Type text.
reason_type str

Reason type.
reason_text str

Reason text.
reason_type_text str

Reason type text.
reason_id int

Reason ID.
balance_status int

Balance status.
balance_status_text str

Balance status text.
commission int

Commission.
created_at str

Created at.
created_at_jalali str

Created at jalali.

Examples:

>>> Transaction(
...     id=1,
...     name="name",
...     fa_name="fa_name",
...     symbol="symbol",
...     logo="logo",
...     value="value",
...     done_value="done_value",
...     type=1,
...     transaction_code="transaction_code",
...     type_text="type_text",
...     reason_type="reason_type",
...     reason_text="reason_text",
...     reason_type_text="reason_type_text",
...     reason_id=1,
...     balance_status=1,
...     balance_status_text="balance_status_text",
...     commission=1,
...     created_at="created_at",
...     created_at_jalali="created_at_jalali",
... )
{
    "id": 1,
    "name": "name",
    "fa_name": "fa_name",
    "symbol": "symbol",
    "logo": "logo",
    "value": "value",
    "done_value": "done_value",
    "type": 1,
    "transaction_code": "transaction_code",
    "type_text": "type_text",
    "reason_type": "reason_type",
    "reason_text": "reason_text",
    "reason_type_text": "reason_type_text",
    "reason_id": 1,
    "balance_status": 1,
    "balance_status_text": "balance_status_text",
    "commission": 1,
    "created_at": "created_at",
    "created_at_jalali": "created_at_jalali"
}
Source code in src/bit24/types/responses/assets_history.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
 62
 63
 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
class Transaction(TypedDict):
    """
    Transaction.

    Attributes:
        id (int): ID.
        name (str): Name.
        fa_name (str): Fa name.
        symbol (str): Symbol.
        logo (str): Logo.
        value (str): Value.
        done_value (str): Done value.
        type (int): Type.
        transaction_code (str): Transaction code.
        type_text (str): Type text.
        reason_type (str): Reason type.
        reason_text (str): Reason text.
        reason_type_text (str): Reason type text.
        reason_id (int): Reason ID.
        balance_status (int): Balance status.
        balance_status_text (str): Balance status text.
        commission (int): Commission.
        created_at (str): Created at.
        created_at_jalali (str): Created at jalali.

    Examples:
        >>> Transaction(
        ...     id=1,
        ...     name="name",
        ...     fa_name="fa_name",
        ...     symbol="symbol",
        ...     logo="logo",
        ...     value="value",
        ...     done_value="done_value",
        ...     type=1,
        ...     transaction_code="transaction_code",
        ...     type_text="type_text",
        ...     reason_type="reason_type",
        ...     reason_text="reason_text",
        ...     reason_type_text="reason_type_text",
        ...     reason_id=1,
        ...     balance_status=1,
        ...     balance_status_text="balance_status_text",
        ...     commission=1,
        ...     created_at="created_at",
        ...     created_at_jalali="created_at_jalali",
        ... )
        {
            "id": 1,
            "name": "name",
            "fa_name": "fa_name",
            "symbol": "symbol",
            "logo": "logo",
            "value": "value",
            "done_value": "done_value",
            "type": 1,
            "transaction_code": "transaction_code",
            "type_text": "type_text",
            "reason_type": "reason_type",
            "reason_text": "reason_text",
            "reason_type_text": "reason_type_text",
            "reason_id": 1,
            "balance_status": 1,
            "balance_status_text": "balance_status_text",
            "commission": 1,
            "created_at": "created_at",
            "created_at_jalali": "created_at_jalali"
        }
    """

    id: int
    name: str
    fa_name: str
    symbol: str
    logo: str
    value: str
    done_value: str
    type: int
    transaction_code: str
    type_text: str
    reason_type: str
    reason_text: str
    reason_type_text: str
    reason_id: int
    balance_status: int
    balance_status_text: str
    commission: int
    created_at: str
    created_at_jalali: str

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]