Skip to content

markets_info

Markets Info

This module contains the type hints for the response of the markets endpoint.

Classes:

  • MarketInfo: A TypedDict that represents the structure of the market information.
  • MarketListResponse: A TypedDict that represents the structure of the market list response.

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]