Subscribing to Real-Time token new listing (SUBSCRIBE_TOKEN_NEW_LISTING)

The "SUBSCRIBE_TOKEN_NEW_LISTING" event allows you to receive real-time updates about new token listings. This subscription is useful for tracking new tokens being added on a requested blockchain.

The instructions for each type of objects are described below.

WebSocket URL:

wss://public-api.birdeye.so/socket/solana?x-api-key=YOUR-API-KEY

Header

Key	Value
`Origin`	ws://public-api.birdeye.so
`Sec-WebSocket-Origin`	ws://public-api.birdeye.so
`Sec-WebSocket-Protocol`	echo-protocol

Message

{
    "type": "SUBSCRIBE_TOKEN_NEW_LISTING"
}

Or:

{
    "type": "SUBSCRIBE_TOKEN_NEW_LISTING",
    "meme_platform_enabled": true,
    "min_liquidity": 5000,
    "max_liquidity": 10000
}

Key Notes:

The min_liquidity parameter is optional but user must set higher than system value which is 10.
The max_liquidity parameter is optional but must be higher than min_volume when provided.
The meme_platform_enabled parameter is optional, value true means that you want to receive new meme token listing from meme platform such as pump.fun. If no message, it means no listing from meme platform.

Output Example

{
    "type": "TOKEN_NEW_LISTING_DATA",
    "data": {
        "address": "BkQfwVktcbWmxePJN5weHWJZgReWbiz8gzTdFa2w7Uds",
        "decimals": 6,
        "name": "Worker Cat",
        "symbol": "$MCDCAT",
        "liquidity": "12120.155172280874",
        "liquidityAddedAt": 1720155863
    }
}

Response Parameters:

Key	Data Type	Details	Example
`address`	string	The token address.	"BkQfwVktcbWmxePJN5weHWJZgReWbiz8gzTdFa2w7Uds"
`decimals`	integer	The number of decimal places for the token.	6
`name`	string	The name of the token.	"Worker Cat"
`symbol`	string	The symbol of the token.	"$MCDCAT"
`liquidity`	string	The current liquidity of the token.	"12120.155172280874"
`liquidityAddedAt`	integer	The Unix timestamp when liquidity was added.	1720155863