Skip to content

order_book

Order Book Response

This file contains the Order Book Response.

Classes:

  • OrderBookItem: A TypedDict that represents the structure of the order book item.
  • OrderBookResponse: A TypedDict that represents the structure of the order book response.

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]