Skip to main content

Installation

Runtime Support

Zero runtime dependencies — uses native fetch and Web Crypto APIs.

Quick Start

Configuration

Resources

Available resources:
The VQ SDK is for market data and developer-account operations. Place simulated orders with the separate Bot API. Webhook methods manage subscriptions; event delivery is not currently implemented.

Stock Screener

Use camelCase filter names in TypeScript. sortBy uses the API’s snake_case values. The maximum page size is 50; the async iterator fetches later pages automatically.
The paginator also offers .pages(), .take(count), and .toArray(). See the pagination guide for REST cursor details.

Usage Examples

Batch Quotes

Core quote payloads may omit absolute change and prevClose for crypto. Nullable crypto quote fields are included in the upcoming SDK compatibility release; until that package is published, do not interpret a zero fallback as provider data.

Technical Analysis

Analyst Consensus

Error Handling

Vercel AI SDK Integration

Security

  • API key is non-enumerable — hidden from console.log and JSON.stringify
  • Webhook verification uses constant-time comparison (double-HMAC)
  • Replay protection via timestamp tolerance window

GitHub

Source code, issues, and contributions