> ## 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.

# Overview

> Official client libraries for building on OrbitFlare. RPC, gRPC (Yellowstone), JetStream, and WebSocket - with built-in retry, failover, and reconnection.

The OrbitFlare SDK gives you typed clients for every OrbitFlare service. Instead of managing raw HTTP requests, gRPC channels, and WebSocket connections yourself, the SDK handles connection lifecycle, authentication, retries, failover, and reconnection behind a clean API.

## What's included

| Service                | What it does                                                                                                                                                                                                      |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **RPC**                | JSON-RPC client with typed helpers for common Solana methods, plus raw escape hatches for anything custom                                                                                                         |
| **WebSocket**          | Subscriptions for account changes, logs, slots, and signatures with auto-resubscribe on reconnect                                                                                                                 |
| **gRPC (Yellowstone)** | Yellowstone Geyser streaming - transactions, accounts, slots, blocks. YAML config or programmatic filters                                                                                                         |
| **JetStream**          | OrbitFlare's decoded shreds delivered as gRPC streams. Same client pattern as Yellowstone, different proto. v1 (fixed filters) and v2 (runtime-managed filters, sequence numbers, opt-in enrichment, slot events) |

## Environment variables

| Variable                   | Used by        | Purpose                                    |
| -------------------------- | -------------- | ------------------------------------------ |
| `ORBITFLARE_LICENSE_KEY`   | RPC, WebSocket | API key appended to endpoint URLs          |
| `ORBITFLARE_RPC_URL`       | RPC            | Default endpoint if `.url()` is not called |
| `ORBITFLARE_WS_URL`        | WebSocket      | Default endpoint if `.url()` is not called |
| `ORBITFLARE_GRPC_URL`      | gRPC           | Default endpoint if `.url()` is not called |
| `ORBITFLARE_JETSTREAM_URL` | JetStream      | Default endpoint if `.url()` is not called |

## Source

The SDKs are open source:

* Rust: [github.com/orbitflare/orbitflare-sdk-rs](https://github.com/orbitflare/orbitflare-sdk-rs)
* TypeScript: [github.com/orbitflare/orbitflare-sdk-ts](https://github.com/orbitflare/orbitflare-sdk-ts)