This endpoint is available for all plans.
POST Method Overview
The POST method allows you to retrieve pulse data by passing complex configurations in the JSON body. This method is recommended for advanced filtering, custom views, and complex configurations.Endpoint
Basic Configuration
Simple Configuration
For basic usage, use thechainId
and poolTypes
parameters:
Asset Mode
Pulse API supports two modes of operation:Pool-Based Mode (Default)
The default mode focuses on pool statistics and trading pair data.Token-Based Mode (Asset Mode)
WhenassetMode: true
is specified, the API switches to token-centric analytics, providing comprehensive token statistics and metadata instead of pool-focused data.
- Data Structure: Returns
TokenDataSchema
with comprehensive token statistics - Analytics Focus: Token performance, holder analytics, social data, and security metrics
- Enhanced Metrics: Includes organic trading data (excluding bot activity)
- Token Metadata: Social links, security analysis, holder distribution
- Holdings Analysis: Developer, insider, sniper, and professional trader holdings
Default Model
Use thedefault
model to automatically get three views: new
, bonding
, and bonded
:
Pool-Based Mode:
- new: Newly created tokens (sorted by
created_at
desc) - bonding: Tokens in bonding phase with activity (sorted by
market_cap
desc) - bonded: Bonded tokens on traditional DEXs (sorted by
created_at
desc)
Custom Views
For granular control, use theviews
parameter:
View Structure (Pool-Based Mode)
View Structure (Token-Based Mode)
Available View Models
Model “new”
Retrieves newly created tokens:Model “bonding”
Retrieves tokens in bonding phase with activity:Model “bonded”
Retrieves bonded tokens available on DEXs:View Parameters
Sorting and Pagination Parameters
-
sortBy
(string): Sort field- Options:
created_at
,market_cap
,volume_1h
,latest_trade_date
,price_change_1h
,price_change_24h
,trades_1h
,trades_24h
,liquidity
,holders_count
- Default:
created_at
- Options:
-
sortOrder
(string): Sort order- Options:
asc
,desc
- Default:
desc
- Options:
-
limit
(number): Number of results per view- Maximum: 100
- Default: 30
-
offset
(number): Offset for pagination- Default: 0
-
addressToExclude
(string | string[]): Addresses to exclude from results- Automatically excludes pools where the address appears as token0, token1, or pool address
- Can be a single address string or array of addresses
- Default: undefined
Advanced Filtering
🔍 Complete Filter Reference
View the complete filtering documentation with all available fields and operators
Pool-Based Mode Filtering
In the default pool-based mode, you can filter on pool-related metrics:Token-Based Mode Filtering (Asset Mode)
WhenassetMode: true
is enabled, you gain access to comprehensive token analytics:
Holdings Analysis:
dev_holdings_percentage
: Developer holdings percentageinsiders_holdings_percentage
: Insider holdings percentagesnipers_holdings_percentage
: Sniper holdings percentagebundlers_holdings_percentage
: Bundler holdings percentagepro_traders_holdings_percentage
: Professional trader holdings percentagetop_10_holdings_percentage
: Top 10 holders percentagetop_50_holdings_percentage
: Top 50 holders percentagetop_100_holdings_percentage
: Top 100 holders percentagetop_200_holdings_percentage
: Top 200 holders percentage
organic_volume_1h
,organic_volume_24h
: Organic volume metricsorganic_trades_1h
,organic_trades_24h
: Organic trade countsorganic_buyers_1h
,organic_buyers_24h
: Organic buyer countsorganic_sellers_1h
,organic_sellers_24h
: Organic seller counts
dexscreenerListed
: Whether listed on DexScreenerdexscreenerHeader
: DexScreener header statustwitter_reuses_count
: Twitter handle reuse countdeployer_migrations_count
: Deployer migration count
bonding_percentage
: Bonding curve completion percentagebonded
: Whether token is fully bondedmigrated_at
: Migration timestamp
Filter Structure
Pool-Based Mode:Available Filter Categories
- Price Fields:
latest_price
,price_change_1h
,price_change_24h
, etc. - Market Cap Fields:
market_cap
,latest_market_cap
- Volume Fields:
volume_1h
,volume_24h
, etc. - Activity Fields:
trades_1h
,trades_24h
,holders_count
- Pool Properties:
pools.type
,pools.bonded
,pools.factory
- Date Fields:
created_at
,latest_trade_date
Filter Operators
equals
: Exact equalitygte
: Greater than or equallte
: Less than or equalgt
: Strictly greater thanlt
: Strictly less thannot
: Not equal toin
: In the list
Usage Examples
Example 1: High Volume Tokens
Example 2: Complex Configuration with Advanced Filters (Pool-Based)
Example 3: Token Analytics with Asset Mode
Example 4: Multi-Chain with Address Exclusion
Available Pool Types
Full list can be queried on /api/1/system-metadataResponse Format
The response structure varies depending on the mode:Pool-Based Mode Response
The default mode returns pool-focused data with trading pair information.Token-Based Mode Response (Asset Mode)
WhenassetMode: true
, the response includes comprehensive token analytics following the TokenDataSchema
structure with additional fields like:
- Holdings Analysis:
devHoldingsPercentage
,top10HoldingsPercentage
, etc. - Organic Metrics:
organic_volume_1h
,organic_traders_1h
, etc. - Social Data:
socials.twitter
,socials.telegram
,socials.website
- Security Analysis:
security
object with token safety metrics - Enhanced Metadata:
dexscreenerListed
,twitterReusesCount
, etc.
When to Use POST vs GET
Use POST when:
- Complex filtering required
- Custom views configuration
- Advanced filter combinations
- Large number of parameters
- JSON structure preferred
- Asset Mode analytics needed (token-focused data)
- Holdings analysis and organic metrics required
Use GET when:
- Simple configuration with basic parameters
- Default model is sufficient
- No complex filtering needed
- URL-friendly parameter passing
- Basic pool-based data is sufficient
🔗 GET Method
Learn about the GET method for simple configurations
📡 Real-time Stream
Access the same filtering system in real-time via WebSocket