bitcoin-api AGENTS.md

A set of project instructions for a FastAPI application that provides Bitcoin fee and transaction data through web endpoints and AI-agent integrations.

In plain words
What is it for?
Use it when changing the Bitcoin API, its business logic, indexer, authentication, rate limits, or agent-integration documentation.
Why use it?
It gives coding agents the project's architecture, required workflows, and safety rules, including checks before restarting or deploying the service.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/bortlesboat/bitcoin-api/agents-md
Clone the repo
git clone --depth 1 https://github.com/Bortlesboat/bitcoin-api

Made for: Codex, OpenCode.

Per session 700 This file is loaded in full into every session.
When invoked 700 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00700 $0.00700
Opus 5 $0.00350 $0.00350
Sonnet 5 $0.00140 $0.00140
Haiku 4.5 $0.00070 $0.00070

Measured 2d ago against content hash c32face86007, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

bitcoin-api AGENTS.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 2d 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.

AGENTS.md · 46 lines

How it starts

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

Satoshi API — Bitcoin REST API (bitcoinsapi.com)

What this is

FastAPI application for Bitcoin fee intelligence, MCP-powered agents, and x402 pay-per-call Bitcoin data. The project-operated hosted deployment is intentionally paused for infrastructure review. Treat any restart or deployment as a production change and verify current operator authorization before promoting.

Architecture

  • src/bitcoin_api/routers/ — HTTP endpoint definitions, one file per category (28 routers)
  • src/bitcoin_api/services/ — Business logic layer (HTTP-agnostic, testable in isolation)
  • src/bitcoin_api/indexer/ — Address + transaction indexer (separate worker process)
  • src/bitcoin_api/main.py — App entrypoint, middleware, router registration, startup events
  • src/bitcoin_api/models.py — Pydantic request/response models (shared across routers)
  • src/bitcoin_api/config.py — Settings via pydantic-settings / env vars
  • src/bitcoin_api/auth.py — API key authentication
  • src/bitcoin_api/rate_limit.py — Free tier rate limiting
  • .github/copilot-instructions.md — GitHub Copilot/Coding Agent instructions for this repo
  • docs/AGENT_INTEGRATION.md — Copy-paste kit for adding Satoshi API to other agent-aware repos

Active workflows (run these, don't skip)

  • ./diagnose.sh — silo checks; run before any significant structural change
  • ./release.sh — tag + changelog + deploy; run for all releases
  • ./deploy-api.sh — auto-tags and deploys to production

Key rules

  • Tag before major changes: git tag v{version} && git push --tags
  • Run diagnose after structural changes: catches silo leaks and import errors
  • All new endpoints need unit tests in tests/
  • New routers MUST be registered in main.py — this is the #1 missed step
  • The hosted service is paused — do not assume hosted URLs are available or restart production from routine repo work. Test locally first.
  • /api/v1/rpc endpoint is used by bitcoin-mcp zero-config — don't break it

Content pages (not just API)

  • /history — Bitcoin History Explorer
  • /guide — Bitcoin Protocol Guide
  • /mcp-setup — MCP setup instructions
  • /bitcoin-mcp — Bitcoin MCP guide
  • /bitcoin-fee-intelligence — fee intelligence guide
  • /quickstart — full x402 quickstart
  • /x402/start — shortest first-paid-call x402 buyer path
  • /docs — OpenAPI docs (/api-docs redirects here for legacy links)

Read the full file on GitHub · 46 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.

  1. 2d ago First seen · 46 lines · 700 tokens per session scan A c32face86007

Subscribe to this mod's changes

bitcoin-api AGENTS.md is an instructions file published in the GitHub repository Bortlesboat/bitcoin-api (5 stars, last pushed 24d ago), licensed Apache-2.0. It adds 700 tokens to every session, about $0.0035 per session on Opus 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-31.