@sperax/tool-gmgn

Solana on-chain analytics: wallet PnL & winrate, smart money tracking, token info, trending tokens, and top holder analysis via GMGN.ai

GMGN (Solana) is an agent tool from SperaxOS, packaged headless so you can call it from any agent framework. It ships two things: the manifest — a JSON-Schema function definition a model can call — and the executor that runs the call against the real API.

There is no UI layer and no framework lock-in. It works anywhere TypeScript runs.

Install

npm install @sperax/tool-gmgn

Usage

Call it directly

import { gmgnExecutor } from '@sperax/tool-gmgn';

const result = await gmgnExecutor.invoke('getWalletProfitStats', {"period":"<period>","walletAddress":"<walletAddress>"}, {
  messageId: 'msg-1',
});

console.log(result.content); // prose summary written for the model to read
console.log(result.state);   // typed data payload for your own UI

Give it to a model

import Anthropic from '@anthropic-ai/sdk';
import { GmgnManifest, gmgnExecutor } from '@sperax/tool-gmgn';

const client = new Anthropic();

const response = await client.messages.create({
  model: 'claude-opus-4-8',
  max_tokens: 1024,
  messages: [{ role: 'user', content: 'Ask something this tool can answer' }],
  tools: GmgnManifest.api.map((api) => ({
    name: api.name,
    description: api.description,
    input_schema: api.parameters,
  })),
});

for (const block of response.content) {
  if (block.type !== 'tool_use') continue;
  const result = await gmgnExecutor.invoke(block.name, block.input, { messageId: response.id });
  console.log(result.content);
}

GmgnManifest.api is already in JSON-Schema form, so it maps onto any tool-calling API — Anthropic, OpenAI, the Vercel AI SDK, or an MCP server — without translation.

Every executor returns a BuiltinToolResult — { success, content, state }. content is prose written for the model to read; state is the typed data payload for your own code. Executors never throw: a failed call comes back as { success: false, content: '<reason>' }, so a network blip degrades the answer instead of crashing the agent loop.

Configuration — required

This tool needs a backend you control. It will not work on a bare npm install alone.

The upstream API requires a secret key. That key is deliberately not bundled here — shipping it in an npm package would leak it to every consumer. Instead the executor calls a SperaxOS /webapi/* route, which holds the key server-side and injects it. That route is session-authenticated, so the public deployment at https://chat.sperax.io (the default origin) answers 401 to anonymous callers.

To use this tool you need one of:

• a SperaxOS deployment of your own, or
• any HTTP endpoint that implements the same request shape and supplies the key.

Point the package at it before importing the tool — the URL is resolved once, when the module first loads:

SPERAX_API_BASE_URL=https://my-speraxos.example.com

or in code:

import { configureSperaxApi } from '@sperax/agent-tools-core';

configureSperaxApi({ baseUrl: 'https://my-speraxos.example.com' });

// import the tool only after configuring, so the path resolves against your origin
const { gmgnExecutor } = await import('@sperax/tool-gmgn');

Inside a browser that already serves those routes at its own origin, requests stay same-origin and no configuration is needed.

If you want a tool that runs with zero setup, use one of the standalone tools — those call public APIs directly and need no key, no origin, and no backend.

Tool identifier

sperax-gmgn

API reference

getWalletProfitStats

Get wallet profit statistics for a Solana wallet including PnL (realized & unrealized), total trades, win rate, buy/sell volume, and average hold time. Displays a wallet performance card in chat.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | period | string | no | Time period: 1d, 7d, or 30d (default 7d) | | walletAddress | string | yes | Solana wallet address (base58) |

getWalletSocialInfo

Get wallet social info including Twitter/X handle, wallet tags (smart_money, kol, whale), funding source, and activity timestamps.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | walletAddress | string | yes | Solana wallet address (base58) |

getTokenInfo

Get detailed token information including name, symbol, market cap, holders, volume, price, liquidity, and creation time for a Solana token.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | tokenCa | string | yes | Solana token contract address (mint) |

getTokenTrades

Get recent trade history for a Solana token. Optionally filter by trader type: "smart" for smart money only, "kol" for Key Opinion Leaders, or "all" for all traders.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | limit | number | no | Maximum number of results to return (default 20, max 100) | | tag | string | no | Filter by trader tag: smart, kol, or all (default all) | | tokenCa | string | yes | Solana token contract address (mint) |

getTokenTopHolders

Get the top holders of a Solana token including balance, percentage of supply, USD value, and holder tags.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | limit | number | no | Maximum number of results to return (default 20, max 100) | | tokenCa | string | yes | Solana token contract address (mint) |

getTrendingTokens

Get trending/new Solana token rankings. Filter by timeframe (1h, 6h, 24h) and sort by swaps, volume, market_cap, or price_change.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | limit | number | no | Maximum number of results to return (default 20, max 100) | | orderby | string | no | Sort by: swaps, volume, market_cap, price_change (default swaps) | | timeframe | string | no | Timeframe: 1h, 6h, or 24h (default 24h) |

getTokenList

Get a list of Solana tokens sorted by market cap or volume. Useful for top token overview.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | limit | number | no | Maximum number of results to return (default 20, max 100) | | orderby | string | no | Sort by: market_cap, volume_24h, price_change_24h (default market_cap) |

Types

Shared types come from @sperax/agent-tools-core: BuiltinToolManifest, BuiltinToolResult, BuiltinToolContext, and the BaseExecutor class every tool executor extends.

Related

• @sperax/agent-tools-core — the tool contract
• All SperaxOS agent tools — tool-gmgn is one of many
• SperaxOS — the agent workspace these tools were built for

License

Apache-2.0