BirdEye Client
==============

.. toctree::
    :maxdepth: 1
    :caption: Resources

    resources/defi
    resources/token
    resources/trader
    resources/wallet
    resources/pair
    resources/search


.. note::

    The BirdEye api requires an ``x-chain`` or ``x-chains`` header to be set in each request. The client will initialize with ``solana`` by default. See :class:`birdeyepy.utils.BirdEyeChainEnum`:


.. autoclass:: birdeyepy.birdeye.BirdEye
    :members:

APIs
----

.. code-block:: python

    from birdeyepy import BirdEye

    client = BirdEye(api_key="your-api-key")  # 'x-chain' header defaults to solana

    # DEFI

    # https://docs.birdeye.so/reference/get_defi-price
    client.defi.price()  # defaults to So11111111111111111111111111111111111111112

    client.defi.price(
        address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ",
        include_liquidity=True,  # can also use strings 'true' or 'false'
    )

    # https://docs.birdeye.so/reference/get_defi-history-price
    client.defi.history(time_from=1732398942, time_to=1732398961)  # defaults to So11111111111111111111111111111111111111112

    client.defi.history(
        time_from=1732398942,
        time_to=1732398961,
        address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ",
        address_type="token",  # or 'pair'...defaults to 'token'
        type_in_time="15m"  # default
    )

    # https://docs.birdeye.so/reference/get_defi-networks
    client.defi.supported_networks()

    # https://docs.birdeye.so/reference/get_defi-multi-price
    client.defi.price_multiple(
        addresses=["Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ", "AGQZRtz7hZtz3VJ1CoXRMNMyh2ZMZ1g6pv4aGMUSpump"],
    )  # can also use comma separated strings 'Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ,AGQZRtz7hZtz3VJ1CoXRMNMyh2ZMZ1g6pv4aGMUSpump'

    # https://docs.birdeye.so/reference/get_defi-historical-price-unix
    client.defi.history_by_unix(
        address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ",
        unixtime=1732398942
    )

    # https://docs.birdeye.so/reference/get_defi-txs-token
    client.defi.trades_token(
        address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ
    )

    # https://docs.birdeye.so/reference/get_defi-txs-pair
    client.defi.trades_pair(
        address="9wFFyRfZBsuAha4YcuxcXLKwMxJR43S7fPfQLusDBzvT
    )

    # https://docs.birdeye.so/reference/get_defi-txs-token-seek-by-time
    client.defi.trades_token_by_time(
        address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ",
        before_time=1732398942,
        after_time=1732398961
    )

    # https://docs.birdeye.so/reference/get_defi-txs-pair-seek-by-time
    client.defi.trades_pair_by_time(
        address="9wFFyRfZBsuAha4YcuxcXLKwMxJR43S7fPfQLusDBzvT",
        before_time=1732398942,
        after_time=1732398961
    )

    # https://docs.birdeye.so/reference/get_defi-ohlcv
    client.defi.ohlcv(
        address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ",
        time_from=1732398942,
        time_to=1732398961
    )

    # https://docs.birdeye.so/reference/get_defi-ohlcv-pair
    client.defi.ohlcv_pair(
        address="9wFFyRfZBsuAha4YcuxcXLKwMxJR43S7fPfQLusDBzvT",
        time_from=1732398942,
        time_to=1732398961
    )

    # https://docs.birdeye.so/reference/get_defi-price-volume-single
    client.defi.volume_price_single(
        address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ"
    )

    # TOKEN

    # https://docs.birdeye.so/reference/get_defi-tokenlist
    client.token.list_all()

    # https://docs.birdeye.so/reference/get_defi-token-security
    client.token.security(address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ")

    # https://docs.birdeye.so/reference/get_defi-token-overview
    client.token.overview(address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ")

    # https://docs.birdeye.so/reference/get_defi-token-creation-info
    client.token.creation_info(address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ")

    # https://docs.birdeye.so/reference/get_defi-token-trending
    client.token.trending()

    # https://docs.birdeye.so/reference/post_defi-v2-tokens-all
    client.token.list_all_v2()

    # https://docs.birdeye.so/reference/get_defi-v2-tokens-new-listing
    client.token.new_listing(
        time_to=1732398961,
        meme_platform_enabled=True,  # can also use strings 'true' or 'false'
    )

    # https://docs.birdeye.so/reference/get_defi-v2-tokens-top-traders
    client.token.top_traders(address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ")

    # https://docs.birdeye.so/reference/get_defi-v2-markets
    client.token.all_markets(address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ")

    # https://docs.birdeye.so/reference/get_defi-v3-token-meta-data-single
    client.token.market_metadata_single(address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ")

    # https://docs.birdeye.so/reference/get_defi-v3-token-meta-data-multiple
    client.token.market_metadata_multiple(
        addresses=["Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ", "AGQZRtz7hZtz3VJ1CoXRMNMyh2ZMZ1g6pv4aGMUSpump"],
    )  # can also use comma separated strings 'Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ,AGQZRtz7hZtz3VJ1CoXRMNMyh2ZMZ1g6pv4aGMUSpump'

    # https://docs.birdeye.so/reference/get_defi-v3-token-market-data
    client.token.market_data(address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ")

    # https://docs.birdeye.so/reference/get_defi-v3-token-trade-data-single
    client.token.trade_data_single(address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ")

    # https://docs.birdeye.so/reference/get_defi-v3-token-trade-data-multiple
    client.token.trade_data_multiple(
        addresses=["Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ", "AGQZRtz7hZtz3VJ1CoXRMNMyh2ZMZ1g6pv4aGMUSpump"],
    )  # can also use comma separated strings 'Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ,AGQZRtz7hZtz3VJ1CoXRMNMyh2ZMZ1g6pv4aGMUSpump'

    # https://docs.birdeye.so/reference/get_defi-v3-token-holder
    client.token.holder(address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ")

    # PAIR

    # https://docs.birdeye.so/reference/get_defi-v3-pair-overview-multiple
    client.pair.overview_multiple(
        list_address=["Cv5w6oLCquS4M3WN7DcwFrFiCCJwiL31MCJu3jTXpump", "FMNB4a8TFNvo3go6tkUQmr2YJHBxhiuT39bt3j6qjGJc"]
    )

    # https://docs.birdeye.so/reference/get_defi-v3-pair-overview-single
    client.pair.overview_single(address="Cv5w6oLCquS4M3WN7DcwFrFiCCJwiL31MCJu3jTXpump")

    # SEARCH

    # https://docs.birdeye.so/reference/get_defi-v3-search
    client.search.token_market_data(
        keyword="rizz"
        markets="Raydium"
    )