Skip to content

create_order

Create Order Response

This module contains the response class for the Create Order API.

Classes:

  • OrderInfo: A TypedDict that represents the structure of the order information
  • CreateOrderResponse: A TypedDict that represents the structure of the create order response

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

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