What is TickerTick-API CLAUDE.md?

A set of repository instructions for TickerTick, a documentation-only project describing a stock-news API. It explains the API's two endpoints, its query language, and the curated source lists in the docs folder.

Use it when editing the TickerTick API documentation, its query grammar, or the source lists, and when checking the documented feed and ticker-autocomplete endpoints.

It prevents developers from expecting application code or tests in a repository that mainly defines an API contract, meaning the documented behavior other systems should follow. It also clarifies that the backend is maintained elsewhere.

How hczhu/TickerTick-API configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to hczhu/TickerTick-API. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/hczhu/TickerTick-API/master/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/hczhu/TickerTick-API

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/hczhu/tickertick-api/claude-md/github.svg)](https://agentmods.dev/instructions/hczhu/tickertick-api/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/hczhu/tickertick-api/claude-md"><img src="https://agentmods.dev/badge/instructions/hczhu/tickertick-api/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/hczhu/tickertick-api/claude-md"><img src="https://agentmods.dev/badge/instructions/hczhu/tickertick-api/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 798 This file is loaded in full into every session.

When invoked 798 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00798	$0.00798
Opus 5.5	$0.00319	$0.00319
Sonnet 5.5	$0.00160	$0.00160
Haiku 4.5	$0.00080	$0.00080

Measured 2mo ago against content hash d26752612d5c, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

TickerTick-API CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 41 lines

How it starts

The opening of the file, as written. The whole thing — 41 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What this repo is

Documentation-only repository: it is the public API contract for the TickerTick stock-news API served at https://api.tickertick.com. There is no application code, build, lint, or test here — the deliverable is README.md (rendered on GitHub as the API docs) plus the curated source lists in docs/. The backend that actually implements and serves this API lives in a separate repository, TickerTick-backend-private; editing files here changes documentation, not API behavior.

The two endpoints (the contract)

GET /feed?q=<query>&n=<1-200>&last=<story_id> — latest matching stories, reverse-chronological. last paginates by an existing story's id (a 64-bit int passed as a string). Story time is epoch milliseconds (JS Date.now() semantics). Rate limit: 10 req/min per IP (enforced; >5 requests in any 30s window → 30s block).
GET /tickers?p=<prefix>&n=<count> — ticker / company-name autocomplete.

The query language (the core artifact)

A context-free grammar; the full grammar and operator/term tables are in README.md:

Operators: (and ...), (or ...), (diff query1 query2) (matches query1 but not query2).
Terms: z:TICKER (narrow), tt:TICKER / TT:TICKER (broad), s:DOMAIN (no dots/slashes, e.g. s:wsj), E:entity (lowercase, spaces → _), T:story_type.
T: story types: curated, earning, market, sec, sec_fin, trade, ugc, analysis, industry.

docs/Retrieve-most-important-news.md documents advanced terms that are NOT in the README's tables — notably tag:_best_ and story types like T:fin_news. The README term/type tables are not exhaustive; treat docs/ as authoritative for those.

docs/ source lists ↔ story types

The docs/*.txt files are curated lists of source-website domains that back the T: story-type terms:

top-news-sources.txt → backs T:curated and T:analysis
industry-publications.txt → backs T:industry
ugc-sources.txt → backs T:ugc (user-generated content: Reddit, forums)
analysis-sources.txt → analyst / Substack / blog sources

Read the full file on GitHub · 41 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 41 lines · 798 tokens per session scan A d26752612d5c

Subscribe to this mod's changes

TickerTick-API CLAUDE.md is an instructions file published in the GitHub repository hczhu/TickerTick-API (145 stars, last pushed 5mo ago), licensed MIT. It adds 798 tokens to every session, about $0.0032 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Backend and APIs stock stock-api stock-apis stock-news stock-news-feed stocks

TickerTick-API CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
TickerTick-API CLAUDE.mdhczhu/TickerTick-API	Instructions file	145	5mo ago	MIT	A	798	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

TickerTick-API: Instructions file for Claude Code