Parameters

Some endpoints require input parameters belonging to specific domains. On this page, all domains can be found in order to be in line with the standards required by the API.

cyhole.birdeye.param

BirdeyeChain

Bases: CyholeParam

Enum class to get the supported Birdeye's chains.

SOLANA class-attribute instance-attribute

SOLANA = 'solana'

Identifier of the Solana chain in Birdeye API.

ETHEREUM class-attribute instance-attribute

ETHEREUM = 'ethereum'

Identifier of the Ethereum chain in Birdeye API.

ARBITRUM class-attribute instance-attribute

ARBITRUM = 'arbitrum'

Identifier of the Arbitrum chain in Birdeye API.

AVALANCHE class-attribute instance-attribute

AVALANCHE = 'avalanche'

Identifier of the Avalanche chain in Birdeye API.

BSC class-attribute instance-attribute

BSC = 'bsc'

Identifier of the BSC (Binance Smart Chain) chain in Birdeye API.

OPTIMISM class-attribute instance-attribute

OPTIMISM = 'optimism'

Identifier of the Optimism chain in Birdeye API.

POLYGON class-attribute instance-attribute

POLYGON = 'polygon'

Identifier of the Polygon chain in Birdeye API.

BASE class-attribute instance-attribute

BASE = 'base'

Identifier of the Base chain in Birdeye API.

ZKSYNC class-attribute instance-attribute

ZKSYNC = 'zksync'

Identifier of the zkSync chain in Birdeye API.

BirdeyeOrder

Bases: CyholeParam

Enum class to get the supported Birdeye's orders.

ASCENDING class-attribute instance-attribute

ASCENDING = 'asc'

Ascending sort order.

DESCENDING class-attribute instance-attribute

DESCENDING = 'desc'

Descending sort order.

BirdeyeSort

Bases: CyholeParam

Enum class to get the supported Birdeye's sorting types.

SORT_MC class-attribute instance-attribute

SORT_MC = 'mc'

Sort the results by Market Cap (MC)

SORT_V24HUSD class-attribute instance-attribute

SORT_V24HUSD = 'v24hUSD'

Sort the results by USD Volume in the last 24h

SORT_V24HCHANGEPERCENT class-attribute instance-attribute

SORT_V24HCHANGEPERCENT = 'v24hChangePercent'

Sort the results by percent changing in the last 24h

BirdeyeTimeFrame

Bases: CyholeParam

Enum class to get the supported Birdeye's timeframe sizes.

MIN1 class-attribute instance-attribute

MIN1 = '1m'

1 minute

MIN3 class-attribute instance-attribute

MIN3 = '3m'

3 minute

MIN5 class-attribute instance-attribute

MIN5 = '5m'

5 minute

MIN15 class-attribute instance-attribute

MIN15 = '15m'

15 minute

MIN30 class-attribute instance-attribute

MIN30 = '30m'

30 minute

H1 class-attribute instance-attribute

H1 = '1H'

1 hour

H2 class-attribute instance-attribute

H2 = '2H'

2 hour

H4 class-attribute instance-attribute

H4 = '4H'

4 hour

H6 class-attribute instance-attribute

H6 = '6H'

6 hour

H8 class-attribute instance-attribute

H8 = '8H'

8 hour

H12 class-attribute instance-attribute

H12 = '12H'

12 hour

D1 class-attribute instance-attribute

D1 = '1D'

1 day

D3 class-attribute instance-attribute

D3 = '3D'

3 day

W1 class-attribute instance-attribute

W1 = '1W'

1 week

M1 class-attribute instance-attribute

M1 = '1M'

1 month

BirdeyeHourTimeFrame

Bases: CyholeParam

Enum class to get the supported Birdeye's timeframe sizes with hour as unit size.

H1 class-attribute instance-attribute

H1 = '1h'

1 hour

H2 class-attribute instance-attribute

H2 = '2h'

2 hour

H4 class-attribute instance-attribute

H4 = '4h'

4 hour

H8 class-attribute instance-attribute

H8 = '8h'

8 hour

H24 class-attribute instance-attribute

H24 = '24h'

24 hour

BirdeyeAddressType

Bases: CyholeParam

Enum class to get the supported Birdeye's address' types.

TOKEN class-attribute instance-attribute

TOKEN = 'token'

The address is refering to a token on the chain.

PAIR class-attribute instance-attribute

PAIR = 'pair'

The address is refering to a token pair on the chain. (e.g. SOL/USDT)

BirdeyeTradeType

Bases: CyholeParam

Enum class to get the supported Birdeye's transactions' types.

SWAP class-attribute instance-attribute

SWAP = 'swap'

A classic exchange between two currencies.

ADD class-attribute instance-attribute

ADD = 'add'

Transactions that add liquidity.

REMOVE class-attribute instance-attribute

REMOVE = 'remove'

Transactions that remove liquidity.

ALL class-attribute instance-attribute

ALL = 'all'

All type of transactions (swap, add, remove).