Skip to main content

CloudQuote Financial Data

The @tokenring-ai/cloudquote package provides comprehensive financial data tools for TokenRing agents, enabling access to real-time pricing information, historical data, price ticks, market leaders, and news headlines for securities through the CloudQuote API and NewsRPM services.

User Guide​

Overview​

The @tokenring-ai/cloudquote package provides financial data tools for TokenRing agents. It integrates with the CloudQuote financial data API and NewsRPM news service to deliver real-time market data, historical price information, intraday ticks, market leaders, and news headlines. The package includes robust error handling, timezone-aware date formatting, automatic link generation for news headlines, and full RPC API support for programmatic access.

Key Features​

  • Real-time Quote Data: Retrieve pricing and metadata for single or multiple securities
  • Historical Price Data: Fetch daily historical price data with timezone-aware formatting
  • Intraday Price Ticks: Get intraday price data with time, price, and volume information
  • Market Leaders: Access lists of most active stocks, percentage gainers, and percentage losers
  • News Headlines: Retrieve news headlines for specified ticker symbols within date ranges (via NewsRPM)
  • Price Chart URLs: Generate price chart URLs for securities
  • RPC Endpoints: Full RPC API for programmatic access to all CloudQuote functionality
  • Robust Error Handling: Custom error types for API-related issues with detailed diagnostics
  • Timezone-Aware Formatting: All dates are formatted in America/New_York timezone
  • Automatic Link Generation: News headline links are automatically populated when available

Chat Commands​

This package does not define chat commands. All functionality is exposed through:

  • Tools: Available for agent invocation via the chat interface
  • RPC Endpoints: Available for programmatic access via the RPC service

Tools​

The package provides the following tools that can be used in TokenRing agents:

Tool NameDescription
cloudquote_getQuoteRetrieve pricing and metadata for given security symbols
cloudquote_getLeadersGet a list of stocks that are notable today (most active, gainers, losers)
cloudquote_getPriceTicksFetch intraday price ticks (time, price, volume) for a symbol
cloudquote_getPriceHistoryFetch historical daily price data for a symbol
cloudquote_getHeadlinesBySecurityRetrieve news headlines for one or more ticker symbols within a specified time range

cloudquote_getQuote​

Retrieve pricing and metadata for given security symbols.

Parameters:

ParameterTypeRequiredDescription
symbolsstring[]YesArray of ticker symbols to fetch (e.g., ['AAPL', 'GOOGL', 'MSFT'])

Example Usage:

const result = await agent.invokeTool('cloudquote_getQuote', {
  symbols: ['AAPL', 'GOOGL', 'MSFT']
});

Response Schema: The response follows the CloudQuoteQuoteSchema which includes core identification fields (Symbol, Name), price fields (Price, PrevClose, Ask, Bid, High, Low, Open), calculated fields (Change, ChangePercent), volume fields, exchange information, and many more fields as defined in schema.ts.

cloudquote_getLeaders​

Get a list of stocks that are notable today (most active by volume, highest percent gainers, biggest percent losers).

Parameters:

ParameterTypeRequiredDescription
list"MOSTACTIVE" | "PERCENTGAINERS" | "PERCENTLOSERS"YesType of list
type"STOCK" | "ETF"NoSecurity type
limitnumber (1-50)NoMax number of results
minPricenumberNoMinimum price filter
maxPricenumberNoMaximum price filter

Example Usage:

const result = await agent.invokeTool('cloudquote_getLeaders', {
  list: 'PERCENTGAINERS',
  type: 'STOCK',
  limit: 10
});

Available List Types:

  • MOSTACTIVE - Most active stocks by volume
  • PERCENTGAINERS - Highest percentage gainers
  • PERCENTLOSERS - Biggest percentage losers

cloudquote_getPriceTicks​

Fetch intraday price ticks (time, price, volume) for a symbol.

Parameters:

ParameterTypeRequiredDescription
symbolstringYesTicker symbol

Important: When using getPriceTicks, request a data range 5 minutes ahead and behind the time you are looking for.

Example Usage:

const result = await agent.invokeTool('cloudquote_getPriceTicks', {
  symbol: 'AAPL'
});

Response Format: The response is an array of tuples where each tuple contains:

  • Index 0: Date string in YYYY-MM-DD format (America/New_York timezone)
  • Index 1: Price (number)
  • Index 2: Cumulative Volume (number)

cloudquote_getPriceHistory​

Fetch historical daily price data for a symbol.

Parameters:

ParameterTypeRequiredDescription
symbolstringYesTicker symbol
fromstringNoStart date (YYYY-MM-DD). Must be at least 1 day before the date requested
tostringNoEnd date (YYYY-MM-DD). Must be at least 1 day after the date requested

Important: When using getPriceHistory, request a date range that is 1 day ahead and 1 day behind the date you want to analyze.

Example Usage:

const result = await agent.invokeTool('cloudquote_getPriceHistory', {
  symbol: 'AAPL',
  from: '2024-01-14',
  to: '2024-01-16'
});

Response Format: The response is an array of tuples where each tuple contains:

  • Index 0: Date string in YYYY-MM-DD format (America/New_York timezone)
  • Index 1: Open price
  • Index 2: High price
  • Index 3: Low price
  • Index 4: Close price
  • Index 5: Cumulative Volume
  • Index 6: Adjusted close price

cloudquote_getHeadlinesBySecurity​

Retrieve news headlines for one or more ticker symbols within a specified time range. Note: This tool uses the NewsRPM API, not the CloudQuote API.

Parameters:

ParameterTypeRequiredDescription
symbolsstringYesComma-separated ticker symbols (e.g., 'GOOG,AAPL')
startnumberNoNumber of records to skip before returning results
countnumber (1-100)NoNumber of records to retrieve (max 100)
minDatestringNoArticle publication date-time (ISO 8601) for start of date-time range
maxDatestringNoArticle publication date-time (ISO 8601) for start of date-time range

Important: This tool uses the getHeadlinesBySecurity service method, which makes requests to http://api.newsrpm.com (NewsRPM API), not the CloudQuote API. The same API key is used for authentication.

Example Usage:

const result = await agent.invokeTool('cloudquote_getHeadlinesBySecurity', {
  symbols: 'AAPL',
  start: 0,
  count: 10,
  minDate: '2024-01-01T00:00:00Z',
  maxDate: '2024-01-15T23:59:59Z'
});

Automatic Link Generation: The tool automatically populates the link field for headlines that have both bodyId and slug fields using the pattern: https://www.financialcontent.com/article/{slug}

Configuration​

The package supports configuration via environment variables or explicit plugin configuration.

Environment Variables​

VariableTypeRequiredDescription
CLOUDQUOTE_API_KEYstringYes (if not provided in config)CloudQuote API key for authentication

Configuration Schema​

# TokenRing application configuration
cloudquote:
  apiKey: "your-cloudquote-api-key"

Plugin Installation​

import tokenringPlugin from "@tokenring-ai/cloudquote";

// Option 1: Use environment variable (recommended)
app.installPlugin(tokenringPlugin);

// Option 2: Provide explicit configuration
app.installPlugin(tokenringPlugin, {
  cloudquote: {
    apiKey: "your-api-key"
  }
});

Note: The plugin automatically registers both tools (for chat/agent interaction) and RPC endpoints (for programmatic access). The service is only initialized if an API key is provided (either via environment variable or explicit configuration).

Integration​

The CloudQuote package integrates with the following TokenRing components:

  • @tokenring-ai/app: Base application framework with service management
  • @tokenring-ai/agent: Agent orchestration system for tool execution
  • @tokenring-ai/chat: Chat service and tool definitions
  • @tokenring-ai/rpc: RPC service for endpoint registration
  • @tokenring-ai/utility: HTTP utilities and helpers

Best Practices​

API Key Management​

  • Never hardcode API keys in source code
  • Use environment variables for production deployments
  • Rotate API keys regularly for security

Date Handling for Historical Data​

When using getPriceHistory, request a date range that is 1 day ahead and 1 day behind the date you want to analyze:

// Incorrect - may not return data for the requested date
const history = await agent.invokeTool('cloudquote_getPriceHistory', {
  symbol: 'AAPL',
  from: '2024-01-15',
  to: '2024-01-15'
});

// Correct - request 1 day buffer on each side
const history = await agent.invokeTool('cloudquote_getPriceHistory', {
  symbol: 'AAPL',
  from: '2024-01-14',  // Start 1 day before
  to: '2024-01-16'     // End 1 day after
});

Note: The tool automatically converts timestamps to America/New_York timezone and formats dates as YYYY-MM-DD.

Timezone-Aware Formatting​

Price history and tick data are returned with timezone-aware dates. The service uses America/New_York timezone for date formatting:

// Timestamps are automatically converted to America/New_York timezone
const ticks = await agent.invokeTool('cloudquote_getPriceTicks', {
  symbol: 'AAPL'
});
// Result dates are in YYYY-MM-DD format (America/New_York timezone)

Timeframe Handling for Price Ticks​

For getPriceTicks, the API expects you to request a data range 5 minutes ahead and behind the time you are looking for. The tool fetches all available intraday ticks for the symbol:

// Fetches all intraday ticks for the symbol
const ticks = await agent.invokeTool('cloudquote_getPriceTicks', {
  symbol: 'AAPL'
});
// Returns array of [date, price, cumulativeVolume] tuples

Note: The tool does not filter by time range - it returns all available intraday data. You may need to filter the results client-side based on your specific time requirements.

The tool automatically fills in links for news headline data when both bodyId and slug are available:

const headlines = await agent.invokeTool('cloudquote_getHeadlinesBySecurity', {
  symbols: 'AAPL'
});

// Links are automatically populated when available
headlines.rows.forEach(headline => {
  if (headline.bodyId && headline.slug) {
    console.log(headline.link); // Automatically set to
    // https://www.financialcontent.com/article/{slug}
  }
});

Rate Limiting​

Be mindful of API rate limits when making multiple requests. The service includes a 10-second timeout for requests using AbortController.

Important: The getHeadlinesBySecurity method uses a different API endpoint (http://api.newsrpm.com) than other methods (https://api.cloudquote.io). Both use the same API key for authentication.

Performance Considerations​

  • Use limit parameters in getLeaders to control result size
  • Set appropriate start and count values for large result sets
  • Consider caching frequently accessed data to reduce API calls
  • For getHeadlinesBySecurity, use count parameter to limit results (max 100)

Error Handling​

Always handle CloudQuoteError exceptions appropriately:

import {CloudQuoteError} from "@tokenring-ai/cloudquote";

try {
  const result = await agent.invokeTool('cloudquote_getQuote', {
    symbols: ['AAPL']
  });
} catch (err) {
  if (err instanceof CloudQuoteError) {
    console.error(`API Error: ${err.message}`);
    console.error(`Details: ${err.cause}`);
    // Handle API-specific errors
  } else {
    console.error(`Unexpected error: ${err}`);
    // Handle other errors
  }
}

Developer Reference​

Core Components​

CloudQuoteService​

The CloudQuoteService is the core service that manages authentication and API communication with CloudQuote. It extends HttpService and implements the TokenRingService interface.

Service Properties​
PropertyTypeDescription
namestringService identifier ("CloudQuote")
descriptionstringHuman-readable service description
baseUrlstringCloudQuote API endpoint URL (https://api.cloudquote.io)
timeoutnumberRequest timeout in milliseconds (10,000)
Constructor​
constructor(app: TokenRingApp, options: CloudQuoteServiceOptions)

Parameters:

  • app (TokenRingApp): The TokenRing application instance for service management and logging
  • options (CloudQuoteServiceOptions): Configuration options
    • apiKey (string): CloudQuote API key (required)

Example:

import CloudQuoteService from "@tokenring-ai/cloudquote";

const service = new CloudQuoteService(app, {
  apiKey: process.env.CLOUDQUOTE_API_KEY
});
Service Methods​
getJSON(apiPath: string, params: Record<string, string | number | undefined | null>): Promise<T>​

Generic method for making CloudQuote API requests. Handles query parameter serialization and error handling.

Parameters:

  • apiPath (string): API endpoint path (e.g., 'fcon/getQuote')
  • params (Record<string, string | number | undefined | null>): Query parameters

Returns: Promise<T> - Response data

Example:

const quote = await cloudQuoteService.getJSON('fcon/getQuote', { 
  symbol: 'AAPL,GOOGL' 
});
getHeadlinesBySecurity(params: any): Promise<any>​

Retrieve news headlines from the NewsRPM API (not CloudQuote). This method handles the API communication to NewsRPM and returns headline data. Note: This method uses a different base URL (http://api.newsrpm.com) than other CloudQuote methods.

Parameters:

  • params (any): Headline query parameters
    • symbols (string): Comma-separated ticker symbols
    • start (number): Number of records to skip
    • count (number): Number of records to retrieve (max 100)
    • minDate (string): Start date-time in ISO 8601 format
    • maxDate (string): End date-time in ISO 8601 format

Returns: Promise<any> - News headlines data

Example:

const headlines = await cloudQuoteService.getHeadlinesBySecurity({
  symbols: 'AAPL,GOOGL',
  start: 0,
  count: 10,
  minDate: '2024-01-01T00:00:00Z',
  maxDate: '2024-01-15T23:59:59Z'
});

Important: This method makes requests to http://api.newsrpm.com, not the CloudQuote API. The same API key is used for authentication.

getPriceChart(params: any): { svgDataUri: string }​

Generate a price chart URL for a security. This method returns a URL that can be directly used as an image source. Note: This is a service method only and is not exposed as a tool. The method returns a static URL string, not an SVG data URI.

Parameters:

  • params (any): Chart parameters
    • symbol (string): Ticker symbol
    • interval (string): Chart interval (e.g., '1D', '5D', '1M')

Returns: { svgDataUri: string } - Chart URL string

Example:

const chart = cloudQuoteService.getPriceChart({
  symbol: 'AAPL', 
  interval: '1D' 
});
console.log(chart.svgDataUri);
// Output: "https://chart.financialcontent.com/Chart?..."

Note: The returned URL is a static URL from financialcontent.com Chart service, not an actual SVG data URI. The svgDataUri property name is a misnomer - it returns a regular URL string.

Error Handling​

The service uses CloudQuoteError for all API-related errors:

export class CloudQuoteError extends Error {
  constructor(public readonly cause: unknown, message: string) {
    super(message);
    this.name = "CloudQuoteError";
  }
}

Common Error Conditions:

  • Missing API key (throws error on initialization)
  • Invalid API key (returns CloudQuoteError)
  • Network errors (returns CloudQuoteError with HTTP status)
  • API request failures (returns CloudQuoteError)

Example:

import CloudQuoteService, { CloudQuoteError } from "@tokenring-ai/cloudquote";

try {
  const service = new CloudQuoteService(app, { 
    apiKey: process.env.CLOUDQUOTE_API_KEY 
  });
  await service.getJSON('fcon/getQuote', { symbol: 'AAPL' });
} catch (err) {
  if (err instanceof CloudQuoteError) {
    console.error(`CloudQuote Error: ${err.message}`);
    console.error(`Cause: ${err.cause}`);
  }
}

Services​

CloudQuoteService Implementation​

The CloudQuoteService extends HttpService from @tokenring-ai/utility and implements TokenRingService.

Service Registration:

The service is automatically registered when the plugin is installed with a valid API key:

import tokenringPlugin from "@tokenring-ai/cloudquote";

app.installPlugin(tokenringPlugin, {
  cloudquote: {
    apiKey: process.env.CLOUDQUOTE_API_KEY
  }
});

Manual Registration:

import CloudQuoteService from "@tokenring-ai/cloudquote";

app.addServices(new CloudQuoteService(app, {
  apiKey: process.env.CLOUDQUOTE_API_KEY
}));

Provider Documentation​

This package does not use a provider architecture. The CloudQuoteService is directly instantiated with API key configuration.

RPC Endpoints​

This package defines the following RPC endpoints under /rpc/cloudquote:

EndpointMethodInput ParametersResponseAPI Endpoint
getQuotequery{ symbols: string[] }{ rows: CloudQuoteQuoteSchema[] }fcon/getQuote
getPriceHistoryquery{ symbol: string, from?: string, to?: string }{ rows: CloudQuoteQuoteHistoricalItemSchema[] }fcon/getPriceHistory
getPriceTicksquery{ symbol: string }{ rows: CloudQuoteQuoteIntradayItemSchema[] }fcon/getPriceTicks
getLeadersquery{ list: "MOSTACTIVE"|"PERCENTGAINERS"|"PERCENTLOSERS", type?: "STOCK"|"ETF", limit?: number, minPrice?: number, maxPrice?: number }{ rows: CloudQuoteQuoteSchema[] }fcon/getLeaders
getHeadlinesBySecurityquery{ symbols: string, start?: number, count?: number, minDate?: string, maxDate?: string }{ data: any }newsrpm/getHeadlinesBySecurity
getPriceChartquery{ symbol: string, interval: string }{ svgDataUri: string }N/A (URL generation)

Note: The getHeadlinesBySecurity endpoint uses the NewsRPM API (http://api.newsrpm.com) instead of the CloudQuote API. The getPriceChart endpoint generates a chart URL from financialcontent.com.

RPC Endpoint Registration​

The RPC endpoint is automatically registered when the plugin is installed:

import tokenringPlugin from "@tokenring-ai/cloudquote";

app.installPlugin(tokenringPlugin, {
  cloudquote: {
    apiKey: process.env.CLOUDQUOTE_API_KEY
  }
});

RPC Usage Example​

import { createRPCClient } from "@tokenring-ai/rpc";

const rpcClient = createRPCClient('/rpc/cloudquote');

// Get quote for multiple symbols
const quote = await rpcClient.getQuote({ symbols: ['AAPL', 'GOOGL'] });
console.log(quote.rows);

// Get price history
const history = await rpcClient.getPriceHistory({ 
  symbol: 'AAPL', 
  from: '2024-01-14', 
  to: '2024-01-16' 
});
console.log(history.rows);

// Get market leaders
const leaders = await rpcClient.getLeaders({ 
  list: 'PERCENTGAINERS', 
  limit: 10 
});
console.log(leaders.rows);

// Get news headlines (uses NewsRPM API)
const headlines = await rpcClient.getHeadlinesBySecurity({
  symbols: 'AAPL',
  count: 10
});
console.log(headlines.data);

// Get price chart URL
const chart = await rpcClient.getPriceChart({
  symbol: 'AAPL',
  interval: '1D'
});
console.log(chart.svgDataUri);

Usage Examples​

Getting Real-time Quotes​

const result = await agent.invokeTool('cloudquote_getQuote', {
  symbols: ['AAPL', 'GOOGL', 'MSFT']
});

// Response contains pricing and metadata for each symbol
console.log(result);
/*
{
  rows: [
    {
      Symbol: "AAPL",
      Price: 175.00,
      Change: 2.50,
      Volume: 50000000,
      // ... additional metadata (see CloudQuoteQuoteSchema)
    },
    // ... additional symbols
  ]
}
*/

Getting Market Leaders​

// Get top 10 percentage gainers
const gainers = await agent.invokeTool('cloudquote_getLeaders', {
  list: 'PERCENTGAINERS',
  type: 'STOCK',
  limit: 10
});

// Get most active stocks by volume
const mostActive = await agent.invokeTool('cloudquote_getLeaders', {
  list: 'MOSTACTIVE',
  limit: 20
});

// Get biggest percentage losers
const losers = await agent.invokeTool('cloudquote_getLeaders', {
  list: 'PERCENTLOSERS',
  type: 'ETF',
  limit: 15
});

Getting Historical Price Data​

// Get historical data for AAPL with proper date range
const history = await agent.invokeTool('cloudquote_getPriceHistory', {
  symbol: 'AAPL',
  from: '2024-01-14',  // Start 1 day before
  to: '2024-01-16'     // End 1 day after
});

// Response contains historical price data with dates in YYYY-MM-DD format
console.log(history);
/*
{
  rows: [
    ["2024-01-14", 150.00, 152.00, 148.00, 151.00, 50000000, 150.50],
    // ... additional historical records
  ]
}
*/

Getting Intraday Price Ticks​

// Get intraday price ticks for AAPL
const ticks = await agent.invokeTool('cloudquote_getPriceTicks', {
  symbol: 'AAPL'
});

// Response contains array of [date, price, volume] tuples
console.log(ticks);
/*
{
  rows: [
    ["2024-01-15", 175.00, 2000000],  // [date, price, cumulativeVolume]
    // ... additional tick data
  ]
}
*/

Getting News Headlines​

// Get news headlines for AAPL and GOOGL
const headlines = await agent.invokeTool('cloudquote_getHeadlinesBySecurity', {
  symbols: 'AAPL,GOOGL',
  start: 0,
  count: 10,
  minDate: '2024-01-01T00:00:00Z',
  maxDate: '2024-01-15T23:59:59Z'
});

// Response contains news headlines with automatically populated links
console.log(headlines);
/*
{
  rows: [
    {
      title: "Apple Reports Record Quarterly Earnings",
      bodyId: "12345",
      slug: "apple-records-earnings",
      link: "https://www.financialcontent.com/article/apple-records-earnings",
      // Auto-populated
      published: "2024-01-15T10:30:00Z"
    },
    // ... additional headlines
  ]
}
*/

Testing​

Running Tests​

# Run all tests
bun test

# Run tests in watch mode
bun test:watch

# Generate coverage report
bun test:coverage

Test Configuration​

The package uses vitest for testing with the configuration in vitest.config.ts.

Test Structure​

Note: This package does not currently have test files. When adding tests, consider the following test cases:

  • Tool Input Validation: Ensure required parameters are validated (e.g., non-empty symbols array for getQuote)
  • Service Initialization: Test service creation with valid and missing API keys
  • API Request Parameters: Verify correct parameter serialization and API endpoint calls
  • Response Handling: Test parsing and transformation of API responses
  • Error Cases: Test CloudQuoteError handling for network errors, invalid responses, and API failures
  • Timezone Conversion: Verify date-fns-tz conversion to America/New_York timezone
  • Automatic Link Generation: Test that headlines with bodyId and slug get correct link URLs
  • RPC Endpoint Registration: Verify RPC endpoints are properly registered and callable

Dependencies​

Package Dependencies​

Production Dependencies:

PackageVersionPurpose
@tokenring-ai/app0.2.0Base application framework and plugin management
@tokenring-ai/agent0.2.0Agent system and service management
@tokenring-ai/chat0.2.0Chat interface and tool definitions
@tokenring-ai/rpc0.2.0RPC service for endpoint registration
@tokenring-ai/utility0.2.0Shared utilities and HTTP services
date-fns-tz^3.2.0Timezone-aware date manipulation
zod^4.3.6Runtime type checking and schema validation

Development Dependencies:

PackageVersionPurpose
vitest^4.1.1Unit testing framework
typescript^6.0.2TypeScript compiler

Core Dependencies​

  • @tokenring-ai/app: Base application framework with service management and plugin architecture
  • @tokenring-ai/agent: Agent system for orchestrating tool usage and execution
  • @tokenring-ai/chat: Chat interface, tool definitions, and RPC service integration
  • @tokenring-ai/rpc: RPC service for endpoint registration and programmatic access
  • @tokenring-ai/utility: HTTP utilities including HttpService base class and doFetchWithRetry

Utility Packages​

  • @tokenring-ai/utility/http/HttpService: Base HTTP service class for making API requests
  • @tokenring-ai/utility/http/doFetchWithRetry: HTTP request utility with retry logic
  • date-fns-tz: Timezone-aware date formatting library
  • zod: Schema validation and type inference

External Services​

  • CloudQuote API (https://api.cloudquote.io): Financial data API for quotes, history, ticks, and leaders
  • NewsRPM API (http://api.newsrpm.com): News headlines API for security-related news

Schema Definitions​

The package exports Zod schemas for type-safe data validation.

CloudQuoteQuoteSchema​

Comprehensive schema for quote data. All fields are optional as they depend on the API response. The schema includes the following field categories:

Core identification fields:

  • SymbolID, Symbol, Name, ShortName

Price fields:

  • Price, PrevClose, Ask, Bid, High, Low, Open, AfterHoursPrice

Calculated price fields (added by transformRow):

  • Change, ChangePercent

Size fields:

  • AskSize, BidSize

Time fields:

  • LastTradeTime, AfterHoursTradeTime

Volume fields:

  • Volume, AverageVolume, AvgVolume1M, AvgVolume1W, AvgVolume3M, AvgVolume52, AvgVolume6M, AvgVolumeYTD

Dividend fields (feature gated):

  • AnnualDividend, TTMDividend, YTDDividend, LatestDividendDate, LatestDividend

Financial fields (feature gated):

  • EPS, SharesOutstanding

Exchange information:

  • ExchangeName, ExchangeShortName, ExchangePrefixCode, ExchangeDefaultCurrency

Security type information (added by typeMap):

  • SecurityTypeName, SecurityTypeCode

Currency information (added by currencyMap):

  • NominalCurrencyCode, NominalCurrencyName

Starting prices:

  • StartingPrice1M, StartingPrice1W, StartingPrice3M, StartingPrice52, StartingPrice6M, StartingPriceYTD

Low values and dates:

  • Low1M, Low1MDate, Low1W, Low1WDate, Low3M, Low3MDate, Low52, Low52Date, Low6M, Low6MDate, LowYTD

High values and dates:

  • High1M, High1MDate, High1W, High1WDate, High3M, High3MDate, High52, High52Date, High6M, High6MDate, HighYTD

Chart fields:

  • ChartStartTime, ChartEndTime, HolidayName

Moving averages:

  • MovingAverage50, MovingAverage200

Recent close fields:

  • MostRecentClose, MostRecentCloseDate, LessRecentClose, LessRecentCloseDate

Other fields:

  • Delay, CIK

CloudQuoteQuoteHistoricalItemSchema​

Tuple schema for historical daily price data:

export const CloudQuoteQuoteHistoricalItemSchema = z.tuple([
  z.number().describe("Timestamp in epoch nanoseconds"),
  z.number().describe("Open price"),
  z.number().describe("High price"),
  z.number().describe("Low price"),
  z.number().describe("Close price"),
  z.number().describe("Cumulative Volume"),
  z.number().describe("Adjusted close price"),
]);

Note: The tools automatically convert the timestamp (index 0) to a date string in YYYY-MM-DD format using the America/New_York timezone.

CloudQuoteQuoteIntradayItemSchema​

Tuple schema for intraday price ticks:

export const CloudQuoteQuoteIntradayItemSchema = z.tuple([
  z.number().describe("Timestamp in epoch nanoseconds"),
  z.number().describe("Price"),
  z.number().describe("Cumulative Volume")
]);

Note: The tools automatically convert the timestamp (index 0) to a date string in YYYY-MM-DD format using the America/New_York timezone.

Package Structure​

pkg/cloudquote/
├── CloudQuoteService.ts    # Core service implementation
├── plugin.ts               # Plugin initialization and registration
├── tools.ts                # Tool registry
├── rpc/
│   ├── cloudquote.ts       # RPC endpoint definitions
│   └── schema.ts           # RPC schema definitions
├── tools/
│   ├── getHeadlinesBySecurity.ts  # News headlines tool
│   ├── getLeaders.ts              # Market leaders tool
│   ├── getPriceHistory.ts         # Historical price tool
│   ├── getPriceTicks.ts           # Intraday ticks tool
│   └── getQuote.ts                # Real-time quote tool
├── schema.ts               # Data schemas
├── index.ts                # Package exports
├── package.json            # Package configuration
└── vitest.config.ts        # Test configuration

Exports​

// Main exports from index.ts
export {default as CloudQuoteService, CloudQuoteError} from "./CloudQuoteService.ts";

// Tools are exported through tools.ts
export {default as tools} from "./tools.ts";

License​

MIT License - see LICENSE file for details.