Skip to content

orders_history

Orders History Response

This module contains the type definitions for the response of the orders history endpoint.

Classes

  • OrdersHistoryResponse: A TypedDict that represents the structure of the orders history response.

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]