Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orbitflare.com/llms.txt

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

OrbitFlare ships agent skills (instruction sets the model loads at the start of a session) so coding agents write OrbitFlare code correctly without you fetching docs first. The main skill covers HTTP RPC, WebSockets, Jetstream, Yellowstone gRPC, raw Shredstream, Dedicated Nodes (Solana + BNB Chain), getTransactionsForAddress, historical archive data, Metis Swap, Jito Bundle Simulation, the Customer API, the OrbitFlare CLI, and the orbitflare-sdk-rs Rust SDK.
Skills are read-only context; they don’t make API calls. Pair a skill with the MCP server when you want the agent to actually query OrbitFlare from chat.

​
Install

One line, no clone required. Pick the host: 
npx @orbitflare/skills@latest
Installs to ~/.claude/skills/orbitflare. Available in every Claude Code session.
After install, restart your agent so it picks up the new skill.
Updates are one command: npx @orbitflare/skills@latest again. The installer overwrites the skill files in place.

​
From source

If you want to clone the repo (e.g. to modify the skill), the underlying installer is also exposed as a shell script: 
git clone https://github.com/orbitflare/orbitflare-skills
cd orbitflare-skills/orbitflare
./install.sh                 # same flags: --project, --cursor, --codex, --path

​
What’s in the skill

SKILL.md is the entry point. The model loads it at the start of every session and uses it to route to the right reference file. References cover:
ReferenceTopic
rpc.mdHTTP JSON-RPC: endpoint URLs, headers, common methods
websockets.mdWebSocket subscriptions, reconnection patterns
jetstream.mdOrbitFlare’s Shredstream-decoded gRPC stream
yellowstone.mdYellowstone Geyser gRPC: accounts, txs, slots, blocks
shredstream.mdRaw UDP Shredstream feed
fetching-data.mdgetTransactionsForAddress, historical archive
dedicated-nodes.mdSolana + BNB Chain dedicated infrastructure
trading-apis.mdMetis Swap, Jito Bundle Simulation
customer-api.mdCustomer API v2: licenses, billing, top-up
cli-sdk.mdOrbitFlare CLI command surface + Rust SDK setup
onboarding.mdAuth keys, dashboard signup, first call
repos.mdPointers to template repos and example projects
The skill instructs the agent to read the relevant reference before writing code, so you get correct endpoint URLs, gRPC filter shapes, and SDK feature flags on the first try.

​
Try it

After installing the skill and restarting your agent:
“Stream pump.fun trades using OrbitFlare Jetstream from Frankfurt”
“Quote 1 SOL → USDC with Metis on OrbitFlare and write a Rust binary that polls every 30 seconds”
“Build a Yellowstone gRPC subscription that streams Jupiter swap transactions, with retry on disconnect”
The agent will pull the relevant reference (jetstream.md, trading-apis.md, yellowstone.md) and produce code that uses the right endpoint URL, headers, and SDK patterns.

​
Source

Everything in the skill is derived from this documentation site. When in doubt, point the agent at the llms.txt index.