Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tickdb.ai/llms.txt

Use this file to discover all available pages before exploring further.

Welcome to the TickDB Online Documentation. TickDB is a developer-first unified real-time market data API that provides access to real-time and historical market data across multiple financial markets through a single connection, allowing developers to focus on products and strategies without managing multiple data sources or protocols.

​
What is TickDB?

TickDB is built for developers who require reliable, low-latency, and production-grade market data. Through one connection, you can seamlessly access market data across Forex, precious metals, indices, US stocks, HK stocks, A-shares, and cryptocurrencies. TickDB supports multiple data types, including tick-level trades, order book depth, and candlestick (K-line) data,
and can be accessed via REST APIs and WebSocket streams, making it suitable for quantitative trading, real-time market systems, trading platforms, and data analytics.

​
Key Features

  • Unified Access
    One API covering multiple markets and asset classes
  • Real-time Data
    WebSocket-based streaming suitable for real-time market applications
  • Multi-Market Support
    Forex, precious metals, indices, US stocks, HK stocks, A-shares, and crypto
  • Developer-Friendly
    REST APIs and WebSocket with clear interfaces, complete documentation, and practical examples
  • AI-Friendly
    Standardized SKILL file enabling AI assistants to understand and invoke all APIs automatically

​
AI Integration

TickDB provides a standardized SKILL file for AI assistant integration. Example: Enter the following prompt in your AI assistant to get started:
Read https://github.com/TickDB/tickdb-unified-realtime-marketdata-api/blob/main/SKILL/SKILL.md and install it as a Skill (name: tickdb-market-data), then query the real-time gold price.

​
Typical Use Cases

  • Quantitative Trading
    Real-time market data source for algorithmic and strategy systems
  • Market Dashboards
    Live price displays, asset tracking, and portfolio monitoring
  • Trading Applications
    Building TradingView-like market interfaces and charting systems
  • Data Analytics & Backtesting
    Historical market analysis, research, and strategy backtesting
  • Financial Services Integration
    Integration into existing trading platforms or financial infrastructure

​
Documentation Sections

​
Getting Started

  • Quick Start - Get up and running in minutes
  • Changelog - Version update history

​
REST API

​
Market Data APIs

  • Available Symbols - Query supported trading symbols
  • Ticker Snapshot - Real-time market ticker data
  • Historical K-Line - Historical candlestick data for completed periods
  • Real-time K-Line - Current period K-line data being formed
  • Order Book - Real-time order book depth data
  • Recent Trades - Latest trade executions
  • Kline Periods - Supported K-line period list

​
Stock Market APIs

  • Intraday Data - Intraday time-series data for stocks
  • Stock Information - Detailed stock information and fundamentals
  • Trading Sessions - Market trading session information
  • Trading Calendar - Trading days list query
  • Market Metrics - Comprehensive market metrics data
  • Capital Flow - Stock capital flow data

​
WebSocket Docs

  • Quick Start - WebSocket connection and subscription guide
  • Channels & Messages - Channel subscription and message formats

​
Reference

  • Data Specification - Symbol naming and formats
  • Error Codes - Error codes and handling
Docs Version: v1.0.1