New DEX Pairs Stream
The New DEX Pairs stream provides real-time updates when new liquidity pairs are created on decentralized exchanges (DEXes). This documentation follows our standard streaming API structure.
Credit Cost
Supported Chains
- Base Mainnet
- BSC Mainnet
- Ethereum Mainnet
Supported DEXes
- Uniswap V2, V3
- PancakeSwap
This stream is currently in Beta. It is stable for testing and evaluation but may undergo changes in schema or behavior as we continue to improve it. No API credits are currently charged.
We welcome your feedback so please reach out to us directly to report issues or request features.
Authentication
Using any of the GoldRush developer tools requires an API key.
Get Started
Sign up for a free API key to get started with GoldRush.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
chain_name | enum | Yes | Chain name to filter events (e.g., BASE_MAINNET , ETH_MAINNET , BSC_MAINNET ) |
protocols | array<enum> | Yes | List of protocol name enums to filter events (e.g.,[UNISWAP_V2, UNISWAP_V3] ) |
Connection
If you’re not using the graphql-ws
package, you must set the WebSocket protocol header:
"Sec-WebSocket-Protocol" : "graphql-transport-ws"
This header is required for the server to properly recognize and handle your GraphQL subscription requests.
The WebSocket endpoint uses the GraphQL query
or subscription
protocol. Here are examples of how one can connect with different languages:
Subscription
Once connected, you can subscribe to the newPairs
endpoint to receive event notifications.
Basic Subscription Query
Complete Subscription Query
Implementation
Response Format
Here’s an example of the response data structure:
Response Fields
Field | Type | Description |
---|---|---|
chain_name | string | The blockchain network where the pair was created |
protocol | string | DEX protocol name (e.g., “uniswap”, “pancakeswap”) |
protocol_version | string | Version of the DEX protocol |
pair_address | string | Address of the new pair contract |
deployer_address | string | Address that deployed the pair contract |
tx_hash | string | Transaction hash of the pair creation |
block_signed_at | string | ISO timestamp of when the block was signed |
liquidity | float | Initial liquidity amount (in USD) |
supply | integer | Total supply of the pair token |
market_cap | float | Market capitalization in USD |
event_name | string | Name of the contract event (e.g., “PoolCreated”) |
quote_rate | float | Exchange rate between base and quote tokens |
quote_rate_usd | float | USD value of the quote rate |
base_token_metadata | object | Metadata for the base token including contract address, decimals, name, and symbol |
quote_token_metadata | object | Metadata for the quote token including contract address, decimals, name, and symbol |
pair_metadata | object | Metadata for the pair including contract address, decimals, name, and symbol |
prices | object | Price change metrics at different time intervals (5m, 1hr, 6hr, 24hr) |
swaps | object | Number of swaps at different time intervals (5m, 1hr, 6hr, 24hr) |