# OrbitFlare

## Documentation

### Get Started

- [Welcome to OrbitFlare](https://docs.orbitflare.com/welcome.md): Sub-5ms Solana RPC, Yellowstone and Jetstream gRPC, Shredstream UDP shreds, and dedicated nodes across 11 regions—built for traders, wallets, and DeFi teams who need speed and reliability.
- [Quickstart](https://docs.orbitflare.com/quickstart.md): Create your OrbitFlare account, copy your license key from the dashboard, and call mainnet Solana JSON-RPC with curl or any HTTP client. Includes a free tier; upgrade for higher limits and regional endpoints.
- [OrbitFlare CLI](https://docs.orbitflare.com/cli.md): Full-featured command-line interface for OrbitFlare. Streaming, querying, scaffolding, account management, and a built-in TUI dashboard, all from your terminal.
- [Products & Pricing](https://docs.orbitflare.com/products.md): Compare OrbitFlare Solana RPC, Shredstream, dedicated nodes, data APIs, staking, and Pass pricing. Shredstream-optimized RPC with transparent limits, SLAs, and global regions.
- [Authentication & Limits](https://docs.orbitflare.com/authentication.md): Authenticate Solana JSON-RPC with your license key on the query string, understand per-plan rate and connection limits, HTTP semantics, and errors for production workloads on OrbitFlare.
- [Global Infrastructure](https://docs.orbitflare.com/infrastructure.md): 11 strategically distributed server locations across 3 continents
- [FAQs](https://docs.orbitflare.com/faqs.md): Frequently asked questions about OrbitFlare products and services

#### OrbitFlare SDK

- [OrbitFlare SDKs](https://docs.orbitflare.com/sdk/overview.md): Official client libraries for building on OrbitFlare. RPC, gRPC (Yellowstone), JetStream, and WebSocket - with built-in retry, failover, and reconnection.

##### Rust

- [Rust RPC Client](https://docs.orbitflare.com/sdk/rust-rpc.md): Solana JSON-RPC client for Rust from the orbitflare-sdk crate, with retry, failover, and typed helpers for common methods.
- [Rust gRPC Client (Yellowstone)](https://docs.orbitflare.com/sdk/rust-grpc.md): Yellowstone Geyser streaming in Rust via the orbitflare-sdk grpc feature, with automatic reconnection, ping/pong liveness detection, and YAML-configured filters.
- [Rust JetStream Client](https://docs.orbitflare.com/sdk/rust-jetstream.md): OrbitFlare's decoded shreds as gRPC streams in Rust, with transaction and account filters configured in YAML.
- [Rust WebSocket Client](https://docs.orbitflare.com/sdk/rust-websocket.md): Real-time Solana subscriptions in Rust via the orbitflare-sdk ws feature: account changes, logs, slots, and signatures with auto-reconnect.

##### TypeScript

- [TypeScript RPC Client](https://docs.orbitflare.com/sdk/typescript-rpc.md): Solana JSON-RPC client for TypeScript from the @orbitflare/sdk package, with retry, failover, and typed helpers for common methods.
- [TypeScript gRPC Client (Yellowstone)](https://docs.orbitflare.com/sdk/typescript-grpc.md): Yellowstone Geyser streaming in TypeScript on @grpc/grpc-js, with automatic reconnection, ping/pong liveness detection, and YAML config.
- [TypeScript JetStream Client](https://docs.orbitflare.com/sdk/typescript-jetstream.md): OrbitFlare's decoded shreds as gRPC streams in TypeScript on @grpc/grpc-js, with transaction and account filters.
- [TypeScript WebSocket Client](https://docs.orbitflare.com/sdk/typescript-websocket.md): Real-time Solana subscriptions in TypeScript, with ws as an optional peer dependency: account changes, logs, slots, and signatures with auto-reconnect.

##### Go

- [Go RPC Client](https://docs.orbitflare.com/sdk/go-rpc.md): Solana JSON-RPC client for Go from the orbitflare-sdk-go module, with retry, failover, and typed helpers for common methods.
- [Go gRPC Client (Yellowstone)](https://docs.orbitflare.com/sdk/go-grpc.md): Yellowstone Geyser streaming in Go, with automatic reconnection, ping/pong liveness detection, and filters built programmatically via SubscribeRequestBuilder.
- [Go JetStream Client](https://docs.orbitflare.com/sdk/go-jetstream.md): OrbitFlare's decoded shreds as gRPC streams in Go, with typed transaction filters that can be added and removed on a live stream.
- [Go WebSocket Client](https://docs.orbitflare.com/sdk/go-websocket.md): Real-time Solana subscriptions in Go from the orbitflare-sdk-go module: account changes, logs, slots, and signatures with auto-reconnect.

### Agents

- [AI Agents on OrbitFlare](https://docs.orbitflare.com/agents/overview.md): Build AI agents on OrbitFlare. Skills, MCP server, CLI, and SDK: everything an agent needs to query Solana, stream data, and manage an OrbitFlare account.
- [Skills](https://docs.orbitflare.com/agents/skills.md): Drop-in skill packages that teach Claude Code, Cursor, and Codex how to build on OrbitFlare correctly.
- [MCP Server](https://docs.orbitflare.com/agents/mcp.md): 53 OrbitFlare tools exposed via the Model Context Protocol. Works in Claude Desktop, Claude Code, Cursor, Windsurf, VS Code, Gemini CLI, and Codex CLI.
- [CLI](https://docs.orbitflare.com/agents/cli.md): Use the OrbitFlare CLI in shell scripts, CI/CD pipelines, and agent-driven automation. Every command supports --json for machine-readable output.
- [Rust SDK](https://docs.orbitflare.com/agents/sdk.md): Build production agents and indexers in Rust with type-safe clients for RPC, WebSocket, Yellowstone gRPC, and Jetstream, with retry, failover, and reconnection built in.

### Products

- [Dedicated Nodes](https://docs.orbitflare.com/dedicated-nodes.md): Isolated Solana dedicated hardware with unlimited RPS and TPS, private RPC and streaming endpoints, priority support, and enterprise SLA—no shared-cluster noisy neighbors on OrbitFlare.
- [Shredstream](https://docs.orbitflare.com/shredstream.md): Stream raw Solana turbine shreds over UDP to your IP and port for lowest-latency trading and MEV infrastructure, sourced from top-of-turbine validators with multi-region coverage on OrbitFlare.
- [OrbitFlare Pass](https://docs.orbitflare.com/nft-pass.md): OrbitFlare Pass NFT unlocks dedicated RPC, gRPC streaming, and VIP support in one membership—limited 2024 supply; available on secondary markets only.
- [Validator Staking](https://docs.orbitflare.com/staking.md): Stake SOL with OrbitFlare validators: competitive APY, Jito MEV tips, transparent commission, and infrastructure from the team that runs production Solana RPC and streaming.
- [BNB Chain Nodes](https://docs.orbitflare.com/bnb-chain.md): Dedicated BNB Chain and BSC nodes for DeFi, trading desks, and high-throughput apps—predictable latency, archival options, and enterprise operations from OrbitFlare.
- [Polygon RPC Nodes](https://docs.orbitflare.com/polygon.md): Polygon PoS RPC and WebSocket endpoints on OrbitFlare, with plans from 25 to 1000 RPS, gRPC and archival data on every tier, and dedicated instances.

#### Robinhood Chain Nodes

- [Robinhood Chain Nodes](https://docs.orbitflare.com/robinhood-chain.md): Dedicated Robinhood Chain node access from OrbitFlare — low-latency RPC and WebSocket endpoints for the tokenized-stock L2, available for purchase from the OrbitFlare dashboard.

##### SDK

- [Rust SDK](https://docs.orbitflare.com/sdk/robinhood.md): Rust SDK for Robinhood Chain, the orbitflare-robinhood-sdk crate.

### Solutions

- [For Traders](https://docs.orbitflare.com/solutions/traders.md): Infrastructure built for trading bots, terminals, and market makers
- [For DeFi](https://docs.orbitflare.com/solutions/defi.md): Real-time infrastructure for DEXs, AMMs, lending, and yield protocols
- [For Wallets](https://docs.orbitflare.com/solutions/wallets.md): Reliable infrastructure for wallet providers and mobile apps
- [For Analytics](https://docs.orbitflare.com/solutions/analytics.md): Complete historical data and streaming for analytics, AI/ML, and compliance
- [For Enterprise](https://docs.orbitflare.com/solutions/enterprise.md): Custom infrastructure solutions for institutional and large-scale applications

### Fetching Data

- [Fetching Data](https://docs.orbitflare.com/fetching-data/index.md): Guides for historical Solana data, wallet and program activity APIs, and bulk transaction retrieval—patterns for analytics and explorers with fewer RPC round-trips on OrbitFlare.
- [Historical Data](https://docs.orbitflare.com/fetching-data/historical-data.md): Access complete Solana blockchain history from genesis
- [getTransactionsForAddress](https://docs.orbitflare.com/fetching-data/getTransactionsForAddress.md): Batch-fetch full Solana transaction history for any address in one JSON-RPC call—pagination, filters, and detail levels replace getSignaturesForAddress plus many getTransaction requests.

### RPC

- [HTTP RPC API](https://docs.orbitflare.com/rpc/http.md): Interact with Solana nodes using JSON-RPC 2.0
- [WebSocket API](https://docs.orbitflare.com/rpc/websocket.md): Real-time Solana subscriptions for accounts, slots, logs, and more
- [Common Error Codes](https://docs.orbitflare.com/rpc/error-codes.md): Understanding RPC error messages and their solutions

#### Methods

##### Account & Program

- [getAccountInfo](https://docs.orbitflare.com/rpc/methods/getAccountInfo.md): Returns all information associated with an account
- [getBalance](https://docs.orbitflare.com/rpc/methods/getBalance.md): Returns the balance of the account of provided public key
- [getMultipleAccounts](https://docs.orbitflare.com/rpc/methods/getMultipleAccounts.md): Returns the account information for multiple accounts
- [getProgramAccounts](https://docs.orbitflare.com/rpc/methods/getProgramAccounts.md): Returns all accounts owned by a program
- [getMinimumBalanceForRentExemption](https://docs.orbitflare.com/rpc/methods/getMinimumBalanceForRentExemption.md): Returns the minimum balance required for an account to be rent exempt

##### Blocks & Slots

- [getBlock](https://docs.orbitflare.com/rpc/methods/getBlock.md): Returns identity and transaction information about a confirmed block
- [getBlockCommitment](https://docs.orbitflare.com/rpc/methods/getBlockCommitment.md): Returns commitment for particular block
- [getBlockHeight](https://docs.orbitflare.com/rpc/methods/getBlockHeight.md): Returns the current block height of the node
- [getBlockProduction](https://docs.orbitflare.com/rpc/methods/getBlockProduction.md): Returns recent block production information from the current or previous epoch
- [getBlocks](https://docs.orbitflare.com/rpc/methods/getBlocks.md): Returns a list of confirmed blocks between two slots
- [getBlocksWithLimit](https://docs.orbitflare.com/rpc/methods/getBlocksWithLimit.md): Returns a list of confirmed blocks starting at the given slot
- [getBlockTime](https://docs.orbitflare.com/rpc/methods/getBlockTime.md): Returns the estimated production time of a block
- [getFirstAvailableBlock](https://docs.orbitflare.com/rpc/methods/getFirstAvailableBlock.md): Returns the slot of the lowest confirmed block that the node has information about
- [getSlot](https://docs.orbitflare.com/rpc/methods/getSlot.md): Returns the current slot of the node
- [getSlotLeader](https://docs.orbitflare.com/rpc/methods/getSlotLeader.md): Returns the current slot leader
- [getSlotLeaders](https://docs.orbitflare.com/rpc/methods/getSlotLeaders.md): Returns the slot leaders for a given range
- [minimumLedgerSlot](https://docs.orbitflare.com/rpc/methods/minimumLedgerSlot.md): Returns the lowest slot that the node has information about in its ledger

##### Epochs & Schedule

- [getEpochInfo](https://docs.orbitflare.com/rpc/methods/getEpochInfo.md): Returns information about the current epoch
- [getEpochSchedule](https://docs.orbitflare.com/rpc/methods/getEpochSchedule.md): Returns epoch schedule information from this cluster genesis config
- [getLeaderSchedule](https://docs.orbitflare.com/rpc/methods/getLeaderSchedule.md): Returns the leader schedule for an epoch

##### Network

- [getClusterNodes](https://docs.orbitflare.com/rpc/methods/getClusterNodes.md): Returns information about all the nodes participating in the cluster
- [getHealth](https://docs.orbitflare.com/rpc/methods/getHealth.md): Returns the current health status of the node
- [getIdentity](https://docs.orbitflare.com/rpc/methods/getIdentity.md): Returns the identity pubkey for the current node
- [getVersion](https://docs.orbitflare.com/rpc/methods/getVersion.md): Returns the current version of the node
- [getGenesisHash](https://docs.orbitflare.com/rpc/methods/getGenesisHash.md): Returns the genesis hash of the cluster
- [getHighestSnapshotSlot](https://docs.orbitflare.com/rpc/methods/getHighestSnapshotSlot.md): Returns the highest slot information from a snapshot
- [getMaxRetransmitSlot](https://docs.orbitflare.com/rpc/methods/getMaxRetransmitSlot.md): Returns the highest slot that can be retransmitted
- [getMaxShredInsertSlot](https://docs.orbitflare.com/rpc/methods/getMaxShredInsertSlot.md): Returns the highest slot that can be inserted into the shred database
- [getRecentPerformanceSamples](https://docs.orbitflare.com/rpc/methods/getRecentPerformanceSamples.md): Returns recent performance samples

##### Transactions & Fees

- [sendTransaction](https://docs.orbitflare.com/rpc/methods/sendTransaction.md): Submits a signed transaction to the cluster for processing
- [simulateTransaction](https://docs.orbitflare.com/rpc/methods/simulateTransaction.md): Simulates sending a transaction
- [getTransaction](https://docs.orbitflare.com/rpc/methods/getTransaction.md): Returns transaction details for a given signature
- [getTransactionCount](https://docs.orbitflare.com/rpc/methods/getTransactionCount.md): Returns the current transaction count from the ledger
- [getSignaturesForAddress](https://docs.orbitflare.com/rpc/methods/getSignaturesForAddress.md): Returns signatures for confirmed transactions for an address
- [getSignatureStatuses](https://docs.orbitflare.com/rpc/methods/getSignatureStatuses.md): Returns the statuses of a list of signatures
- [getFeeForMessage](https://docs.orbitflare.com/rpc/methods/getFeeForMessage.md): Get the fee the network will charge for a particular message
- [getRecentPrioritizationFees](https://docs.orbitflare.com/rpc/methods/getRecentPrioritizationFees.md): Returns a list of recent prioritization fees from recent blocks
- [isBlockhashValid](https://docs.orbitflare.com/rpc/methods/isBlockhashValid.md): Returns whether a blockhash is still valid or not
- [getLatestBlockhash](https://docs.orbitflare.com/rpc/methods/getLatestBlockhash.md): Returns the latest blockhash
- [getRecentBlockhash](https://docs.orbitflare.com/rpc/methods/getRecentBlockhash.md): [DEPRECATED] Returns a recent blockhash and its fee schedule
- [requestAirdrop](https://docs.orbitflare.com/rpc/methods/requestAirdrop.md): Requests an airdrop of lamports to a Solana account

##### Tokens

- [getTokenAccountBalance](https://docs.orbitflare.com/rpc/methods/getTokenAccountBalance.md): Returns the token balance of an account
- [getTokenAccountsByOwner](https://docs.orbitflare.com/rpc/methods/getTokenAccountsByOwner.md): Returns all token accounts for a given owner
- [getTokenAccountsByDelegate](https://docs.orbitflare.com/rpc/methods/getTokenAccountsByDelegate.md): Returns all token accounts for a given delegate
- [getTokenLargestAccounts](https://docs.orbitflare.com/rpc/methods/getTokenLargestAccounts.md): Returns the largest token accounts for a given mint
- [getTokenSupply](https://docs.orbitflare.com/rpc/methods/getTokenSupply.md): Returns the total supply of a token mint

##### Staking & Voting

- [getStakeActivation](https://docs.orbitflare.com/rpc/methods/getStakeActivation.md): Returns the stake activation information for a given account
- [getStakeMinimumDelegation](https://docs.orbitflare.com/rpc/methods/getStakeMinimumDelegation.md): Returns the minimum stake delegation amount
- [getVoteAccounts](https://docs.orbitflare.com/rpc/methods/getVoteAccounts.md): Returns the current vote accounts

##### Supply & Inflation

- [getSupply](https://docs.orbitflare.com/rpc/methods/getSupply.md): Returns the current supply of SOL
- [getInflationGovernor](https://docs.orbitflare.com/rpc/methods/getInflationGovernor.md): Returns the current inflation governor parameters
- [getInflationRate](https://docs.orbitflare.com/rpc/methods/getInflationRate.md): Returns the current inflation rate of the network
- [getInflationReward](https://docs.orbitflare.com/rpc/methods/getInflationReward.md): Returns the inflation reward for a list of addresses for an epoch
- [getLargestAccounts](https://docs.orbitflare.com/rpc/methods/getLargestAccounts.md): Returns the 20 largest accounts, by lamport balance

### Data Streaming

#### Jetstream

- [OrbitFlare Jetstream](https://docs.orbitflare.com/data-streaming/jetstream.md): High-performance gRPC service for Solana transaction streaming
- [Jetstream Protocol Reference](https://docs.orbitflare.com/data-streaming/jetstream-reference.md): Protocol Buffer specification for OrbitFlare Jetstream
- [Jetstream Changelog](https://docs.orbitflare.com/data-streaming/jetstream-changelog.md): Latest updates and improvements to the OrbitFlare Jetstream protocol
- [OrbitFlare Jetstream v2](https://docs.orbitflare.com/data-streaming/jetstream-v2.md): Next-generation gRPC streaming for Solana — enrichment, slot events, and dynamic filters
- [What's New in v2](https://docs.orbitflare.com/data-streaming/jetstream-v2-vs-v1.md): Jetstream v1 vs v2 at a glance: what v2 adds over v1, and how more data in the stream means fewer RPC calls and a faster result.
- [Jetstream v2 Protocol Reference](https://docs.orbitflare.com/data-streaming/jetstream-v2-reference.md): Protocol Buffer specification for OrbitFlare Jetstream v2

#### Yellowstone gRPC

- [Yellowstone gRPC](https://docs.orbitflare.com/data-streaming/yellowstone.md): High-performance, real-time Solana blockchain data streaming via gRPC with advanced filtering
- [Yellowstone Quickstart](https://docs.orbitflare.com/data-streaming/yellowstone-quickstart.md): Install the gRPC client, connect to OrbitFlare, and send your first subscription
- [Account Monitoring](https://docs.orbitflare.com/data-streaming/yellowstone-account-monitoring.md): Stream real-time Solana account updates with precise filtering using Yellowstone gRPC
- [Transaction Monitoring](https://docs.orbitflare.com/data-streaming/yellowstone-transaction-monitoring.md): Stream and filter live Solana transactions using Yellowstone gRPC
- [Slots & Blocks](https://docs.orbitflare.com/data-streaming/yellowstone-slot-block-monitoring.md): Track Solana network consensus progress and block production using Yellowstone gRPC
- [Entry Monitoring](https://docs.orbitflare.com/data-streaming/yellowstone-entry-monitoring.md): Stream low-level Solana block entries using Yellowstone gRPC

### Trading APIs

- [Metis Swap API](https://docs.orbitflare.com/trading-apis/metis-swap.md): Low-level Jupiter routing engine for swaps — CPI, custom instructions, and full transaction control
- [Jito Bundle Simulation](https://docs.orbitflare.com/trading-apis/jito-bundle-simulation.md): Jito-enabled bundle simulation through OrbitFlare Dedicated Nodes

## API Documentation

### Overview

- [Customer API](https://docs.orbitflare.com/api-documentation/welcome.md): REST reference for OrbitFlare Customer API v1 and v2: licenses, API keys, wallet auth, profile, invoices, balance top-up, and RPC plan purchases with request and response patterns.
- [Migrating from v1 to v2](https://docs.orbitflare.com/api-documentation/migration.md): Step-by-step guide for upgrading from Customer API v1 to v2

### Customer API v2

#### Auth

- [Request Device Code](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/device-code.md): Request a device code and user code for the device authorization flow. Display the verification_uri and user_code to the user, then poll /auth/device/token until authorized.
- [Poll for Token](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/device-token.md): Poll until the user authorizes in the browser. Returns 428 (authorization_pending) while waiting, 429 (slow_down) if polling too fast, 410 (expired_token) if code expired.
- [Request Wallet Challenge](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/wallet-challenge.md): Request a challenge nonce for a wallet address. Sign the challenge with your Solana keypair (Ed25519), then call /auth/wallet/verify or /auth/wallet/register.
- [Verify Wallet Signature](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/wallet-verify.md): Verify the signed challenge and issue a token for an existing account.
- [Register with Wallet](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/wallet-register.md): Create a new account linked to a Solana wallet. Requires a valid challenge signature.
- [Current User](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/me.md): Get the currently authenticated user.
- [Revoke Token](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/logout.md): Revoke the current Bearer token. API key sessions cannot be revoked via this endpoint.
- [Health Check](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/ping.md): Simple health check endpoint.

#### Licenses

- [List Licenses](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/list.md): List all licenses for the authenticated user.
- [License Details](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/get.md): Get details of a specific license.
- [Reset License Key (v2)](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/reset-key.md): Customer API v2: resets and reshuffles a license key, if allowed.
- [Regenerate License Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/regenerate-key.md): Regenerate the license key.
- [Toggle Auth Mode](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/toggle-auth-mode.md): Toggle between IP whitelist and API key auth mode.
- [Toggle Auto-Renewal](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/toggle-auto-renewal.md): Toggle auto-renewal for the license.
- [Get Allowed Locations](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/locations.md): Get allowed locations for this license.
- [Get Whitelisted IPs (v2)](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/get-ips.md): Customer API v2: returns the IP addresses currently whitelisted under a license.
- [Add IP to Whitelist](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/add-ip.md): Add an IP address to the whitelist for this license.
- [Remove IP from Whitelist](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/remove-ip.md): Remove an IP from the whitelist.
- [Add Domain](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/add-domain.md): Add a domain to the license whitelist.
- [Remove Domain](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/remove-domain.md): Remove a domain from the license whitelist.
- [Add Devnet Domain](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/add-devnet-domain.md): Add a devnet domain to the license whitelist.
- [Remove Devnet Domain](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/remove-devnet-domain.md): Remove a devnet domain from the license whitelist.

#### API Keys

- [List API Keys](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/list.md): List all API keys for the authenticated user (masked).
- [Create API Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/create.md): Create a new API key. Returns the full key once; store it securely.
- [Get API Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/get.md): Get details of a specific API key (masked).
- [Update API Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/update.md): Update API key name or enabled status.
- [Delete API Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/delete.md): Permanently delete an API key.
- [Regenerate API Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/regenerate.md): Regenerate the API key. Returns the new full key once.
- [Add IP to API Key Whitelist](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/add-ip.md): Add an IP to the API key's IP whitelist.
- [Remove IP from API Key Whitelist](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/remove-ip.md): Remove an IP from the API key's whitelist.

#### Profile

- [Get Profile](https://docs.orbitflare.com/api-documentation/customer-endpoints/profile/get.md): Get the authenticated user's profile.
- [Update Profile](https://docs.orbitflare.com/api-documentation/customer-endpoints/profile/update.md): Update the authenticated user's profile.
- [Get Balance](https://docs.orbitflare.com/api-documentation/customer-endpoints/profile/balance.md): Get the authenticated user's account balance.

#### Invoices

- [List Invoices](https://docs.orbitflare.com/api-documentation/customer-endpoints/invoices/list.md): Paginated list of invoices for the authenticated user.
- [Get Invoice Detail](https://docs.orbitflare.com/api-documentation/customer-endpoints/invoices/get.md): Retrieve a single invoice with line items, payments, and associated licenses.
- [Pay Invoice With Balance](https://docs.orbitflare.com/api-documentation/customer-endpoints/invoices/pay-with-balance.md): Pay the outstanding invoice balance using account credit. Supports partial payment if balance is insufficient.

#### Top-Up

- [Prepare Top-Up Transaction](https://docs.orbitflare.com/api-documentation/customer-endpoints/topup/prepare.md): Builds an unsigned Solana USDC transfer transaction on the server. The customer signs the returned base64-encoded transaction locally and submits it to the /topup/confirm endpoint.
- [Confirm Top-Up Transaction](https://docs.orbitflare.com/api-documentation/customer-endpoints/topup/confirm.md): Broadcasts the customer's signed transaction to Solana, waits for finalization, verifies on-chain data (memo, signer, USDC transfer, amount, destination), then credits the account balance. Creates an invoice and payment record.
- [Top-Up History](https://docs.orbitflare.com/api-documentation/customer-endpoints/topup/history.md): Paginated list of the user's credit transactions (deposits and deductions).

#### RPC Plans

- [List RPC Plans](https://docs.orbitflare.com/api-documentation/customer-endpoints/rpc-plans/list.md): List all available Solana RPC plans in the catalog.
- [RPC Plan Detail](https://docs.orbitflare.com/api-documentation/customer-endpoints/rpc-plans/get.md): Get a single RPC plan with pricing and feature details.

#### Orders

- [List Orders](https://docs.orbitflare.com/api-documentation/customer-endpoints/orders/list.md): Paginated list of the authenticated user's orders.
- [Validate Order](https://docs.orbitflare.com/api-documentation/customer-endpoints/orders/validate.md): Dry-run order validation. Calculates pricing with optional discount code and checks if the user can afford the plan. Does not create any records.
- [Purchase RPC Plan](https://docs.orbitflare.com/api-documentation/customer-endpoints/orders/purchase.md): Purchase an RPC plan using account balance. Deducts the balance, creates the order, invoice, payment, and license in a single atomic transaction.
- [Order Detail](https://docs.orbitflare.com/api-documentation/customer-endpoints/orders/get.md): Get a single order with its associated invoice and license.

### Customer API v1 (deprecated)

- [Get Licenses](https://docs.orbitflare.com/api-documentation/customer-endpoints/get-licenses.md): Retrieve a list of all licenses associated with the authenticated user.
- [Get License](https://docs.orbitflare.com/api-documentation/customer-endpoints/get-license.md): Get details of a specific license owned by the authenticated user.
- [Get Locations](https://docs.orbitflare.com/api-documentation/customer-endpoints/get-locations.md): Retrieve a list of allowed locations for this license.
- [Get Whitelisted IPs (v1, deprecated)](https://docs.orbitflare.com/api-documentation/customer-endpoints/get-whitelisted-ips.md): Customer API v1: returns the IP addresses currently whitelisted under a license, grouped by location. Superseded by the v2 endpoint.
- [Reset License Key (v1, deprecated)](https://docs.orbitflare.com/api-documentation/customer-endpoints/reset-license-key.md): Customer API v1: resets the license key associated with a license, if allowed. Superseded by the v2 endpoint.
- [Whitelist an IP](https://docs.orbitflare.com/api-documentation/customer-endpoints/whitelist-ip.md): Add an IP address to the whitelist for a given license and location.
- [Remove a Whitelisted IP](https://docs.orbitflare.com/api-documentation/customer-endpoints/remove-ip.md): Remove a previously whitelisted IP address from a given license and location.

## OpenAPI Specs

- [openapi](/api-documentation/openapi.json)

## Optional

- [Dashboard](https://orbitflare.com)
- [Community](https://discord.gg/orbitflare)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Simplified Chinese (166 pages)](https://docs.orbitflare.com/_llms/zh-hans.md): Documentation for Simplified Chinese.
- [Russian (166 pages)](https://docs.orbitflare.com/_llms/ru.md): Documentation for Russian.
- [Turkish (166 pages)](https://docs.orbitflare.com/_llms/tr.md): Documentation for Turkish.