Skip to content

Client

cyhole.birdeye.client

BirdeyeClient 

BirdeyeClient(
    interaction: Birdeye, headers: Any | None = None
)

Bases: APIClient


              flowchart TD
              cyhole.birdeye.client.BirdeyeClient[BirdeyeClient]
              cyhole.core.client.APIClient[APIClient]
              cyhole.core.client.APIClientInterface[APIClientInterface]

                              cyhole.core.client.APIClient --> cyhole.birdeye.client.BirdeyeClient
                                cyhole.core.client.APIClientInterface --> cyhole.core.client.APIClient
                



              click cyhole.birdeye.client.BirdeyeClient href "" "cyhole.birdeye.client.BirdeyeClient"
              click cyhole.core.client.APIClient href "" "cyhole.core.client.APIClient"
              click cyhole.core.client.APIClientInterface href "" "cyhole.core.client.APIClientInterface"

Client used for synchronous API calls for Birdeye interaction.

Source code in src/cyhole/birdeye/client.py 
86
87
88
def __init__(self, interaction: Birdeye, headers: Any | None = None) -> None:
    super().__init__(interaction, headers)
    self._interaction: Birdeye = self._interaction

get_token_list 

get_token_list(
    sort_by: str = BirdeyeSort.SORT_V24HUSD.value,
    order_by: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
    min_liquidity: float | None = None,
    max_liquidity: float | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenListResponse

Call the Birdeye's PUBLIC API endpoint Token - List (V1) for synchronous logic. All the API endpoint details are available on Birdeye._get_token_list.

Source code in src/cyhole/birdeye/client.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def get_token_list(
    self,
    sort_by: str = BirdeyeSort.SORT_V24HUSD.value,
    order_by: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
    min_liquidity: float | None = None,
    max_liquidity: float | None = None,
    ui_amount_mode: str | None = None
) -> GetTokenListResponse:
    """
        Call the Birdeye's **PUBLIC** API endpoint **[Token - List (V1)](https://docs.birdeye.so/reference/get-defi-tokenlist)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_list`][cyhole.birdeye.interaction.Birdeye._get_token_list].
    """
    return self._interaction._get_token_list(True, sort_by, order_by, offset, limit, min_liquidity, max_liquidity, ui_amount_mode)

get_v3_token_list 

get_v3_token_list(
    query: GetV3TokenListQuery | None = None,
) -> GetV3TokenListResponse

Call the Birdeye's PRIVATE API endpoint Token - List (V3) for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_list.

Source code in src/cyhole/birdeye/client.py 
113
114
115
116
117
118
def get_v3_token_list(self, query: GetV3TokenListQuery | None = None) -> GetV3TokenListResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - List (V3)](https://docs.birdeye.so/reference/get-defi-v3-token-list)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_list`][cyhole.birdeye.interaction.Birdeye._get_v3_token_list].
    """
    return self._interaction._get_v3_token_list(True, query)

get_v3_token_list_scroll 

get_v3_token_list_scroll(
    query: GetV3TokenListScrollQuery | None = None,
) -> GetV3TokenListScrollResponse

Call the Birdeye's PRIVATE API endpoint Token - List (V3) Scroll for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_list_scroll.

Source code in src/cyhole/birdeye/client.py 
120
121
122
123
124
125
def get_v3_token_list_scroll(self, query: GetV3TokenListScrollQuery | None = None) -> GetV3TokenListScrollResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - List (V3) Scroll](https://docs.birdeye.so/reference/get-defi-v3-token-list-scroll)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_list_scroll`][cyhole.birdeye.interaction.Birdeye._get_v3_token_list_scroll].
    """
    return self._interaction._get_v3_token_list_scroll(True, query)

get_v2_tokens_new_listing 

get_v2_tokens_new_listing(
    time_to: int | None = None,
    limit: int | None = None,
    meme_platform_enabled: bool | None = None,
) -> GetV2TokensNewListingResponse

Call the Birdeye's PRIVATE API endpoint Token - New Listing for synchronous logic. All the API endpoint details are available on Birdeye._get_v2_tokens_new_listing.

Source code in src/cyhole/birdeye/client.py 
127
128
129
130
131
132
133
134
135
136
137
def get_v2_tokens_new_listing(
    self,
    time_to: int | None = None,
    limit: int | None = None,
    meme_platform_enabled: bool | None = None
) -> GetV2TokensNewListingResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - New Listing](https://docs.birdeye.so/reference/get-defi-v2-tokens-new_listing)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v2_tokens_new_listing`][cyhole.birdeye.interaction.Birdeye._get_v2_tokens_new_listing].
    """
    return self._interaction._get_v2_tokens_new_listing(True, time_to, limit, meme_platform_enabled)

get_v2_markets 

get_v2_markets(
    address: str,
    sort_by: str = BirdeyeV2MarketsSortBy.LIQUIDITY.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
) -> GetV2MarketsResponse

Call the Birdeye's PRIVATE API endpoint Token - All Market List for synchronous logic. All the API endpoint details are available on Birdeye._get_v2_markets.

Source code in src/cyhole/birdeye/client.py 
139
140
141
142
143
144
145
146
147
148
149
150
151
def get_v2_markets(
    self,
    address: str,
    sort_by: str = BirdeyeV2MarketsSortBy.LIQUIDITY.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None
) -> GetV2MarketsResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - All Market List](https://docs.birdeye.so/reference/get-defi-v2-markets)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v2_markets`][cyhole.birdeye.interaction.Birdeye._get_v2_markets].
    """
    return self._interaction._get_v2_markets(True, address, sort_by, sort_type, offset, limit)

get_v3_token_meta_data 

get_v3_token_meta_data(
    address: str,
) -> GetV3TokenMetaDataResponse

get_v3_token_meta_data(
    address: list[str],
) -> GetV3TokenMetaDataMultipleResponse

get_v3_token_meta_data(
    address: str | list[str],
) -> (
    GetV3TokenMetaDataResponse
    | GetV3TokenMetaDataMultipleResponse
)

Call the Birdeye's PRIVATE v3 Token - Metadata endpoints (single / multiple) for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_meta_data.

Source code in src/cyhole/birdeye/client.py 
159
160
161
162
163
164
165
def get_v3_token_meta_data(self, address: str | list[str]) -> GetV3TokenMetaDataResponse | GetV3TokenMetaDataMultipleResponse:
    """
        Call the Birdeye's **PRIVATE** v3 Token - Metadata endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-token-meta-data-single)** /
        **[multiple](https://docs.birdeye.so/reference/get-defi-v3-token-meta-data-multiple)**) for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_meta_data`][cyhole.birdeye.interaction.Birdeye._get_v3_token_meta_data].
    """
    return self._interaction._get_v3_token_meta_data(True, address)

get_v3_token_market_data 

get_v3_token_market_data(
    address: str, ui_amount_mode: str | None = None
) -> GetV3TokenMarketDataResponse

get_v3_token_market_data(
    address: list[str], ui_amount_mode: str | None = None
) -> GetV3TokenMarketDataMultipleResponse

get_v3_token_market_data(
    address: str | list[str],
    ui_amount_mode: str | None = None,
) -> (
    GetV3TokenMarketDataResponse
    | GetV3TokenMarketDataMultipleResponse
)

Call the Birdeye's PRIVATE v3 Token - Market Data endpoints (single / multiple) for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_market_data.

Source code in src/cyhole/birdeye/client.py 
173
174
175
176
177
178
179
def get_v3_token_market_data(self, address: str | list[str], ui_amount_mode: str | None = None) -> GetV3TokenMarketDataResponse | GetV3TokenMarketDataMultipleResponse:
    """
        Call the Birdeye's **PRIVATE** v3 Token - Market Data endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-token-market-data)** /
        **[multiple](https://docs.birdeye.so/reference/get-defi-v3-token-market-data-multiple)**) for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_market_data`][cyhole.birdeye.interaction.Birdeye._get_v3_token_market_data].
    """
    return self._interaction._get_v3_token_market_data(True, address, ui_amount_mode)

get_v3_token_trade_data 

get_v3_token_trade_data(
    address: str,
    frames: str | None = None,
    ui_amount_mode: str | None = None,
) -> GetV3TokenTradeDataResponse

get_v3_token_trade_data(
    address: list[str],
    frames: str | None = None,
    ui_amount_mode: str | None = None,
) -> GetV3TokenTradeDataMultipleResponse

get_v3_token_trade_data(
    address: str | list[str],
    frames: str | None = None,
    ui_amount_mode: str | None = None,
) -> (
    GetV3TokenTradeDataResponse
    | GetV3TokenTradeDataMultipleResponse
)

Call the Birdeye's PRIVATE v3 Token - Trade Data endpoints (single / multiple) for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_trade_data.

Source code in src/cyhole/birdeye/client.py 
187
188
189
190
191
192
193
def get_v3_token_trade_data(self, address: str | list[str], frames: str | None = None, ui_amount_mode: str | None = None) -> GetV3TokenTradeDataResponse | GetV3TokenTradeDataMultipleResponse:
    """
        Call the Birdeye's **PRIVATE** v3 Token - Trade Data endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-token-trade-data-single)** /
        **[multiple](https://docs.birdeye.so/reference/get-defi-v3-token-trade-data-multiple)**) for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_trade_data`][cyhole.birdeye.interaction.Birdeye._get_v3_token_trade_data].
    """
    return self._interaction._get_v3_token_trade_data(True, address, frames, ui_amount_mode)

get_v3_token_exit_liquidity 

get_v3_token_exit_liquidity(
    address: str,
) -> GetV3TokenExitLiquidityResponse

get_v3_token_exit_liquidity(
    address: list[str],
) -> GetV3TokenExitLiquidityMultipleResponse

get_v3_token_exit_liquidity(
    address: str | list[str],
) -> (
    GetV3TokenExitLiquidityResponse
    | GetV3TokenExitLiquidityMultipleResponse
)

Call the Birdeye's PRIVATE v3 Token - Liquidity endpoints (single / multiple) for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_exit_liquidity.

Source code in src/cyhole/birdeye/client.py 
201
202
203
204
205
206
207
def get_v3_token_exit_liquidity(self, address: str | list[str]) -> GetV3TokenExitLiquidityResponse | GetV3TokenExitLiquidityMultipleResponse:
    """
        Call the Birdeye's **PRIVATE** v3 Token - Liquidity endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-token-exit-liquidity)** /
        **[multiple](https://docs.birdeye.so/reference/get-defi-v3-token-exit-liquidity-multiple)**) for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_exit_liquidity`][cyhole.birdeye.interaction.Birdeye._get_v3_token_exit_liquidity].
    """
    return self._interaction._get_v3_token_exit_liquidity(True, address)

get_v3_token_mint_burn_txs 

get_v3_token_mint_burn_txs(
    address: str,
    type: str = BirdeyeMintBurnType.ALL.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    after_time: int | None = None,
    before_time: int | None = None,
    offset: int | None = None,
    limit: int | None = None,
) -> GetV3TokenMintBurnTxsResponse

Call the Birdeye's PRIVATE API endpoint Token - Mint/Burn for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_mint_burn_txs.

Source code in src/cyhole/birdeye/client.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def get_v3_token_mint_burn_txs(
    self,
    address: str,
    type: str = BirdeyeMintBurnType.ALL.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    after_time: int | None = None,
    before_time: int | None = None,
    offset: int | None = None,
    limit: int | None = None
) -> GetV3TokenMintBurnTxsResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Mint/Burn](https://docs.birdeye.so/reference/get-defi-v3-token-mint-burn-txs)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_mint_burn_txs`][cyhole.birdeye.interaction.Birdeye._get_v3_token_mint_burn_txs].
    """
    return self._interaction._get_v3_token_mint_burn_txs(True, address, type, sort_type, after_time, before_time, offset, limit)

get_v2_tokens_top_traders 

get_v2_tokens_top_traders(
    address: str,
    time_frame: str = BirdeyeV2TopTradersTimeFrame.H24.value,
    sort_by: str = BirdeyeV2TopTradersSortBy.VOLUME.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> GetV2TopTradersResponse

Call the Birdeye's PRIVATE API endpoint Token - Top Traders for synchronous logic. All the API endpoint details are available on Birdeye._get_v2_tokens_top_traders.

Source code in src/cyhole/birdeye/client.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
def get_v2_tokens_top_traders(
    self,
    address: str,
    time_frame: str = BirdeyeV2TopTradersTimeFrame.H24.value,
    sort_by: str = BirdeyeV2TopTradersSortBy.VOLUME.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None
) -> GetV2TopTradersResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Top Traders](https://docs.birdeye.so/reference/get-defi-v2-tokens-top_traders)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v2_tokens_top_traders`][cyhole.birdeye.interaction.Birdeye._get_v2_tokens_top_traders].
    """
    return self._interaction._get_v2_tokens_top_traders(True, address, time_frame, sort_by, sort_type, offset, limit, ui_amount_mode)

get_token_holder 

get_token_holder(
    token_address: str,
    wallets: None = None,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenHolderResponse

get_token_holder(
    token_address: str,
    wallets: list[str],
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> PostTokenHolderBatchResponse

get_token_holder(
    token_address: str,
    wallets: list[str] | None = None,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenHolderResponse | PostTokenHolderBatchResponse

Call the Birdeye's PRIVATE Token Holder endpoints (top-holder ranking / batch balance lookup) for synchronous logic. All the API endpoint details are available on Birdeye._get_token_holder.

Source code in src/cyhole/birdeye/client.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
def get_token_holder(
    self,
    token_address: str,
    wallets: list[str] | None = None,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None
) -> GetTokenHolderResponse | PostTokenHolderBatchResponse:
    """
        Call the Birdeye's **PRIVATE** Token Holder endpoints (**[top-holder ranking](https://docs.birdeye.so/reference/get-defi-v3-token-holder)** /
        **[batch balance lookup](https://docs.birdeye.so/reference/post-token-v1-holder-batch)**) for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_holder`][cyhole.birdeye.interaction.Birdeye._get_token_holder].
    """
    return self._interaction._get_token_holder(True, token_address, wallets, offset, limit, ui_amount_mode)

get_holder_distribution 

get_holder_distribution(
    token_address: str,
    address_type: str = BirdeyeHolderDistributionAddressType.WALLET.value,
    mode: str = BirdeyeHolderDistributionMode.TOP.value,
    top_n: int | None = None,
    min_percent: float | None = None,
    max_percent: float | None = None,
    include_list: bool | None = None,
    offset: int | None = None,
    limit: int | None = None,
) -> GetHolderDistributionResponse

Call the Birdeye's PRIVATE API endpoint Token - Holder Distribution for synchronous logic. All the API endpoint details are available on Birdeye._get_holder_distribution.

Source code in src/cyhole/birdeye/client.py 
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
def get_holder_distribution(
    self,
    token_address: str,
    address_type: str = BirdeyeHolderDistributionAddressType.WALLET.value,
    mode: str = BirdeyeHolderDistributionMode.TOP.value,
    top_n: int | None = None,
    min_percent: float | None = None,
    max_percent: float | None = None,
    include_list: bool | None = None,
    offset: int | None = None,
    limit: int | None = None
) -> GetHolderDistributionResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Holder Distribution](https://docs.birdeye.so/reference/get-holder-v1-distribution)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_holder_distribution`][cyhole.birdeye.interaction.Birdeye._get_holder_distribution].
    """
    return self._interaction._get_holder_distribution(True, token_address, address_type, mode, top_n, min_percent, max_percent, include_list, offset, limit)

get_token_holder_profile 

get_token_holder_profile(
    token_address: str,
    interval: str = "1h",
    ui_amount_mode: str | None = None,
    include_zero_balance: bool | None = None,
) -> GetHolderProfileResponse

Call the Birdeye's PRIVATE API endpoint Token - Holder Profile for synchronous logic. All the API endpoint details are available on Birdeye._get_token_holder_profile.

Source code in src/cyhole/birdeye/client.py 
280
281
282
283
284
285
286
287
288
289
290
291
def get_token_holder_profile(
    self,
    token_address: str,
    interval: str = "1h",
    ui_amount_mode: str | None = None,
    include_zero_balance: bool | None = None
) -> GetHolderProfileResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Holder Profile](https://docs.birdeye.so/reference/get-token-v1-holder-profile)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_holder_profile`][cyhole.birdeye.interaction.Birdeye._get_token_holder_profile].
    """
    return self._interaction._get_token_holder_profile(True, token_address, interval, ui_amount_mode, include_zero_balance)

get_token_holder_positions 

get_token_holder_positions(
    token_address: str,
    labels: str | None = None,
    order_type: str = BirdeyeOrder.DESCENDING.value,
    ui_amount_mode: str | None = None,
    include_zero_balance: bool | None = None,
    offset: int | None = None,
    limit: int | None = None,
) -> GetTokenHolderPositionsResponse

Call the Birdeye's PRIVATE API endpoint Token - Holder Positions for synchronous logic. All the API endpoint details are available on Birdeye._get_token_holder_positions.

Source code in src/cyhole/birdeye/client.py 
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
def get_token_holder_positions(
    self,
    token_address: str,
    labels: str | None = None,
    order_type: str = BirdeyeOrder.DESCENDING.value,
    ui_amount_mode: str | None = None,
    include_zero_balance: bool | None = None,
    offset: int | None = None,
    limit: int | None = None
) -> GetTokenHolderPositionsResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Holder Positions](https://docs.birdeye.so/reference/get-token-v1-holder-positions)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_holder_positions`][cyhole.birdeye.interaction.Birdeye._get_token_holder_positions].
    """
    return self._interaction._get_token_holder_positions(True, token_address, labels, order_type, ui_amount_mode, include_zero_balance, offset, limit)

get_token_holder_chart 

get_token_holder_chart(
    token_address: str,
    chart_type: str = BirdeyeHolderChartType.H1.value,
    time_from: int | None = None,
    time_to: int | None = None,
    mode: str = BirdeyeHolderChartMode.PADDING.value,
    percent_mode: str = BirdeyeHolderChartPercentMode.BEGINNING.value,
    count: int | None = None,
) -> GetTokenHolderChartResponse

Call the Birdeye's PRIVATE API endpoint Token - Holder Chart for synchronous logic. All the API endpoint details are available on Birdeye._get_token_holder_chart.

Source code in src/cyhole/birdeye/client.py 
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
def get_token_holder_chart(
    self,
    token_address: str,
    chart_type: str = BirdeyeHolderChartType.H1.value,
    time_from: int | None = None,
    time_to: int | None = None,
    mode: str = BirdeyeHolderChartMode.PADDING.value,
    percent_mode: str = BirdeyeHolderChartPercentMode.BEGINNING.value,
    count: int | None = None
) -> GetTokenHolderChartResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Holder Chart](https://docs.birdeye.so/reference/get-token-v1-holder-chart)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_holder_chart`][cyhole.birdeye.interaction.Birdeye._get_token_holder_chart].
    """
    return self._interaction._get_token_holder_chart(True, token_address, chart_type, time_from, time_to, mode, percent_mode, count)

post_token_transfer 

post_token_transfer(
    body: PostTokenTransferBody,
) -> PostTokenTransferResponse

Call the Birdeye's PRIVATE API endpoint Token - Transfer List for synchronous logic. All the API endpoint details are available on Birdeye._post_token_transfer.

Source code in src/cyhole/birdeye/client.py 
325
326
327
328
329
330
def post_token_transfer(self, body: PostTokenTransferBody) -> PostTokenTransferResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Transfer List](https://docs.birdeye.so/reference/post-token-v1-transfer)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._post_token_transfer`][cyhole.birdeye.interaction.Birdeye._post_token_transfer].
    """
    return self._interaction._post_token_transfer(True, body)

post_token_transfer_total 

post_token_transfer_total(
    body: PostTokenTransferTotalBody,
) -> PostTokenTransferTotalResponse

Call the Birdeye's PRIVATE API endpoint Token - Transfer Total for synchronous logic. All the API endpoint details are available on Birdeye._post_token_transfer_total.

Source code in src/cyhole/birdeye/client.py 
332
333
334
335
336
337
def post_token_transfer_total(self, body: PostTokenTransferTotalBody) -> PostTokenTransferTotalResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Transfer Total](https://docs.birdeye.so/reference/post-token-v1-transfer-total)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._post_token_transfer_total`][cyhole.birdeye.interaction.Birdeye._post_token_transfer_total].
    """
    return self._interaction._post_token_transfer_total(True, body)

get_token_trending(
    sort_by: str = BirdeyeTokenTrendingSortBy.RANK.value,
    sort_type: str = BirdeyeOrder.ASCENDING.value,
    interval: str = BirdeyeTokenTrendingInterval.H24.value,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenTrendingResponse

Call the Birdeye's PRIVATE API endpoint Token - Trending List for synchronous logic. All the API endpoint details are available on Birdeye._get_token_trending.

Source code in src/cyhole/birdeye/client.py 
339
340
341
342
343
344
345
346
347
348
349
350
351
352
def get_token_trending(
    self,
    sort_by: str = BirdeyeTokenTrendingSortBy.RANK.value,
    sort_type: str = BirdeyeOrder.ASCENDING.value,
    interval: str = BirdeyeTokenTrendingInterval.H24.value,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None
) -> GetTokenTrendingResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Trending List](https://docs.birdeye.so/reference/get-defi-token_trending)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_trending`][cyhole.birdeye.interaction.Birdeye._get_token_trending].
    """
    return self._interaction._get_token_trending(True, sort_by, sort_type, interval, offset, limit, ui_amount_mode)

get_token_creation_info 

get_token_creation_info(
    address: str,
) -> GetTokenCreationInfoResponse

Call the Birdeye's PRIVATE API endpoint Token - Creation Token Info for synchronous logic. All the API endpoint details are available on Birdeye._get_token_creation_info.

Source code in src/cyhole/birdeye/client.py 
354
355
356
357
358
359
def get_token_creation_info(self, address: str) -> GetTokenCreationInfoResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Creation Token Info](https://docs.birdeye.so/reference/get-defi-token_creation_info)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_creation_info`][cyhole.birdeye.interaction.Birdeye._get_token_creation_info].
    """
    return self._interaction._get_token_creation_info(True, address)

get_token_security 

get_token_security(
    address: str,
) -> GetTokenSecurityResponse

Call the Birdeye's PRIVATE API endpoint Token - Security for synchronous logic. All the API endpoint details are available on Birdeye._get_token_security.

Source code in src/cyhole/birdeye/client.py 
361
362
363
364
365
366
def get_token_security(self, address: str) -> GetTokenSecurityResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Security](https://docs.birdeye.so/reference/get-defi-token_security)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_security`][cyhole.birdeye.interaction.Birdeye._get_token_security].
    """
    return self._interaction._get_token_security(True, address)

get_token_overview 

get_token_overview(
    address: str,
    frames: str | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenOverviewResponse

Call the Birdeye's PRIVATE API endpoint Token - Overview for synchronous logic. All the API endpoint details are available on Birdeye._get_token_overview.

Source code in src/cyhole/birdeye/client.py 
368
369
370
371
372
373
374
375
376
377
378
def get_token_overview(
    self,
    address: str,
    frames: str | None = None,
    ui_amount_mode: str | None = None
) -> GetTokenOverviewResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Overview](https://docs.birdeye.so/reference/get-defi-token_overview)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_overview`][cyhole.birdeye.interaction.Birdeye._get_token_overview].
    """
    return self._interaction._get_token_overview(True, address, frames, ui_amount_mode)

get_price 

get_price(
    address: str, include_liquidity: bool | None = None
) -> GetPriceResponse

Call the Birdeye's PUBLIC API endpoint Price for synchronous logic. All the API endopint details are available on Birdeye._get_price.

Source code in src/cyhole/birdeye/client.py 
380
381
382
383
384
385
def get_price(self, address: str, include_liquidity: bool | None = None) -> GetPriceResponse:
    """
        Call the Birdeye's **PUBLIC** API endpoint **[Price](https://docs.birdeye.so/reference/get_defi-price)** for synchronous logic. 
        All the API endopint details are available on [`Birdeye._get_price`][cyhole.birdeye.interaction.Birdeye._get_price].
    """
    return self._interaction._get_price(True, address, include_liquidity)

get_price_multiple 

get_price_multiple(
    list_address: list[str],
    include_liquidity: bool | None = None,
) -> GetPriceMultipleResponse

Call the Birdeye's PUBLIC API endpoint Price - Multiple for synchronous logic. All the API endopint details are available on Birdeye._get_price_multiple.

Source code in src/cyhole/birdeye/client.py 
387
388
389
390
391
392
def get_price_multiple(self, list_address: list[str], include_liquidity: bool | None = None) -> GetPriceMultipleResponse:
    """
        Call the Birdeye's **PUBLIC** API endpoint **[Price - Multiple](https://docs.birdeye.so/reference/get_defi-multi-price)** for synchronous logic. 
        All the API endopint details are available on [`Birdeye._get_price_multiple`][cyhole.birdeye.interaction.Birdeye._get_price_multiple].
    """
    return self._interaction._get_price_multiple(True, list_address, include_liquidity)

get_price_historical 

get_price_historical(
    address: str,
    address_type: str,
    timeframe: str,
    dt_from: datetime,
    dt_to: datetime | None = None,
) -> GetPriceHistoricalResponse

Call the Birdeye's PUBLIC API endpoint Price - Historical for synchronous logic. All the API endopint details are available on Birdeye._get_price_historical.

Source code in src/cyhole/birdeye/client.py 
394
395
396
397
398
399
def get_price_historical(self, address: str, address_type: str, timeframe: str, dt_from: datetime, dt_to: datetime | None = None) -> GetPriceHistoricalResponse:
    """
        Call the Birdeye's **PUBLIC** API endpoint **[Price - Historical](https://docs.birdeye.so/reference/get_defi-history-price)** for synchronous logic. 
        All the API endopint details are available on [`Birdeye._get_price_historical`][cyhole.birdeye.interaction.Birdeye._get_price_historical].
    """
    return self._interaction._get_price_historical(True, address, address_type, timeframe, dt_from, dt_to)

get_price_volume_single 

get_price_volume_single(
    address: str,
    timeframe: str = BirdeyeHourTimeFrame.H24.value,
) -> GetPriceVolumeSingleResponse

Call the Birdeye's PRIVATE API endpoint Price Volume - Single Token for synchronous logic. All the API endopint details are available on Birdeye._get_price_volume_single.

Source code in src/cyhole/birdeye/client.py 
401
402
403
404
405
406
def get_price_volume_single(self, address: str, timeframe: str = BirdeyeHourTimeFrame.H24.value) -> GetPriceVolumeSingleResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Price Volume - Single Token](https://docs.birdeye.so/reference/get_defi-price-volume-single)** for synchronous logic. 
        All the API endopint details are available on [`Birdeye._get_price_volume_single`][cyhole.birdeye.interaction.Birdeye._get_price_volume_single].
    """
    return self._interaction._get_price_volume_single(True, address, timeframe)

post_price_volume_multi 

post_price_volume_multi(
    list_address: list[str],
    timeframe: str = BirdeyeHourTimeFrame.H24.value,
) -> PostPriceVolumeMultiResponse

Call the Birdeye's PRIVATE API endpoint Price Volume - Multiple Token for synchronous logic. All the API endopint details are available on Birdeye._post_price_volume_multi.

Source code in src/cyhole/birdeye/client.py 
408
409
410
411
412
413
def post_price_volume_multi(self, list_address: list[str], timeframe: str = BirdeyeHourTimeFrame.H24.value) -> PostPriceVolumeMultiResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Price Volume - Multiple Token](https://docs.birdeye.so/reference/get_defi-price-volume-single)** for synchronous logic. 
        All the API endopint details are available on [`Birdeye._post_price_volume_multi`][cyhole.birdeye.interaction.Birdeye._post_price_volume_multi].
    """
    return self._interaction._post_price_volume_multi(True, list_address, timeframe)

get_trades_token 

get_trades_token(
    address: str,
    trade_type: str = BirdeyeTradeType.SWAP.value,
    offset: int | None = None,
    limit: int | None = None,
) -> GetTradesTokenResponse

Call the Birdeye's PRIVATE API endpoint Trades - Token for synchronous logic. All the API endopint details are available on Birdeye._get_trades_token.

Source code in src/cyhole/birdeye/client.py 
415
416
417
418
419
420
def get_trades_token(self, address: str, trade_type: str = BirdeyeTradeType.SWAP.value, offset: int | None = None, limit: int | None = None) -> GetTradesTokenResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Trades - Token](https://docs.birdeye.so/reference/get_defi-txs-token)** for synchronous logic. 
        All the API endopint details are available on [`Birdeye._get_trades_token`][cyhole.birdeye.interaction.Birdeye._get_trades_token].
    """
    return self._interaction._get_trades_token(True, address, trade_type, offset, limit)

get_trades_pair 

get_trades_pair(
    address: str,
    trade_type: str = BirdeyeTradeType.SWAP.value,
    order_by: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
) -> GetTradesPairResponse

Call the Birdeye's PRIVATE API endpoint Trades - Pair for synchronous logic. All the API endopint details are available on Birdeye._get_trades_pair.

Source code in src/cyhole/birdeye/client.py 
422
423
424
425
426
427
def get_trades_pair(self, address: str, trade_type: str = BirdeyeTradeType.SWAP.value, order_by: str = BirdeyeOrder.DESCENDING.value, offset: int | None = None, limit: int | None = None) -> GetTradesPairResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Trades - Pair](https://docs.birdeye.so/reference/get_defi-txs-pair)** for synchronous logic. 
        All the API endopint details are available on [`Birdeye._get_trades_pair`][cyhole.birdeye.interaction.Birdeye._get_trades_pair].
    """
    return self._interaction._get_trades_pair(True, address, trade_type, order_by, offset, limit)

get_ohlcv 

get_ohlcv(
    address: str,
    address_type: str,
    timeframe: str,
    dt_from: datetime,
    dt_to: datetime | None = None,
) -> GetOHLCVTokenPairResponse

Call the Birdeye's PRIVATE API endpoint OHLCV - Token/Pair for synchronous logic. All the API endopint details are available on Birdeye._get_ohlcv.

Source code in src/cyhole/birdeye/client.py 
429
430
431
432
433
434
def get_ohlcv(self, address: str, address_type: str, timeframe: str, dt_from: datetime, dt_to: datetime | None = None) -> GetOHLCVTokenPairResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[OHLCV - Token/Pair](https://docs.birdeye.so/reference/get_defi-ohlcv)** for synchronous logic. 
        All the API endopint details are available on [`Birdeye._get_ohlcv`][cyhole.birdeye.interaction.Birdeye._get_ohlcv].
    """
    return self._interaction._get_ohlcv(True, address, address_type, timeframe, dt_from, dt_to)

get_ohlcv_base_quote 

get_ohlcv_base_quote(
    base_address: str,
    quote_address: str,
    timeframe: str,
    dt_from: datetime,
    dt_to: datetime | None = None,
) -> GetOHLCVBaseQuoteResponse

Call the Birdeye's PRIVATE API endpoint OHLCV - Base/Quote for synchronous logic. All the API endopint details are available on Birdeye._get_ohlcv_base_quote.

Source code in src/cyhole/birdeye/client.py 
436
437
438
439
440
441
def get_ohlcv_base_quote(self, base_address: str, quote_address: str, timeframe: str, dt_from: datetime, dt_to: datetime | None = None) -> GetOHLCVBaseQuoteResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[OHLCV - Base/Quote](https://docs.birdeye.so/reference/get_defi-ohlcv-base-quote)** for synchronous logic. 
        All the API endopint details are available on [`Birdeye._get_ohlcv_base_quote`][cyhole.birdeye.interaction.Birdeye._get_ohlcv_base_quote].
    """
    return self._interaction._get_ohlcv_base_quote(True, base_address, quote_address, timeframe, dt_from, dt_to)

get_wallet_supported_networks 

get_wallet_supported_networks() -> (
    GetWalletSupportedNetworksResponse
)

Call the Birdeye's PRIVATE API endpoint Wallet - Supported Networks for synchronous logic. All the API endopint details are available on Birdeye._get_wallet_supported_networks.

Source code in src/cyhole/birdeye/client.py 
443
444
445
446
447
448
def get_wallet_supported_networks(self) -> GetWalletSupportedNetworksResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Wallet - Supported Networks](https://docs.birdeye.so/reference/get_v1-wallet-list-supported-chain)** for synchronous logic.
        All the API endopint details are available on [`Birdeye._get_wallet_supported_networks`][cyhole.birdeye.interaction.Birdeye._get_wallet_supported_networks].
    """
    return self._interaction._get_wallet_supported_networks(True)

get_v3_search(
    query: GetV3SearchQuery | None = None,
) -> GetV3SearchResponse

Call the Birdeye's PRIVATE API endpoint Search for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_search.

Source code in src/cyhole/birdeye/client.py 
450
451
452
453
454
455
def get_v3_search(self, query: GetV3SearchQuery | None = None) -> GetV3SearchResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Search](https://docs.birdeye.so/reference/get-defi-v3-search)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_search`][cyhole.birdeye.interaction.Birdeye._get_v3_search].
    """
    return self._interaction._get_v3_search(True, query)

get_utils_v1_credits 

get_utils_v1_credits(
    time_from: int | None = None, time_to: int | None = None
) -> GetUtilsV1CreditsResponse

Call the Birdeye's PRIVATE API endpoint Utils - Credits for synchronous logic. All the API endpoint details are available on Birdeye._get_utils_v1_credits.

Source code in src/cyhole/birdeye/client.py 
457
458
459
460
461
462
def get_utils_v1_credits(self, time_from: int | None = None, time_to: int | None = None) -> GetUtilsV1CreditsResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Utils - Credits](https://docs.birdeye.so/reference/get-utils-v1-credits)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_utils_v1_credits`][cyhole.birdeye.interaction.Birdeye._get_utils_v1_credits].
    """
    return self._interaction._get_utils_v1_credits(True, time_from, time_to)

get_v3_all_time_trades 

get_v3_all_time_trades(
    address: str | list[str],
    time_frame: str = BirdeyeAllTimeTradesTimeFrame.ALL_TIME.value,
    ui_amount_mode: str | None = None,
) -> GetV3AllTimeTradesResponse

Call the Birdeye's PRIVATE v3 All-Time Trades endpoints (single / multiple) for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_all_time_trades.

Source code in src/cyhole/birdeye/client.py 
464
465
466
467
468
469
470
471
472
473
474
475
def get_v3_all_time_trades(
    self,
    address: str | list[str],
    time_frame: str = BirdeyeAllTimeTradesTimeFrame.ALL_TIME.value,
    ui_amount_mode: str | None = None
) -> GetV3AllTimeTradesResponse:
    """
        Call the Birdeye's **PRIVATE** v3 All-Time Trades endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-all-time-trades-single)** /
        **[multiple](https://docs.birdeye.so/reference/post-defi-v3-all-time-trades-multiple)**) for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_all_time_trades`][cyhole.birdeye.interaction.Birdeye._get_v3_all_time_trades].
    """
    return self._interaction._get_v3_all_time_trades(True, address, time_frame, ui_amount_mode)

get_v3_token_meme_detail_single 

get_v3_token_meme_detail_single(
    address: str,
) -> GetV3TokenMemeDetailSingleResponse

Call the Birdeye's PRIVATE API endpoint Meme Token Detail - Single for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_meme_detail_single.

Source code in src/cyhole/birdeye/client.py 
477
478
479
480
481
482
def get_v3_token_meme_detail_single(self, address: str) -> GetV3TokenMemeDetailSingleResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Meme Token Detail - Single](https://docs.birdeye.so/reference/get-defi-v3-token-meme-detail-single)** for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_meme_detail_single`][cyhole.birdeye.interaction.Birdeye._get_v3_token_meme_detail_single].
    """
    return self._interaction._get_v3_token_meme_detail_single(True, address)

get_v3_token_meme_list 

get_v3_token_meme_list(
    query: GetV3TokenMemeListQuery | None = None,
) -> GetV3TokenMemeListResponse

Call the Birdeye's GET Meme Token - List API endpoint for synchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_meme_list.

Source code in src/cyhole/birdeye/client.py 
484
485
486
487
488
489
def get_v3_token_meme_list(self, query: GetV3TokenMemeListQuery | None = None) -> GetV3TokenMemeListResponse:
    """
        Call the Birdeye's GET **[Meme Token - List](https://docs.birdeye.so/reference/get-defi-v3-token-meme-list)** API endpoint for synchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_meme_list`][cyhole.birdeye.interaction.Birdeye._get_v3_token_meme_list].
    """
    return self._interaction._get_v3_token_meme_list(True, query)

BirdeyeAsyncClient 

BirdeyeAsyncClient(
    interaction: Birdeye, headers: Any | None = None
)

Bases: AsyncAPIClient


              flowchart TD
              cyhole.birdeye.client.BirdeyeAsyncClient[BirdeyeAsyncClient]
              cyhole.core.client.AsyncAPIClient[AsyncAPIClient]
              cyhole.core.client.APIClientInterface[APIClientInterface]

                              cyhole.core.client.AsyncAPIClient --> cyhole.birdeye.client.BirdeyeAsyncClient
                                cyhole.core.client.APIClientInterface --> cyhole.core.client.AsyncAPIClient
                



              click cyhole.birdeye.client.BirdeyeAsyncClient href "" "cyhole.birdeye.client.BirdeyeAsyncClient"
              click cyhole.core.client.AsyncAPIClient href "" "cyhole.core.client.AsyncAPIClient"
              click cyhole.core.client.APIClientInterface href "" "cyhole.core.client.APIClientInterface"

Client used for asynchronous API calls for Birdeye interaction.

Source code in src/cyhole/birdeye/client.py 
496
497
498
def __init__(self, interaction: Birdeye, headers: Any | None = None) -> None:
    super().__init__(interaction, headers)
    self._interaction: Birdeye = self._interaction

get_token_list async 

get_token_list(
    sort_by: str = BirdeyeSort.SORT_V24HUSD.value,
    order_by: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
    min_liquidity: float | None = None,
    max_liquidity: float | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenListResponse

Call the Birdeye's PUBLIC API endpoint Token - List (V1) for asynchronous logic. All the API endpoint details are available on Birdeye._get_token_list.

Source code in src/cyhole/birdeye/client.py 
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
async def get_token_list(
    self,
    sort_by: str = BirdeyeSort.SORT_V24HUSD.value,
    order_by: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
    min_liquidity: float | None = None,
    max_liquidity: float | None = None,
    ui_amount_mode: str | None = None
) -> GetTokenListResponse:
    """
        Call the Birdeye's **PUBLIC** API endpoint **[Token - List (V1)](https://docs.birdeye.so/reference/get-defi-tokenlist)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_list`][cyhole.birdeye.interaction.Birdeye._get_token_list].
    """
    return await self._interaction._get_token_list(False, sort_by, order_by, offset, limit, min_liquidity, max_liquidity, ui_amount_mode)

get_v3_token_list async 

get_v3_token_list(
    query: GetV3TokenListQuery | None = None,
) -> GetV3TokenListResponse

Call the Birdeye's PRIVATE API endpoint Token - List (V3) for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_list.

Source code in src/cyhole/birdeye/client.py 
523
524
525
526
527
528
async def get_v3_token_list(self, query: GetV3TokenListQuery | None = None) -> GetV3TokenListResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - List (V3)](https://docs.birdeye.so/reference/get-defi-v3-token-list)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_list`][cyhole.birdeye.interaction.Birdeye._get_v3_token_list].
    """
    return await self._interaction._get_v3_token_list(False, query)

get_v3_token_list_scroll async 

get_v3_token_list_scroll(
    query: GetV3TokenListScrollQuery | None = None,
) -> GetV3TokenListScrollResponse

Call the Birdeye's PRIVATE API endpoint Token - List (V3) Scroll for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_list_scroll.

Source code in src/cyhole/birdeye/client.py 
530
531
532
533
534
535
async def get_v3_token_list_scroll(self, query: GetV3TokenListScrollQuery | None = None) -> GetV3TokenListScrollResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - List (V3) Scroll](https://docs.birdeye.so/reference/get-defi-v3-token-list-scroll)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_list_scroll`][cyhole.birdeye.interaction.Birdeye._get_v3_token_list_scroll].
    """
    return await self._interaction._get_v3_token_list_scroll(False, query)

get_v2_tokens_new_listing async 

get_v2_tokens_new_listing(
    time_to: int | None = None,
    limit: int | None = None,
    meme_platform_enabled: bool | None = None,
) -> GetV2TokensNewListingResponse

Call the Birdeye's PRIVATE API endpoint Token - New Listing for asynchronous logic. All the API endpoint details are available on Birdeye._get_v2_tokens_new_listing.

Source code in src/cyhole/birdeye/client.py 
537
538
539
540
541
542
543
544
545
546
547
async def get_v2_tokens_new_listing(
    self,
    time_to: int | None = None,
    limit: int | None = None,
    meme_platform_enabled: bool | None = None
) -> GetV2TokensNewListingResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - New Listing](https://docs.birdeye.so/reference/get-defi-v2-tokens-new_listing)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v2_tokens_new_listing`][cyhole.birdeye.interaction.Birdeye._get_v2_tokens_new_listing].
    """
    return await self._interaction._get_v2_tokens_new_listing(False, time_to, limit, meme_platform_enabled)

get_v2_markets async 

get_v2_markets(
    address: str,
    sort_by: str = BirdeyeV2MarketsSortBy.LIQUIDITY.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
) -> GetV2MarketsResponse

Call the Birdeye's PRIVATE API endpoint Token - All Market List for asynchronous logic. All the API endpoint details are available on Birdeye._get_v2_markets.

Source code in src/cyhole/birdeye/client.py 
549
550
551
552
553
554
555
556
557
558
559
560
561
async def get_v2_markets(
    self,
    address: str,
    sort_by: str = BirdeyeV2MarketsSortBy.LIQUIDITY.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None
) -> GetV2MarketsResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - All Market List](https://docs.birdeye.so/reference/get-defi-v2-markets)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v2_markets`][cyhole.birdeye.interaction.Birdeye._get_v2_markets].
    """
    return await self._interaction._get_v2_markets(False, address, sort_by, sort_type, offset, limit)

get_v3_token_meta_data async 

get_v3_token_meta_data(
    address: str,
) -> GetV3TokenMetaDataResponse

get_v3_token_meta_data(
    address: list[str],
) -> GetV3TokenMetaDataMultipleResponse

get_v3_token_meta_data(
    address: str | list[str],
) -> (
    GetV3TokenMetaDataResponse
    | GetV3TokenMetaDataMultipleResponse
)

Call the Birdeye's PRIVATE v3 Token - Metadata endpoints (single / multiple) for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_meta_data.

Source code in src/cyhole/birdeye/client.py 
569
570
571
572
573
574
575
async def get_v3_token_meta_data(self, address: str | list[str]) -> GetV3TokenMetaDataResponse | GetV3TokenMetaDataMultipleResponse:
    """
        Call the Birdeye's **PRIVATE** v3 Token - Metadata endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-token-meta-data-single)** /
        **[multiple](https://docs.birdeye.so/reference/get-defi-v3-token-meta-data-multiple)**) for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_meta_data`][cyhole.birdeye.interaction.Birdeye._get_v3_token_meta_data].
    """
    return await self._interaction._get_v3_token_meta_data(False, address)

get_v3_token_market_data async 

get_v3_token_market_data(
    address: str, ui_amount_mode: str | None = None
) -> GetV3TokenMarketDataResponse

get_v3_token_market_data(
    address: list[str], ui_amount_mode: str | None = None
) -> GetV3TokenMarketDataMultipleResponse

get_v3_token_market_data(
    address: str | list[str],
    ui_amount_mode: str | None = None,
) -> (
    GetV3TokenMarketDataResponse
    | GetV3TokenMarketDataMultipleResponse
)

Call the Birdeye's PRIVATE v3 Token - Market Data endpoints (single / multiple) for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_market_data.

Source code in src/cyhole/birdeye/client.py 
583
584
585
586
587
588
589
async def get_v3_token_market_data(self, address: str | list[str], ui_amount_mode: str | None = None) -> GetV3TokenMarketDataResponse | GetV3TokenMarketDataMultipleResponse:
    """
        Call the Birdeye's **PRIVATE** v3 Token - Market Data endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-token-market-data)** /
        **[multiple](https://docs.birdeye.so/reference/get-defi-v3-token-market-data-multiple)**) for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_market_data`][cyhole.birdeye.interaction.Birdeye._get_v3_token_market_data].
    """
    return await self._interaction._get_v3_token_market_data(False, address, ui_amount_mode)

get_v3_token_trade_data async 

get_v3_token_trade_data(
    address: str,
    frames: str | None = None,
    ui_amount_mode: str | None = None,
) -> GetV3TokenTradeDataResponse

get_v3_token_trade_data(
    address: list[str],
    frames: str | None = None,
    ui_amount_mode: str | None = None,
) -> GetV3TokenTradeDataMultipleResponse

get_v3_token_trade_data(
    address: str | list[str],
    frames: str | None = None,
    ui_amount_mode: str | None = None,
) -> (
    GetV3TokenTradeDataResponse
    | GetV3TokenTradeDataMultipleResponse
)

Call the Birdeye's PRIVATE v3 Token - Trade Data endpoints (single / multiple) for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_trade_data.

Source code in src/cyhole/birdeye/client.py 
597
598
599
600
601
602
603
async def get_v3_token_trade_data(self, address: str | list[str], frames: str | None = None, ui_amount_mode: str | None = None) -> GetV3TokenTradeDataResponse | GetV3TokenTradeDataMultipleResponse:
    """
        Call the Birdeye's **PRIVATE** v3 Token - Trade Data endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-token-trade-data-single)** /
        **[multiple](https://docs.birdeye.so/reference/get-defi-v3-token-trade-data-multiple)**) for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_trade_data`][cyhole.birdeye.interaction.Birdeye._get_v3_token_trade_data].
    """
    return await self._interaction._get_v3_token_trade_data(False, address, frames, ui_amount_mode)

get_v3_token_exit_liquidity async 

get_v3_token_exit_liquidity(
    address: str,
) -> GetV3TokenExitLiquidityResponse

get_v3_token_exit_liquidity(
    address: list[str],
) -> GetV3TokenExitLiquidityMultipleResponse

get_v3_token_exit_liquidity(
    address: str | list[str],
) -> (
    GetV3TokenExitLiquidityResponse
    | GetV3TokenExitLiquidityMultipleResponse
)

Call the Birdeye's PRIVATE v3 Token - Liquidity endpoints (single / multiple) for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_exit_liquidity.

Source code in src/cyhole/birdeye/client.py 
611
612
613
614
615
616
617
async def get_v3_token_exit_liquidity(self, address: str | list[str]) -> GetV3TokenExitLiquidityResponse | GetV3TokenExitLiquidityMultipleResponse:
    """
        Call the Birdeye's **PRIVATE** v3 Token - Liquidity endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-token-exit-liquidity)** /
        **[multiple](https://docs.birdeye.so/reference/get-defi-v3-token-exit-liquidity-multiple)**) for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_exit_liquidity`][cyhole.birdeye.interaction.Birdeye._get_v3_token_exit_liquidity].
    """
    return await self._interaction._get_v3_token_exit_liquidity(False, address)

get_v3_token_mint_burn_txs async 

get_v3_token_mint_burn_txs(
    address: str,
    type: str = BirdeyeMintBurnType.ALL.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    after_time: int | None = None,
    before_time: int | None = None,
    offset: int | None = None,
    limit: int | None = None,
) -> GetV3TokenMintBurnTxsResponse

Call the Birdeye's PRIVATE API endpoint Token - Mint/Burn for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_mint_burn_txs.

Source code in src/cyhole/birdeye/client.py 
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
async def get_v3_token_mint_burn_txs(
    self,
    address: str,
    type: str = BirdeyeMintBurnType.ALL.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    after_time: int | None = None,
    before_time: int | None = None,
    offset: int | None = None,
    limit: int | None = None
) -> GetV3TokenMintBurnTxsResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Mint/Burn](https://docs.birdeye.so/reference/get-defi-v3-token-mint-burn-txs)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_mint_burn_txs`][cyhole.birdeye.interaction.Birdeye._get_v3_token_mint_burn_txs].
    """
    return await self._interaction._get_v3_token_mint_burn_txs(False, address, type, sort_type, after_time, before_time, offset, limit)

get_v2_tokens_top_traders async 

get_v2_tokens_top_traders(
    address: str,
    time_frame: str = BirdeyeV2TopTradersTimeFrame.H24.value,
    sort_by: str = BirdeyeV2TopTradersSortBy.VOLUME.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> GetV2TopTradersResponse

Call the Birdeye's PRIVATE API endpoint Token - Top Traders for asynchronous logic. All the API endpoint details are available on Birdeye._get_v2_tokens_top_traders.

Source code in src/cyhole/birdeye/client.py 
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
async def get_v2_tokens_top_traders(
    self,
    address: str,
    time_frame: str = BirdeyeV2TopTradersTimeFrame.H24.value,
    sort_by: str = BirdeyeV2TopTradersSortBy.VOLUME.value,
    sort_type: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None
) -> GetV2TopTradersResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Top Traders](https://docs.birdeye.so/reference/get-defi-v2-tokens-top_traders)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v2_tokens_top_traders`][cyhole.birdeye.interaction.Birdeye._get_v2_tokens_top_traders].
    """
    return await self._interaction._get_v2_tokens_top_traders(False, address, time_frame, sort_by, sort_type, offset, limit, ui_amount_mode)

get_token_holder async 

get_token_holder(
    token_address: str,
    wallets: None = None,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenHolderResponse

get_token_holder(
    token_address: str,
    wallets: list[str],
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> PostTokenHolderBatchResponse

get_token_holder(
    token_address: str,
    wallets: list[str] | None = None,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenHolderResponse | PostTokenHolderBatchResponse

Call the Birdeye's PRIVATE Token Holder endpoints (top-holder ranking / batch balance lookup) for asynchronous logic. All the API endpoint details are available on Birdeye._get_token_holder.

Source code in src/cyhole/birdeye/client.py 
657
658
659
660
661
662
663
664
665
666
667
668
669
670
async def get_token_holder(
    self,
    token_address: str,
    wallets: list[str] | None = None,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None
) -> GetTokenHolderResponse | PostTokenHolderBatchResponse:
    """
        Call the Birdeye's **PRIVATE** Token Holder endpoints (**[top-holder ranking](https://docs.birdeye.so/reference/get-defi-v3-token-holder)** /
        **[batch balance lookup](https://docs.birdeye.so/reference/post-token-v1-holder-batch)**) for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_holder`][cyhole.birdeye.interaction.Birdeye._get_token_holder].
    """
    return await self._interaction._get_token_holder(False, token_address, wallets, offset, limit, ui_amount_mode)

get_holder_distribution async 

get_holder_distribution(
    token_address: str,
    address_type: str = BirdeyeHolderDistributionAddressType.WALLET.value,
    mode: str = BirdeyeHolderDistributionMode.TOP.value,
    top_n: int | None = None,
    min_percent: float | None = None,
    max_percent: float | None = None,
    include_list: bool | None = None,
    offset: int | None = None,
    limit: int | None = None,
) -> GetHolderDistributionResponse

Call the Birdeye's PRIVATE API endpoint Token - Holder Distribution for asynchronous logic. All the API endpoint details are available on Birdeye._get_holder_distribution.

Source code in src/cyhole/birdeye/client.py 
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
async def get_holder_distribution(
    self,
    token_address: str,
    address_type: str = BirdeyeHolderDistributionAddressType.WALLET.value,
    mode: str = BirdeyeHolderDistributionMode.TOP.value,
    top_n: int | None = None,
    min_percent: float | None = None,
    max_percent: float | None = None,
    include_list: bool | None = None,
    offset: int | None = None,
    limit: int | None = None
) -> GetHolderDistributionResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Holder Distribution](https://docs.birdeye.so/reference/get-holder-v1-distribution)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_holder_distribution`][cyhole.birdeye.interaction.Birdeye._get_holder_distribution].
    """
    return await self._interaction._get_holder_distribution(False, token_address, address_type, mode, top_n, min_percent, max_percent, include_list, offset, limit)

get_token_holder_profile async 

get_token_holder_profile(
    token_address: str,
    interval: str = "1h",
    ui_amount_mode: str | None = None,
    include_zero_balance: bool | None = None,
) -> GetHolderProfileResponse

Call the Birdeye's PRIVATE API endpoint Token - Holder Profile for asynchronous logic. All the API endpoint details are available on Birdeye._get_token_holder_profile.

Source code in src/cyhole/birdeye/client.py 
690
691
692
693
694
695
696
697
698
699
700
701
async def get_token_holder_profile(
    self,
    token_address: str,
    interval: str = "1h",
    ui_amount_mode: str | None = None,
    include_zero_balance: bool | None = None
) -> GetHolderProfileResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Holder Profile](https://docs.birdeye.so/reference/get-token-v1-holder-profile)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_holder_profile`][cyhole.birdeye.interaction.Birdeye._get_token_holder_profile].
    """
    return await self._interaction._get_token_holder_profile(False, token_address, interval, ui_amount_mode, include_zero_balance)

get_token_holder_positions async 

get_token_holder_positions(
    token_address: str,
    labels: str | None = None,
    order_type: str = BirdeyeOrder.DESCENDING.value,
    ui_amount_mode: str | None = None,
    include_zero_balance: bool | None = None,
    offset: int | None = None,
    limit: int | None = None,
) -> GetTokenHolderPositionsResponse

Call the Birdeye's PRIVATE API endpoint Token - Holder Positions for asynchronous logic. All the API endpoint details are available on Birdeye._get_token_holder_positions.

Source code in src/cyhole/birdeye/client.py 
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
async def get_token_holder_positions(
    self,
    token_address: str,
    labels: str | None = None,
    order_type: str = BirdeyeOrder.DESCENDING.value,
    ui_amount_mode: str | None = None,
    include_zero_balance: bool | None = None,
    offset: int | None = None,
    limit: int | None = None
) -> GetTokenHolderPositionsResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Holder Positions](https://docs.birdeye.so/reference/get-token-v1-holder-positions)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_holder_positions`][cyhole.birdeye.interaction.Birdeye._get_token_holder_positions].
    """
    return await self._interaction._get_token_holder_positions(False, token_address, labels, order_type, ui_amount_mode, include_zero_balance, offset, limit)

get_token_holder_chart async 

get_token_holder_chart(
    token_address: str,
    chart_type: str = BirdeyeHolderChartType.H1.value,
    time_from: int | None = None,
    time_to: int | None = None,
    mode: str = BirdeyeHolderChartMode.PADDING.value,
    percent_mode: str = BirdeyeHolderChartPercentMode.BEGINNING.value,
    count: int | None = None,
) -> GetTokenHolderChartResponse

Call the Birdeye's PRIVATE API endpoint Token - Holder Chart for asynchronous logic. All the API endpoint details are available on Birdeye._get_token_holder_chart.

Source code in src/cyhole/birdeye/client.py 
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
async def get_token_holder_chart(
    self,
    token_address: str,
    chart_type: str = BirdeyeHolderChartType.H1.value,
    time_from: int | None = None,
    time_to: int | None = None,
    mode: str = BirdeyeHolderChartMode.PADDING.value,
    percent_mode: str = BirdeyeHolderChartPercentMode.BEGINNING.value,
    count: int | None = None
) -> GetTokenHolderChartResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Holder Chart](https://docs.birdeye.so/reference/get-token-v1-holder-chart)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_holder_chart`][cyhole.birdeye.interaction.Birdeye._get_token_holder_chart].
    """
    return await self._interaction._get_token_holder_chart(False, token_address, chart_type, time_from, time_to, mode, percent_mode, count)

post_token_transfer async 

post_token_transfer(
    body: PostTokenTransferBody,
) -> PostTokenTransferResponse

Call the Birdeye's PRIVATE API endpoint Token - Transfer List for asynchronous logic. All the API endpoint details are available on Birdeye._post_token_transfer.

Source code in src/cyhole/birdeye/client.py 
735
736
737
738
739
740
async def post_token_transfer(self, body: PostTokenTransferBody) -> PostTokenTransferResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Transfer List](https://docs.birdeye.so/reference/post-token-v1-transfer)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._post_token_transfer`][cyhole.birdeye.interaction.Birdeye._post_token_transfer].
    """
    return await self._interaction._post_token_transfer(False, body)

post_token_transfer_total async 

post_token_transfer_total(
    body: PostTokenTransferTotalBody,
) -> PostTokenTransferTotalResponse

Call the Birdeye's PRIVATE API endpoint Token - Transfer Total for asynchronous logic. All the API endpoint details are available on Birdeye._post_token_transfer_total.

Source code in src/cyhole/birdeye/client.py 
742
743
744
745
746
747
async def post_token_transfer_total(self, body: PostTokenTransferTotalBody) -> PostTokenTransferTotalResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Transfer Total](https://docs.birdeye.so/reference/post-token-v1-transfer-total)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._post_token_transfer_total`][cyhole.birdeye.interaction.Birdeye._post_token_transfer_total].
    """
    return await self._interaction._post_token_transfer_total(False, body)

get_token_trending(
    sort_by: str = BirdeyeTokenTrendingSortBy.RANK.value,
    sort_type: str = BirdeyeOrder.ASCENDING.value,
    interval: str = BirdeyeTokenTrendingInterval.H24.value,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenTrendingResponse

Call the Birdeye's PRIVATE API endpoint Token - Trending List for asynchronous logic. All the API endpoint details are available on Birdeye._get_token_trending.

Source code in src/cyhole/birdeye/client.py 
749
750
751
752
753
754
755
756
757
758
759
760
761
762
async def get_token_trending(
    self,
    sort_by: str = BirdeyeTokenTrendingSortBy.RANK.value,
    sort_type: str = BirdeyeOrder.ASCENDING.value,
    interval: str = BirdeyeTokenTrendingInterval.H24.value,
    offset: int | None = None,
    limit: int | None = None,
    ui_amount_mode: str | None = None
) -> GetTokenTrendingResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Trending List](https://docs.birdeye.so/reference/get-defi-token_trending)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_trending`][cyhole.birdeye.interaction.Birdeye._get_token_trending].
    """
    return await self._interaction._get_token_trending(False, sort_by, sort_type, interval, offset, limit, ui_amount_mode)

get_token_creation_info async 

get_token_creation_info(
    address: str,
) -> GetTokenCreationInfoResponse

Call the Birdeye's PRIVATE API endpoint Token - Creation Token Info for asynchronous logic. All the API endpoint details are available on Birdeye._get_token_creation_info.

Source code in src/cyhole/birdeye/client.py 
764
765
766
767
768
769
async def get_token_creation_info(self, address: str) -> GetTokenCreationInfoResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Creation Token Info](https://docs.birdeye.so/reference/get-defi-token_creation_info)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_creation_info`][cyhole.birdeye.interaction.Birdeye._get_token_creation_info].
    """
    return await self._interaction._get_token_creation_info(False, address)

get_token_security async 

get_token_security(
    address: str,
) -> GetTokenSecurityResponse

Call the Birdeye's PRIVATE API endpoint Token - Security for asynchronous logic. All the API endpoint details are available on Birdeye._get_token_security.

Source code in src/cyhole/birdeye/client.py 
771
772
773
774
775
776
async def get_token_security(self, address: str) -> GetTokenSecurityResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Security](https://docs.birdeye.so/reference/get-defi-token_security)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_security`][cyhole.birdeye.interaction.Birdeye._get_token_security].
    """
    return await self._interaction._get_token_security(False, address)

get_token_overview async 

get_token_overview(
    address: str,
    frames: str | None = None,
    ui_amount_mode: str | None = None,
) -> GetTokenOverviewResponse

Call the Birdeye's PRIVATE API endpoint Token - Overview for asynchronous logic. All the API endpoint details are available on Birdeye._get_token_overview.

Source code in src/cyhole/birdeye/client.py 
778
779
780
781
782
783
784
785
786
787
788
async def get_token_overview(
    self,
    address: str,
    frames: str | None = None,
    ui_amount_mode: str | None = None
) -> GetTokenOverviewResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Token - Overview](https://docs.birdeye.so/reference/get-defi-token_overview)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_token_overview`][cyhole.birdeye.interaction.Birdeye._get_token_overview].
    """
    return await self._interaction._get_token_overview(False, address, frames, ui_amount_mode)

get_price async 

get_price(
    address: str, include_liquidity: bool | None = None
) -> GetPriceResponse

Call the Birdeye's PUBLIC API endpoint Price for asynchronous logic. All the API endopint details are available on Birdeye._get_price.

Source code in src/cyhole/birdeye/client.py 
790
791
792
793
794
795
async def get_price(self, address: str, include_liquidity: bool | None = None) -> GetPriceResponse:
    """
        Call the Birdeye's **PUBLIC** API endpoint **[Price](https://docs.birdeye.so/reference/get_defi-price)** for asynchronous logic. 
        All the API endopint details are available on [`Birdeye._get_price`][cyhole.birdeye.interaction.Birdeye._get_price].
    """
    return await self._interaction._get_price(False, address, include_liquidity)

get_price_multiple async 

get_price_multiple(
    list_address: list[str],
    include_liquidity: bool | None = None,
) -> GetPriceMultipleResponse

Call the Birdeye's PUBLIC API endpoint Price - Multiple for asynchronous logic. All the API endopint details are available on Birdeye._get_price_multiple.

Source code in src/cyhole/birdeye/client.py 
797
798
799
800
801
802
async def get_price_multiple(self, list_address: list[str], include_liquidity: bool | None = None) -> GetPriceMultipleResponse:
    """
        Call the Birdeye's **PUBLIC** API endpoint **[Price - Multiple](https://docs.birdeye.so/reference/get_defi-multi-price)** for asynchronous logic. 
        All the API endopint details are available on [`Birdeye._get_price_multiple`][cyhole.birdeye.interaction.Birdeye._get_price_multiple].
    """
    return await self._interaction._get_price_multiple(False, list_address, include_liquidity)

get_price_historical async 

get_price_historical(
    address: str,
    address_type: str,
    timeframe: str,
    dt_from: datetime,
    dt_to: datetime | None = None,
) -> GetPriceHistoricalResponse

Call the Birdeye's PUBLIC API endpoint Price - Historical for asynchronous logic. All the API endopint details are available on Birdeye._get_price_historical.

Source code in src/cyhole/birdeye/client.py 
804
805
806
807
808
809
async def get_price_historical(self, address: str, address_type: str, timeframe: str, dt_from: datetime, dt_to: datetime | None = None) -> GetPriceHistoricalResponse:
    """
        Call the Birdeye's **PUBLIC** API endpoint **[Price - Historical](https://docs.birdeye.so/reference/get_defi-history-price)** for asynchronous logic. 
        All the API endopint details are available on [`Birdeye._get_price_historical`][cyhole.birdeye.interaction.Birdeye._get_price_historical].
    """
    return await self._interaction._get_price_historical(False, address, address_type, timeframe, dt_from, dt_to)

get_price_volume_single async 

get_price_volume_single(
    address: str,
    timeframe: str = BirdeyeHourTimeFrame.H24.value,
) -> GetPriceVolumeSingleResponse

Call the Birdeye's PRIVATE API endpoint Price Volume - Single Token for asynchronous logic. All the API endopint details are available on Birdeye._get_price_volume_single.

Source code in src/cyhole/birdeye/client.py 
811
812
813
814
815
816
async def get_price_volume_single(self, address: str, timeframe: str = BirdeyeHourTimeFrame.H24.value) -> GetPriceVolumeSingleResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Price Volume - Single Token](https://docs.birdeye.so/reference/get_defi-price-volume-single)** for asynchronous logic. 
        All the API endopint details are available on [`Birdeye._get_price_volume_single`][cyhole.birdeye.interaction.Birdeye._get_price_volume_single].
    """
    return await self._interaction._get_price_volume_single(False, address, timeframe)

post_price_volume_multi async 

post_price_volume_multi(
    list_address: list[str],
    timeframe: str = BirdeyeHourTimeFrame.H24.value,
) -> PostPriceVolumeMultiResponse

Call the Birdeye's PRIVATE API endpoint Price Volume - Multiple Token for asynchronous logic. All the API endopint details are available on Birdeye._post_price_volume_multi.

Source code in src/cyhole/birdeye/client.py 
818
819
820
821
822
823
async def post_price_volume_multi(self, list_address: list[str], timeframe: str = BirdeyeHourTimeFrame.H24.value) -> PostPriceVolumeMultiResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Price Volume - Multiple Token](https://docs.birdeye.so/reference/get_defi-price-volume-single)** for asynchronous logic. 
        All the API endopint details are available on [`Birdeye._post_price_volume_multi`][cyhole.birdeye.interaction.Birdeye._post_price_volume_multi].
    """
    return await self._interaction._post_price_volume_multi(False, list_address, timeframe)

get_trades_token async 

get_trades_token(
    address: str,
    trade_type: str = BirdeyeTradeType.SWAP.value,
    offset: int | None = None,
    limit: int | None = None,
) -> GetTradesTokenResponse

Call the Birdeye's PRIVATE API endpoint Trades - Token for asynchronous logic. All the API endopint details are available on Birdeye._get_trades_token.

Source code in src/cyhole/birdeye/client.py 
825
826
827
828
829
830
async def get_trades_token(self, address: str, trade_type: str = BirdeyeTradeType.SWAP.value, offset: int | None = None, limit: int | None = None) -> GetTradesTokenResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Trades - Token](https://docs.birdeye.so/reference/get_defi-txs-token)** for asynchronous logic. 
        All the API endopint details are available on [`Birdeye._get_trades_token`][cyhole.birdeye.interaction.Birdeye._get_trades_token].
    """
    return await self._interaction._get_trades_token(False, address, trade_type, offset, limit)

get_trades_pair async 

get_trades_pair(
    address: str,
    trade_type: str = BirdeyeTradeType.SWAP.value,
    order_by: str = BirdeyeOrder.DESCENDING.value,
    offset: int | None = None,
    limit: int | None = None,
) -> GetTradesPairResponse

Call the Birdeye's PRIVATE API endpoint Trades - Pair for asynchronous logic. All the API endopint details are available on Birdeye._get_trades_pair.

Source code in src/cyhole/birdeye/client.py 
832
833
834
835
836
837
async def get_trades_pair(self, address: str, trade_type: str = BirdeyeTradeType.SWAP.value, order_by: str = BirdeyeOrder.DESCENDING.value, offset: int | None = None, limit: int | None = None) -> GetTradesPairResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Trades - Pair](https://docs.birdeye.so/reference/get_defi-txs-pair)** for asynchronous logic. 
        All the API endopint details are available on [`Birdeye._get_trades_pair`][cyhole.birdeye.interaction.Birdeye._get_trades_pair].
    """
    return await self._interaction._get_trades_pair(False, address, trade_type, order_by, offset, limit)

get_ohlcv async 

get_ohlcv(
    address: str,
    address_type: str,
    timeframe: str,
    dt_from: datetime,
    dt_to: datetime | None = None,
) -> GetOHLCVTokenPairResponse

Call the Birdeye's PRIVATE API endpoint OHLCV - Token/Pair for asynchronous logic. All the API endopint details are available on Birdeye._get_ohlcv.

Source code in src/cyhole/birdeye/client.py 
839
840
841
842
843
844
async def get_ohlcv(self, address: str, address_type: str, timeframe: str, dt_from: datetime, dt_to: datetime | None = None) -> GetOHLCVTokenPairResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[OHLCV - Token/Pair](https://docs.birdeye.so/reference/get_defi-ohlcv)** for asynchronous logic. 
        All the API endopint details are available on [`Birdeye._get_ohlcv`][cyhole.birdeye.interaction.Birdeye._get_ohlcv].
    """
    return await self._interaction._get_ohlcv(False, address, address_type, timeframe, dt_from, dt_to)

get_ohlcv_base_quote async 

get_ohlcv_base_quote(
    base_address: str,
    quote_address: str,
    timeframe: str,
    dt_from: datetime,
    dt_to: datetime | None = None,
) -> GetOHLCVBaseQuoteResponse

Call the Birdeye's PRIVATE API endpoint OHLCV - Base/Quote for asynchronous logic. All the API endopint details are available on Birdeye._get_ohlcv_base_quote.

Source code in src/cyhole/birdeye/client.py 
846
847
848
849
850
851
async def get_ohlcv_base_quote(self, base_address: str, quote_address: str, timeframe: str, dt_from: datetime, dt_to: datetime | None = None) -> GetOHLCVBaseQuoteResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[OHLCV - Base/Quote](https://docs.birdeye.so/reference/get_defi-ohlcv-base-quote)** for asynchronous logic. 
        All the API endopint details are available on [`Birdeye._get_ohlcv_base_quote`][cyhole.birdeye.interaction.Birdeye._get_ohlcv_base_quote].
    """
    return await self._interaction._get_ohlcv_base_quote(False, base_address, quote_address, timeframe, dt_from, dt_to)

get_wallet_supported_networks async 

get_wallet_supported_networks() -> (
    GetWalletSupportedNetworksResponse
)

Call the Birdeye's PRIVATE API endpoint Wallet - Supported Networks for asynchronous logic. All the API endopint details are available on Birdeye._get_wallet_supported_networks.

Source code in src/cyhole/birdeye/client.py 
853
854
855
856
857
858
async def get_wallet_supported_networks(self) -> GetWalletSupportedNetworksResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Wallet - Supported Networks](https://docs.birdeye.so/reference/get_v1-wallet-list-supported-chain)** for asynchronous logic.
        All the API endopint details are available on [`Birdeye._get_wallet_supported_networks`][cyhole.birdeye.interaction.Birdeye._get_wallet_supported_networks].
    """
    return await self._interaction._get_wallet_supported_networks(False)

get_v3_search(
    query: GetV3SearchQuery | None = None,
) -> GetV3SearchResponse

Call the Birdeye's PRIVATE API endpoint Search for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_search.

Source code in src/cyhole/birdeye/client.py 
860
861
862
863
864
865
async def get_v3_search(self, query: GetV3SearchQuery | None = None) -> GetV3SearchResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Search](https://docs.birdeye.so/reference/get-defi-v3-search)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_search`][cyhole.birdeye.interaction.Birdeye._get_v3_search].
    """
    return await self._interaction._get_v3_search(False, query)

get_utils_v1_credits async 

get_utils_v1_credits(
    time_from: int | None = None, time_to: int | None = None
) -> GetUtilsV1CreditsResponse

Call the Birdeye's PRIVATE API endpoint Utils - Credits for asynchronous logic. All the API endpoint details are available on Birdeye._get_utils_v1_credits.

Source code in src/cyhole/birdeye/client.py 
867
868
869
870
871
872
async def get_utils_v1_credits(self, time_from: int | None = None, time_to: int | None = None) -> GetUtilsV1CreditsResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Utils - Credits](https://docs.birdeye.so/reference/get-utils-v1-credits)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_utils_v1_credits`][cyhole.birdeye.interaction.Birdeye._get_utils_v1_credits].
    """
    return await self._interaction._get_utils_v1_credits(False, time_from, time_to)

get_v3_all_time_trades async 

get_v3_all_time_trades(
    address: str | list[str],
    time_frame: str = BirdeyeAllTimeTradesTimeFrame.ALL_TIME.value,
    ui_amount_mode: str | None = None,
) -> GetV3AllTimeTradesResponse

Call the Birdeye's PRIVATE v3 All-Time Trades endpoints (single / multiple) for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_all_time_trades.

Source code in src/cyhole/birdeye/client.py 
874
875
876
877
878
879
880
881
882
883
884
885
async def get_v3_all_time_trades(
    self,
    address: str | list[str],
    time_frame: str = BirdeyeAllTimeTradesTimeFrame.ALL_TIME.value,
    ui_amount_mode: str | None = None
) -> GetV3AllTimeTradesResponse:
    """
        Call the Birdeye's **PRIVATE** v3 All-Time Trades endpoints (**[single](https://docs.birdeye.so/reference/get-defi-v3-all-time-trades-single)** /
        **[multiple](https://docs.birdeye.so/reference/post-defi-v3-all-time-trades-multiple)**) for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_all_time_trades`][cyhole.birdeye.interaction.Birdeye._get_v3_all_time_trades].
    """
    return await self._interaction._get_v3_all_time_trades(False, address, time_frame, ui_amount_mode)

get_v3_token_meme_detail_single async 

get_v3_token_meme_detail_single(
    address: str,
) -> GetV3TokenMemeDetailSingleResponse

Call the Birdeye's PRIVATE API endpoint Meme Token Detail - Single for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_meme_detail_single.

Source code in src/cyhole/birdeye/client.py 
887
888
889
890
891
892
async def get_v3_token_meme_detail_single(self, address: str) -> GetV3TokenMemeDetailSingleResponse:
    """
        Call the Birdeye's **PRIVATE** API endpoint **[Meme Token Detail - Single](https://docs.birdeye.so/reference/get-defi-v3-token-meme-detail-single)** for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_meme_detail_single`][cyhole.birdeye.interaction.Birdeye._get_v3_token_meme_detail_single].
    """
    return await self._interaction._get_v3_token_meme_detail_single(False, address)

get_v3_token_meme_list async 

get_v3_token_meme_list(
    query: GetV3TokenMemeListQuery | None = None,
) -> GetV3TokenMemeListResponse

Call the Birdeye's GET Meme Token - List API endpoint for asynchronous logic. All the API endpoint details are available on Birdeye._get_v3_token_meme_list.

Source code in src/cyhole/birdeye/client.py 
894
895
896
897
898
899
async def get_v3_token_meme_list(self, query: GetV3TokenMemeListQuery | None = None) -> GetV3TokenMemeListResponse:
    """
        Call the Birdeye's GET **[Meme Token - List](https://docs.birdeye.so/reference/get-defi-v3-token-meme-list)** API endpoint for asynchronous logic.
        All the API endpoint details are available on [`Birdeye._get_v3_token_meme_list`][cyhole.birdeye.interaction.Birdeye._get_v3_token_meme_list].
    """
    return await self._interaction._get_v3_token_meme_list(False, query)