@sperax/tool-coingecko

Real-time cryptocurrency market data from CoinGecko

CoinGecko 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-coingecko

Usage

Call it directly

import { coingeckoExecutor } from '@sperax/tool-coingecko';

const result = await coingeckoExecutor.invoke('getTokenPrice', {"coinId":"<coinId>","symbol":"<symbol>"}, {
  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 { CoinGeckoManifest, coingeckoExecutor } from '@sperax/tool-coingecko';

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: CoinGeckoManifest.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 coingeckoExecutor.invoke(block.name, block.input, { messageId: response.id });
  console.log(result.content);
}

CoinGeckoManifest.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

None. This tool calls a public API directly and needs no key or origin configuration.

Tool identifier

sperax-coingecko

API reference

getTokenPrice

Get current price, market cap, 24h volume, and 24h price change for a cryptocurrency token. Pass coinId (e.g. "bitcoin") or symbol (e.g. "BTC").

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | coinId | string | no | CoinGecko coin ID (e.g. "bitcoin", "ethereum", "solana"). Preferred over symbol. | | symbol | string | no | Token symbol (e.g. "BTC", "ETH"). Used as fallback if coinId is not provided. |

getTrendingTokens

Get top 7 trending tokens on CoinGecko right now.

Takes no parameters.

searchTokens

Search for tokens by name or symbol. Returns a list of matching tokens.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | query | string | yes | Search query — token name or symbol (e.g. "uniswap", "LINK"). |

getMarketChart

Get historical price data for a token to display a price chart. Returns timestamps and prices.

| Parameter | Type | Required | Description | | --- | --- | --- | --- | | coinId | string | yes | CoinGecko coin ID (e.g. "bitcoin"). | | days | number | no | Number of days of history (e.g. 1, 7, 30, 90, 365). Default: 7. |

getGlobalData

Get global crypto market data: total market cap, BTC dominance, total volume, number of active cryptocurrencies.

Takes no parameters.

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-coingecko is one of many
• SperaxOS — the agent workspace these tools were built for

License

Apache-2.0