SUBSCRIBE_NEW_PAIR
Subscribing to Real-Time New Pairs (SUBSCRIBE_SUBSCRIBE_NEW_PAIR)
The "SUBSCRIBE_NEW_PAIR" event allows you to receive real-time updates about new pairs. This subscription is useful for tracking new tokens being added on a requested blockchain. However, please note that the DEX Openbook pairs are not supported. Currently, this feature supports the Solana and EVM chains.
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_NEW_PAIR"
}
Or:
{
"type": "SUBSCRIBE_NEW_PAIR",
"min_liquidity": 100,
"max_liquidity" : 50000
}
Key Notes:
- The
min_liquidity
parameter is optional but user must set higher than system value which is10
. - The
max_liquidity
parameter is optional but must be higher thanmin_volume
when provided.
Output Example
{
"type": "NEW_PAIR_DATA",
"data": {
"address": "CXV4S8CxSppJeGzMFv8YQjsGZJif8d1Fqz9EtJRovmJY",
"name": "$JESUSPUMP-SOL",
"source": "pump_dot_fun",
"base": {
"address": "AoMBAxc82xinKTnEBGvuJaFb7occsyyBD6GmELrypump",
"name": "JESUS PUMP",
"symbol": "$JESUSPUMP",
"decimals": 6
},
"quote": {
"address": "So11111111111111111111111111111111111111112",
"name": "Wrapped SOL",
"symbol": "SOL",
"decimals": 9
},
"txHash": "3CzXpuUJV9KryVDMN5nFAqH87TfueWG6sUiksbf3Akh9eqGNJW1CJtYbrELJixXC77Dyutz8CfT3eP1uJ3LP3iy5",
"blockTime": 1720156781
}
}
Response Parameters:
Key | Data Type | Details | Example |
---|---|---|---|
type | string | The type of the response data. | "NEW_PAIR_DATA" |
data | object | The main data object containing details of the new trading pair. | |
data.address | string | The address of the new trading pair. | "CXV4S8CxSppJeGzMFv8YQjsGZJif8d1Fqz9EtJRovmJY" |
data.name | string | The name of the trading pair. | "$JESUSPUMP-SOL" |
data.source | string | The source or platform where the trading pair is listed. | "pump_dot_fun" |
data.base | object | The base token object containing details of the base token. | |
data.base.address | string | The address of the base token. | "AoMBAxc82xinKTnEBGvuJaFb7occsyyBD6GmELrypump" |
data.base.name | string | The name of the base token. | "JESUS PUMP" |
data.base.symbol | string | The symbol of the base token. | "$JESUSPUMP" |
data.base.decimals | integer | The number of decimal places for the base token. | 6 |
data.quote | object | The quote token object containing details of the quote token. | |
data.quote.address | string | The address of the quote token. | "So11111111111111111111111111111111111111112" |
data.quote.name | string | The name of the quote token. | "Wrapped SOL" |
data.quote.symbol | string | The symbol of the quote token. | "SOL" |
data.quote.decimals | integer | The number of decimal places for the quote token. | 9 |
data.txHash | string | The transaction hash for the creation of the trading pair. | "3CzXpuUJV9KryVDMN5nFAqH87TfueWG6sUiksbf3Akh9eqGNJW1CJtYbrELJixXC77Dyutz8CfT3eP1uJ3LP3iy5" |
data.blockTime | integer | The Unix timestamp when the trading pair was created. | 1720156781 |
Updated 8 days ago