Python wrapper for birdeye.so api
Project description
birdeye-py
Features
- 🪙 BirdEye Only supports standard subscription api urls (package is still in active development)
- ♻️ Retry Strategy Sensible defaults to reliably retry/back-off fetching data from the api
- ✏️ Code Formatting Fully typed with mypy and code formatters black / isort
- ⚒️ Modern tooling using uv, ruff, and pre-commit
- 📥 GitHub Actions CI/CD to automate everything
- ↩️ Code Coverage Fully tested using tools like Codecov
- 🐍 Python Support All minor versions from 3.9 are supported
Installation
$ pip install birdeye-py
Usage
from birdeyepy import BirdEye
client = BirdEye(api_key="your-api-key")
# DeFi
# https://public-api.birdeye.so/defi/price
client.defi.price() # defaults to So11111111111111111111111111111111111111112
client.defi.price(
address="Gr11mosZNZjwpqnemXNnWs9E2Bnv7R6vzaKwJTdjo8zQ",
include_liquidity=True, # can also use strings 'true' or 'false'
)
# https://public-api.birdeye.so/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
)
# Token
# https://public-api.birdeye.so/defi/tokenlist
client.token.list_all()
Documentation
Coming Soon
If you would like to support development efforts, tips are greatly appreciated. SOL address: HKmUpKBCcZGVX8RqLRcKyjYuY23hQHwnFSHXzdon4pCH
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
birdeye_py-0.0.1.tar.gz
(7.9 kB
view details)
File details
Details for the file birdeye_py-0.0.1.tar.gz.
File metadata
- Download URL: birdeye_py-0.0.1.tar.gz
- Upload date:
- Size: 7.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a54d7b99d3d2bbd050732efa18e7dddc3ccde4d2d6b62c57022d36a727654888
|
|
| MD5 |
fee1f6e2bfa335788ccdf85f6e4534a4
|
|
| BLAKE2b-256 |
f732e197976de8fee02309592dcf30c67932547ca72a12556c388bdb4aa66980
|