Skip to content
StockSync
Docs · Quickstart

Get started

Quickstart

StockSync serves canonical Robinhood Chain Stock Token data through three interfaces built on one core: a CLI, an MCP server for AI agents, and a TypeScript SDK. All three are read-only. They never sign, transfer, approve or trade, and nothing they return is investment advice.

Requirements

  • Node.js 22.12 or newer (24 recommended)
  • pnpm 11

Install dependencies from the repository root:

bash
pnpm install

Run the CLI

bash
pnpm --filter @stocksync/cli build
node packages/cli/dist/stocksync.mjs get NVDA

The build produces one file with no runtime dependencies. To type stocksync instead of the full path, add an alias:

bash
alias stocksync="node $(pwd)/packages/cli/dist/stocksync.mjs"
stocksync verify 0xd0601CE157Db5bdC3162BbaC2a2C8aF5320D9EEC --symbol NVDA --strict

Every command also accepts --json for scripts. See CLI.

Connect an AI agent

Build the MCP server, then register it with Claude Code using an absolute path:

bash
pnpm --filter @stocksync/mcp build
claude mcp add stocksync -- node /absolute/path/to/stocksync/packages/mcp/dist/stocksync-mcp.mjs

Then ask your agent something StockSync can answer, for example: “Is 0xd0601CE157Db5bdC3162BbaC2a2C8aF5320D9EEC the canonical NVDA Stock Token contract?” Setup for other MCP hosts is in MCP server.

Call the SDK

Inside the monorepo, add "@stocksync/core": "workspace:*" to a package’s dependencies:

ts
import { createStockSync, resolveConfig } from '@stocksync/core';

const stocksync = createStockSync({ config: resolveConfig(process.env) });

const { data: token, freshness } = await stocksync.getAsset('NVDA');
console.log(token?.deployments, token?.multiplier.current, freshness.fetchedAt);

See Core SDK for every method.

Before production

  • Public Robinhood Chain RPC endpoints are rate-limited. Set STOCKSYNC_RPC_URL_MAINNET to a dedicated provider. See Chain configuration.
  • Read Data semantics before displaying prices: quotes, token-equivalent values and Chainlink feed prices have different bases.
  • Only canonical verification establishes that a contract is a real Stock Token.