- Birdeye¶

Birdeye (https://birdeye.so) is a popular treading crypto platform connected to different blockchains that provides tokens data and pairs' prices in real time. The access to both their public and private APIs is managed by a valid API key requestable on their site.

The API connector is Birdeye class imported from cyhole.birdeye path.

Quick Example¶

Extract the latest tokens from Ethereum chain sorted in descending order by USD volume in few lines of code by using get_token_list in synchronous and asynchronous logic.

import asyncio
import asyncio
from cyhole.birdeye import Birdeye
from cyhole.birdeye.param import BirdeyeChain

birdeye = Birdeye(chain = BirdeyeChain.ETHEREUM.value)

# synchronous
response = birdeye.client.get_token_list(limit = 1)
token = response.data.tokens[0]
print(f"Highest 24h USD volume token: '{token.name}', volume: {round(token.volume_24h_usd, 2)}.")

# asynchronous
async def main() -> None:
    async with birdeye.async_client as client:
        response = await client.get_token_list(limit = 1)
        token = response.data.tokens[0]
        print(f"Highest 24h USD volume token: '{token.name}', volume: {round(token.volume_24h_usd, 2)}.")

asyncio.run(main())

Note

To run this example is assumed that the user has a valid API key stored in BIRDEYE_API_KEY environment variable.
If the key is not provided during the object creations, then the library will raise an exception.

Content¶

The documentation follows the library's structure by providing all the technical details required to use it.

Connector

cyhole.birdeye - Explore the Birdeye API connector and all its methods.

Reference
API Parameters

cyhole.birdeye.param - Ensure to use the correct parameters during the API calls.

Reference
Response Schema

cyhole.birdeye.schema - Extract only what is necessary by exploiting reponse mapping thanks to pydantic schemes.

Reference
Exceptions

cyhole.birdeye.exception - Make sure you intercept all exceptions correctly.

Reference

Endpoints¶

Endpoint	Type	Method	`cyhole` Release	Deprecated
Token - List	`GET`	`get_token_list`	`0.0.1-alpha`	-
Token - List (V3)	`GET`	`get_v3_token_list`	`0.3.0`	-
Token - List (V3) Scroll	`GET`	`get_v3_token_list_scroll`	`0.3.0`	-
Token - New Listing	`GET`	`get_v2_tokens_new_listing`	`0.3.0`	-
Token - All Market List	`GET`	`get_v2_markets`	`0.3.0`	-
Token - Metadata (Single / Multiple)	`GET`	`get_v3_token_meta_data`	`0.3.0`	-
Token - Market Data (Single / Multiple)	`GET`	`get_v3_token_market_data`	`0.3.0`	-
Token - Trade Data (Single / Multiple)	`GET`	`get_v3_token_trade_data`	`0.3.0`	-
Token - Liquidity (Single / Multiple)	`GET`	`get_v3_token_exit_liquidity`	`0.3.0`	-
Token - Mint/Burn	`GET`	`get_v3_token_mint_burn_txs`	`0.3.0`	-
Token - Top Traders	`GET`	`get_v2_tokens_top_traders`	`0.3.0`	-
Token - Holder (Top / Batch)	`GET / POST`	`get_token_holder`	`0.3.0`	-
Token - Holder Distribution	`GET`	`get_holder_distribution`	`0.3.0`	-
Token - Holder Profile	`GET`	`get_token_holder_profile`	`0.3.0`	-
Token - Holder Positions	`GET`	`get_token_holder_positions`	`0.3.0`	-
Token - Holder Chart	`GET`	`get_token_holder_chart`	`0.3.0`	-
Token - Transfer List	`POST`	`post_token_transfer`	`0.3.0`	-
Token - Transfer Total	`POST`	`post_token_transfer_total`	`0.3.0`	-
Token - Trending List	`GET`	`get_token_trending`	`0.3.0`	-
Token - Creation Token Info	`GET`	`get_token_creation_info`	`0.0.1-alpha`	-
Token - Security	`GET`	`get_token_security`	`0.0.1-alpha`	-
Token - Overview	`GET`	`get_token_overview`	`0.0.1-alpha`	-
Price	`GET`	`get_price`	`0.0.1-alpha`	-
Price - Multiple	`GET`	`get_price_multiple`	`0.0.1-alpha`	-
Price - Historical	`GET`	`get_price_historical`	`0.0.1-alpha`	-
Price Volume - Single Token	`GET`	`get_price_volume_single`	`0.2.1`	-
Price Volume - Multiple Token	`POST`	`post_price_volume_multi`	`0.2.1`	-
Trades - Token	`GET`	`get_trades_token`	`0.0.1-alpha`	-
Trades - Pair	`GET`	`get_trades_pair`	`0.0.1-alpha`	-
OHLCV - Token/Pair	`GET`	`get_ohlcv`	`0.0.1-alpha`	-
OHLCV - Base/Quote	`GET`	`get_ohlcv_base_quote`	`0.0.1-alpha`	-
Wallet - Supported Networks	`GET`	`get_wallet_supported_networks`	`0.0.1-alpha`	-
Search	`GET`	`get_v3_search`	`0.3.1`	-
Utils - Credits	`GET`	`get_utils_v1_credits`	`0.3.1`	-
All-Time Trades (Single / Multiple)	`GET / POST`	`get_v3_all_time_trades`	`0.3.1`	-
Meme Token Detail - Single	`GET`	`get_v3_token_meme_detail_single`	`0.3.1`	-
Meme Token - List	`GET`	`get_v3_token_meme_list`	`0.3.1`	-
History	`GET`	`get_history`	`0.0.1-alpha`	`0.2.0`