Skip to content

EXAMPLES.md

Latest commit

 

History

History
696 lines (482 loc) · 15.1 KB

EXAMPLES.md

File metadata and controls

696 lines (482 loc) · 15.1 KB

Examples

The following examples demonstrate the usage of the methods.

chartData

await data.getData( {
    "route": "chartData",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
token Yes string Token address

See response here

chartDataByPool

Get OLCVH (Open, Low, Close, Volume, High) data for charts.

await data.getData( {
    "route": "chartDataByPool",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump",
        "pool": "9Tb2ohu5P16BpBarqd3N27WnkF51Ukfs8Z1GzzLDxVZW"
    }
} )

Parameters

Parameter Required Type Description
token Yes string Token address
pool Yes string Pool identifier
type No string Time interval (e.g., “1s”, “1m”, “1h”, “1d”)
time_from No integer Start time (Unix timestamp in seconds)
time_to No integer End time (Unix timestamp in seconds)
marketCap No integer Return chart for market cap instead of pricing

See response here

firstBuyersOfToken

Retrieve the first 100 buyers of a token (since API started recording data) with Profit and Loss data for each wallet.

await data.getData( {
    "route": "firstBuyersOfToken",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
token Yes string Token address

See response here

graduatedTokens

Overview of all graduated pumpfun/moonshot tokens (Pumpvision / Photon Memescope style).

await data.getData( {
    "route": "graduatedTokens",
    "params": {}
} )

See response here

latestTokens

Retrieve the latest 100 tokens.

await data.getData( {
    "route": "latestTokens",
    "params": {}
} )

See response here

multiPriceInformation

Get price information for multiple tokens (up to 100).

await data.getData( {
    "route": "multiPriceInformation",
    "params": {
        "tokens": [
            "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
        ]
    }
} )

Parameters

Parameter Required Type Description
tokens Yes array Token addresses
priceChanges No boolean Include price change data in response

See response here

multiTokenInformation

Get an overview of latest, graduating, and graduated tokens (Pumpvision / Photon Memescope style).

await data.getData( {
    "route": "multiTokenInformation",
    "params": {}
} )

See response here

paginatedTopTraders

Get the most profitable traders across all tokens, with optional pagination.

await data.getData( {
    "route": "paginatedTopTraders",
    "params": {
        "page": 1
    }
} )

Parameters

Parameter Required Type Description
page Yes integer Page number for pagination (starts with 1)
expandPnl No Include detailed PnL data for each token if true
sortBy No string Sort results by metric (“total” or “winPercentage”)

See response here

pnlForSpecificToken

Get Profit and Loss data for a specific token in a wallet.

await data.getData( {
    "route": "pnlForSpecificToken",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump",
        "wallet": "8bHMVvpApEQS6M2qRv4eJUDptoW919NFrBSbeDGmoGJ6"
    }
} )

Parameters

Parameter Required Type Description
wallet Yes string Wallet address
token Yes string Token address

See response here

postMultiPrice

Similar to GET /price/multi, but accepts an array of token addresses in the request body.

await data.getData( {
    "route": "postMultiPrice",
    "params": {
        "tokens": [
            "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
        ]
    }
} )

Parameters

Parameter Required Type Description
tokens Yes array Token addresses
priceChanges No boolean Include price change data in response

See response here

postPrice

Similar to GET /price, but accepts token address in the request body.

await data.getData( {
    "route": "postPrice",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
token Yes string Token address

See response here

priceHistory

Get historic price information for a single token.

await data.getData( {
    "route": "priceHistory",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
token Yes string Token address

See response here

priceInformation

Get price information for a single token.

await data.getData( {
    "route": "priceInformation",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
token Yes string Token address
priceChanges No boolean Include price change data in response

See response here

profitAndLossData

Get Profit and Loss data for all positions of a wallet.

await data.getData( {
    "route": "profitAndLossData",
    "params": {
        "wallet": "8bHMVvpApEQS6M2qRv4eJUDptoW919NFrBSbeDGmoGJ6"
    }
} )

Parameters

Parameter Required Type Description
wallet Yes string Wallet address
showHistoricPnL No boolean Adds PnL data for 1d, 7d and 30d intervals (BETA)

See response here

search

The /search endpoint provides a flexible search interface for pools and tokens with support for multiple filtering criteria and pagination.

await data.getData( {
    "route": "search",
    "params": {
        "query": "soybean",
        "market": "pumpfun"
    }
} )

Parameters

Parameter Required Type Description
query Yes string Search term for token symbol, name, or address
page No integer Page number for pagination (starts with 1)
limit No integer Number of results per page
minLiquidity No integer Minimum liquidity in USD
maxLiquidity No integer Maximum liquidity in USD
minMarketCap No integer Minimum market cap in USD
maxMarketCap No integer Maximum market cap in USD
minBuys No integer Minimum number of buy transactions
maxBuys No integer Maximum number of buy transactions
minSells No integer Minimum number of sell transactions
maxSells No integer Maximum number of sell transactions
minTotalTransactions No integer Minimum total number of transactions
maxTotalTransactions No integer Maximum total number of transactions
lpBurn No integer LP token burn percentage
market No string Market identifier
freezeAuthority No string Freeze authority address
mintAuthority No integer Mint authority address
deployer No string Deployer address
showPriceChanges No boolean Include price change data in response

See response here

tokenAth

Retrieve the all time high price of a token (since data api started recording)

await data.getData( {
    "route": "tokenAth",
    "params": {
        "tokenAddress": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
tokenAddress Yes string Token address

See response here

tokenHolders

Get the top 100 holders for a specific token.

await data.getData( {
    "route": "tokenHolders",
    "params": {
        "tokenAddress": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
tokenAddress Yes string Token address

See response here

tokenInformation

Retrieve all information for a specific token.

await data.getData( {
    "route": "tokenInformation",
    "params": {
        "tokenAddress": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
tokenAddress Yes string Token address

See response here

tokenStats

Get detailed stats for a token over various time intervals.

await data.getData( {
    "route": "tokenStats",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
token Yes string Token address

See response here

tokenStatsByPool

Get detailed stats for a token-pool pair over various time intervals.

await data.getData( {
    "route": "tokenStatsByPool",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump",
        "pool": "9Tb2ohu5P16BpBarqd3N27WnkF51Ukfs8Z1GzzLDxVZW"
    }
} )

Parameters

Parameter Required Type Description
token Yes string Token address
pool Yes string Pool identifier

See response here

tokenTrades

Get the latest trades for a token across all pools.

await data.getData( {
    "route": "tokenTrades",
    "params": {
        "tokenAddress": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
tokenAddress Yes string Token address

See response here

tokenTradesByPool

Get the latest trades for a specific token and pool pair.

await data.getData( {
    "route": "tokenTradesByPool",
    "params": {
        "tokenAddress": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump",
        "poolAddress": "9Tb2ohu5P16BpBarqd3N27WnkF51Ukfs8Z1GzzLDxVZW"
    }
} )

Parameters

Parameter Required Type Description
tokenAddress Yes string Token address
poolAddress Yes string Pool address

See response here

tokenTradesByPoolAndOwner

Get the latest trades for a specific token, pool, and wallet address.

await data.getData( {
    "route": "tokenTradesByPoolAndOwner",
    "params": {
        "tokenAddress": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump",
        "poolAddress": "9Tb2ohu5P16BpBarqd3N27WnkF51Ukfs8Z1GzzLDxVZW",
        "owner": "8bHMVvpApEQS6M2qRv4eJUDptoW919NFrBSbeDGmoGJ6"
    }
} )

Parameters

Parameter Required Type Description
tokenAddress Yes string Token address
poolAddress Yes string Pool address
owner Yes string Owner address

See response here

tokenVolume

Retrieve the top 100 tokens sorted by highest volume.

await data.getData( {
    "route": "tokenVolume",
    "params": {}
} )

See response here

topTraders

Get the most profitable traders

await data.getData( {
    "route": "topTraders",
    "params": {}
} )

See response here

topTradersForToken

Get top 100 traders by PnL for a token.

await data.getData( {
    "route": "topTradersForToken",
    "params": {
        "token": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump"
    }
} )

Parameters

Parameter Required Type Description
token Yes string Token address

See response here

tradesByWallet

Get the latest trades for a specific token and wallet address.

await data.getData( {
    "route": "tradesByWallet",
    "params": {
        "tokenAddress": "CzLSujWBLFsSjncfkh59rUFqvafWcY5tzedWJSuypump",
        "owner": "8bHMVvpApEQS6M2qRv4eJUDptoW919NFrBSbeDGmoGJ6"
    }
} )

Parameters

Parameter Required Type Description
tokenAddress Yes string Token address
owner Yes string Owner address
cursor No string Cursor for pagination
showMeta No boolean Set to ‘true’ to add metadata for from and to tokens
parseJupiter No boolean Set to ‘true’ to combine all transfers within a Jupiter swap into a single transaction. By default, each transfer is shown separately.
hideArb No boolean Set to ‘true’ to hide arbitrage or other transactions that don’t have both the ‘from’ and ‘to’ token addresses matching the token parameter

See response here

trendingTokens

Get the top 100 trending tokens based on transaction volume in the past hour.

await data.getData( {
    "route": "trendingTokens",
    "params": {}
} )

See response here

trendingTokensByTimeframe

Returns trending tokens for a specific time interval.

await data.getData( {
    "route": "trendingTokensByTimeframe",
    "params": {
        "timeframe": "1h"
    }
} )

Parameters

Parameter Required Type Description
timeframe Yes string Timeframe for data aggregation

See response here

walletInformation

Get all tokens in a wallet with current value in USD.

await data.getData( {
    "route": "walletInformation",
    "params": {
        "owner": "95z7osZ7LcAoFkhf1ka3hWdWU8Fk8Fap69ymeeaaMruV"
    }
} )

Parameters

Parameter Required Type Description
owner Yes string Owner address

See response here

walletTrades

Get the latest trades of a wallet.

await data.getData( {
    "route": "walletTrades",
    "params": {
        "owner": "95z7osZ7LcAoFkhf1ka3hWdWU8Fk8Fap69ymeeaaMruV"
    }
} )

Parameters

Parameter Required Type Description
owner Yes string Owner address
cursor No string Cursor for pagination

See response here