@sperax/tool-nft-market
v0.2.2
Published
NFT market overview — top collections, floor prices, volume, and search — an agent tool for SperaxOS.
Downloads
505
Maintainers
Readme
@sperax/tool-nft-market
NFT market overview — top collections, floor prices, volume, and search
NFT Market Overview 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-nft-marketUsage
Call it directly
import { nftMarketExecutor } from '@sperax/tool-nft-market';
const result = await nftMarketExecutor.invoke('getNftCollections', {"order":"<order>","page":1}, {
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 UIGive it to a model
import Anthropic from '@anthropic-ai/sdk';
import { NftMarketManifest, nftMarketExecutor } from '@sperax/tool-nft-market';
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: NftMarketManifest.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 nftMarketExecutor.invoke(block.name, block.input, { messageId: response.id });
console.log(result.content);
}NftMarketManifest.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-nft-market
API reference
getNftCollections
Get top NFT collections ranked by market cap or 24h volume. Returns floor price, market cap, volume, and price change data.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| order | string | no | Sort order — "market_cap_desc" (default) or "volume_desc" for highest 24h volume. |
| page | number | no | Page number (default 1). |
| perPage | number | no | Results per page (default 20, max 100). |
getNftDetail
Get detailed information about a specific NFT collection including description, total supply, unique owners, floor price change, and links.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| nftId | string | yes | CoinGecko NFT collection ID (e.g. "cryptopunks", "bored-ape-yacht-club"). |
searchNfts
Search for NFT collections by name. Returns matching collections with basic data.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| query | string | yes | Search query — collection name (e.g. "punk", "ape", "azuki"). |
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-nft-market is one of many
- SperaxOS — the agent workspace these tools were built for
License
Apache-2.0
