bitcoin-api copilot-instructions.md

Repository instructions for Satoshi API, a Bitcoin fee-information service for developers and agents. They describe its FastAPI structure, versioned endpoints, payment paths, and MCP integration.

In plain words
What is it for?
Use them when modifying fee intelligence, HTTP routes, hosted payment flows, generated clients, or the Bitcoin MCP fallback.
Why use it?
They help preserve API compatibility and the documented payment and agent access paths when the service changes.

Instructions file for GitHub Copilot

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/copilot-instructions
Clone the repo
git clone --depth 1 https://github.com/Bortlesboat/bitcoin-api

Made for: GitHub Copilot.

Per session 660 This file is loaded in full into every session.
When invoked 660 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.00660 $0.00660
Opus 5 $0.00330 $0.00330
Sonnet 5 $0.00132 $0.00132
Haiku 4.5 $0.00066 $0.00066

Measured 2d ago against content hash 52d95f71ae4f, 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 copilot-instructions.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.

.github/copilot-instructions.md · 52 lines

How it starts

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

Satoshi API Copilot Instructions

Satoshi API is Bitcoin fee intelligence for agents and developers. Lead with outcomes: save money on fees, know when to send, and stop watching block explorers. Avoid selling the product by endpoint counts.

Project Shape

  • FastAPI app in src/bitcoin_api/; routers are thin HTTP wrappers and business logic belongs in src/bitcoin_api/services/.
  • Canonical public API paths use /api/v1. Keep generated clients on /api/v1.
  • The only versionless paid aliases are the x402 hero paths: /fees/landscape, /mining/nextblock, /fees/observatory/scoreboard, /ai/fees/advice, and /ai/explain/transaction/{txid}. They must stay hidden from OpenAPI and priced by the same x402 rules as their canonical endpoints.
  • bitcoin-mcp uses /api/v1/rpc for hosted fallback. Do not break anonymous read-only RPC fallback without updating the MCP docs and tests.

x402 Buyer Path

The project-operated hosted deployment is intentionally paused for infrastructure review. Treat the URLs below as deployment contracts, not live smoke-test targets, until the repository status notice is removed.

  • First paid-call page: https://bitcoinsapi.com/x402/start.
  • General quickstart: https://bitcoinsapi.com/quickstart.
  • Discovery: https://bitcoinsapi.com/.well-known/x402 and https://bitcoinsapi.com/openapi.json.
  • Payment headers: unpaid responses return PAYMENT-REQUIRED; paid retries should use PAYMENT-SIGNATURE; successful paid responses include PAYMENT-RESPONSE.
  • x402 uses USDC on Base. Runtime wiring lives in the bitcoin-api-x402 extension package.
  • Runnable buyer examples live in examples/x402-paid-call/paid_call.py and examples/x402-paid-call/paid-call.ts.

Agent/MCP Integration

Use docs/AGENT_INTEGRATION.md when adding Satoshi API to another repository's agent instructions. Minimal MCP config:

{
  "mcpServers": {
    "bitcoin": {
      "command": "bitcoin-mcp"
    }
  }
}

Set SATOSHI_API_URL=https://bitcoinsapi.com only after the hosted-service status has been verified active. Use a self-hosted base URL while the pause is in effect.

Read the full file on GitHub · 52 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 · 52 lines · 660 tokens per session scan A 52d95f71ae4f

Subscribe to this mod's changes

bitcoin-api copilot-instructions.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 660 tokens to every session, about $0.0033 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.