# OrbitFlare

## Docs

- [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.
- [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.
- [Delete API Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/delete.md): Permanently delete an API key.
- [Get API Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/get.md): Get details of a specific API key (masked).
- [List API Keys](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/list.md): List all API keys for the authenticated user (masked).
- [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.
- [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.
- [Update API Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/api-keys/update.md): Update API key name or enabled status.
- [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.
- [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.
- [Current User](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/me.md): Get the currently authenticated user.
- [Health Check](https://docs.orbitflare.com/api-documentation/customer-endpoints/auth/ping.md): Simple health check endpoint.
- [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.
- [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.
- [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.
- [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 Licenses](https://docs.orbitflare.com/api-documentation/customer-endpoints/get-licenses.md): Retrieve a list of all licenses associated with 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](https://docs.orbitflare.com/api-documentation/customer-endpoints/get-whitelisted-ips.md): Returns a list of IP addresses currently whitelisted under this license, grouped by location.
- [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.
- [List Invoices](https://docs.orbitflare.com/api-documentation/customer-endpoints/invoices/list.md): Paginated list of invoices for the authenticated user.
- [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.
- [Add Devnet Domain](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/add-devnet-domain.md): Add a devnet domain to the license whitelist.
- [Add Domain](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/add-domain.md): Add a domain to the license whitelist.
- [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.
- [License Details](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/get.md): Get details of a specific license.
- [Get Whitelisted IPs](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/get-ips.md): Get whitelisted IPs for this license.
- [List Licenses](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/list.md): List all licenses for the authenticated user.
- [Get Allowed Locations](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/locations.md): Get allowed locations for this license.
- [Regenerate License Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/regenerate-key.md): Regenerate the license key.
- [Remove Devnet Domain](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/remove-devnet-domain.md): Remove a devnet domain from the license whitelist.
- [Remove Domain](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/remove-domain.md): Remove a domain from the license whitelist.
- [Remove IP from Whitelist](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/remove-ip.md): Remove an IP from the whitelist.
- [Reset License Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/licenses/reset-key.md): Reset and reshuffle the license key if allowed.
- [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.
- [Order Detail](https://docs.orbitflare.com/api-documentation/customer-endpoints/orders/get.md): Get a single order with its associated invoice and license.
- [List Orders](https://docs.orbitflare.com/api-documentation/customer-endpoints/orders/list.md): Paginated list of the authenticated user's orders.
- [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.
- [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.
- [Get Balance](https://docs.orbitflare.com/api-documentation/customer-endpoints/profile/balance.md): Get the authenticated user's account balance.
- [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.
- [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.
- [Reset License Key](https://docs.orbitflare.com/api-documentation/customer-endpoints/reset-license-key.md): Resets the license key associated with the given license, if allowed.
- [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.
- [List RPC Plans](https://docs.orbitflare.com/api-documentation/customer-endpoints/rpc-plans/list.md): List all available Solana RPC plans in the catalog.
- [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).
- [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.
- [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.
- [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](https://docs.orbitflare.com/api-documentation/welcome.md): Manage licenses, API keys, profiles, and invoices programmatically
- [Authentication & Limits](https://docs.orbitflare.com/authentication.md): API key usage, endpoint formats, rate limits, and connection limits
- [BNB Chain Nodes](https://docs.orbitflare.com/bnb-chain.md): Enterprise-grade BNB/BSC node infrastructure
- [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.
- [OrbitFlare Jetstream](https://docs.orbitflare.com/data-streaming/jetstream.md): High-performance gRPC service for Solana transaction streaming
- [Jetstream Changelog](https://docs.orbitflare.com/data-streaming/jetstream-changelog.md): Latest updates and improvements to the OrbitFlare Jetstream protocol
- [Jetstream Protocol Reference](https://docs.orbitflare.com/data-streaming/jetstream-reference.md): Protocol Buffer specification for OrbitFlare Jetstream
- [Yellowstone gRPC](https://docs.orbitflare.com/data-streaming/yellowstone.md): High-performance, real-time Solana blockchain data streaming via gRPC with advanced filtering
- [Account Monitoring](https://docs.orbitflare.com/data-streaming/yellowstone-account-monitoring.md): Stream real-time Solana account updates with precise filtering using Yellowstone gRPC
- [Entry Monitoring](https://docs.orbitflare.com/data-streaming/yellowstone-entry-monitoring.md): Stream low-level Solana block entries using Yellowstone gRPC
- [Yellowstone Quickstart](https://docs.orbitflare.com/data-streaming/yellowstone-quickstart.md): Install the gRPC client, connect to OrbitFlare, and send your first subscription
- [Slots & Blocks](https://docs.orbitflare.com/data-streaming/yellowstone-slot-block-monitoring.md): Track Solana network consensus progress and block production using Yellowstone gRPC
- [Transaction Monitoring](https://docs.orbitflare.com/data-streaming/yellowstone-transaction-monitoring.md): Stream and filter live Solana transactions using Yellowstone gRPC
- [Dedicated Nodes](https://docs.orbitflare.com/dedicated-nodes.md): Enterprise-grade dedicated Solana infrastructure with unlimited performance
- [FAQs](https://docs.orbitflare.com/faqs.md): Frequently asked questions about OrbitFlare products and services
- [getTransactionsForAddress](https://docs.orbitflare.com/fetching-data/getTransactionsForAddress.md): Retrieve complete transaction history for any address in a single call
- [Historical Data](https://docs.orbitflare.com/fetching-data/historical-data.md): Access complete Solana blockchain history from genesis
- [Fetching Data](https://docs.orbitflare.com/fetching-data/index.md): Access blockchain data efficiently with OrbitFlare
- [Global Infrastructure](https://docs.orbitflare.com/infrastructure.md): 11 strategically distributed server locations across 3 continents
- [OrbitFlare Pass](https://docs.orbitflare.com/nft-pass.md): Premium all-access NFT pass for enterprise-grade Solana infrastructure
- [Products & Pricing](https://docs.orbitflare.com/products.md): Solana RPC, gRPC streaming, and infrastructure solutions
- [Quickstart](https://docs.orbitflare.com/quickstart.md): Get started with OrbitFlare in minutes
- [Common Error Codes](https://docs.orbitflare.com/rpc/error-codes.md): Understanding RPC error messages and their solutions
- [HTTP RPC API](https://docs.orbitflare.com/rpc/http.md): Interact with Solana nodes using JSON-RPC 2.0
- [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
- [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
- [getBlockTime](https://docs.orbitflare.com/rpc/methods/getBlockTime.md): Returns the estimated production time of a block
- [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
- [getClusterNodes](https://docs.orbitflare.com/rpc/methods/getClusterNodes.md): Returns information about all the nodes participating in the cluster
- [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
- [getFeeForMessage](https://docs.orbitflare.com/rpc/methods/getFeeForMessage.md): Get the fee the network will charge for a particular message
- [getFirstAvailableBlock](https://docs.orbitflare.com/rpc/methods/getFirstAvailableBlock.md): Returns the slot of the lowest confirmed block that the node has information about
- [getGenesisHash](https://docs.orbitflare.com/rpc/methods/getGenesisHash.md): Returns the genesis hash of the cluster
- [getHealth](https://docs.orbitflare.com/rpc/methods/getHealth.md): Returns the current health status of the node
- [getHighestSnapshotSlot](https://docs.orbitflare.com/rpc/methods/getHighestSnapshotSlot.md): Returns the highest slot information from a snapshot
- [getIdentity](https://docs.orbitflare.com/rpc/methods/getIdentity.md): Returns the identity pubkey for the current node
- [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
- [getLatestBlockhash](https://docs.orbitflare.com/rpc/methods/getLatestBlockhash.md): Returns the latest blockhash
- [getLeaderSchedule](https://docs.orbitflare.com/rpc/methods/getLeaderSchedule.md): Returns the leader schedule for an epoch
- [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
- [getMinimumBalanceForRentExemption](https://docs.orbitflare.com/rpc/methods/getMinimumBalanceForRentExemption.md): Returns the minimum balance required for an account to be rent exempt
- [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
- [getRecentBlockhash](https://docs.orbitflare.com/rpc/methods/getRecentBlockhash.md): [DEPRECATED] Returns a recent blockhash and its fee schedule
- [getRecentPerformanceSamples](https://docs.orbitflare.com/rpc/methods/getRecentPerformanceSamples.md): Returns recent performance samples
- [getRecentPrioritizationFees](https://docs.orbitflare.com/rpc/methods/getRecentPrioritizationFees.md): Returns a list of recent prioritization fees from recent blocks
- [getSignatureStatuses](https://docs.orbitflare.com/rpc/methods/getSignatureStatuses.md): Returns the statuses of a list of signatures
- [getSignaturesForAddress](https://docs.orbitflare.com/rpc/methods/getSignaturesForAddress.md): Returns signatures for confirmed transactions for an address
- [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
- [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
- [getSupply](https://docs.orbitflare.com/rpc/methods/getSupply.md): Returns the current supply of SOL
- [getTokenAccountBalance](https://docs.orbitflare.com/rpc/methods/getTokenAccountBalance.md): Returns the token balance of an account
- [getTokenAccountsByDelegate](https://docs.orbitflare.com/rpc/methods/getTokenAccountsByDelegate.md): Returns all token accounts for a given delegate
- [getTokenAccountsByOwner](https://docs.orbitflare.com/rpc/methods/getTokenAccountsByOwner.md): Returns all token accounts for a given owner
- [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
- [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
- [getVersion](https://docs.orbitflare.com/rpc/methods/getVersion.md): Returns the current version of the node
- [getVoteAccounts](https://docs.orbitflare.com/rpc/methods/getVoteAccounts.md): Returns the current vote accounts
- [isBlockhashValid](https://docs.orbitflare.com/rpc/methods/isBlockhashValid.md): Returns whether a blockhash is still valid or not
- [minimumLedgerSlot](https://docs.orbitflare.com/rpc/methods/minimumLedgerSlot.md): Returns the lowest slot that the node has information about in its ledger
- [requestAirdrop](https://docs.orbitflare.com/rpc/methods/requestAirdrop.md): Requests an airdrop of lamports to a Solana account
- [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
- [WebSocket API](https://docs.orbitflare.com/rpc/websocket.md): Real-time Solana subscriptions for accounts, slots, logs, and more
- [Overview](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.
- [gRPC Client (Yellowstone)](https://docs.orbitflare.com/sdk/rust-grpc.md): Yellowstone Geyser streaming with automatic reconnection, ping/pong liveness detection, and YAML config.
- [JetStream Client](https://docs.orbitflare.com/sdk/rust-jetstream.md): OrbitFlare's decoded shreds delivered as gRPC streams with transaction and account filters.
- [RPC Client](https://docs.orbitflare.com/sdk/rust-rpc.md): JSON-RPC client with retry, failover, and typed helpers for common Solana methods.
- [WebSocket Client](https://docs.orbitflare.com/sdk/rust-websocket.md): Real-time subscriptions for account changes, logs, slots, and signatures with auto-reconnect.
- [Shredstream](https://docs.orbitflare.com/shredstream.md): Raw Solana shreds forwarded to your servers via UDP from top-of-turbine validators across 9 global regions
- [For Analytics](https://docs.orbitflare.com/solutions/analytics.md): Complete historical data and streaming for analytics, AI/ML, and compliance
- [For DeFi](https://docs.orbitflare.com/solutions/defi.md): Real-time infrastructure for DEXs, AMMs, lending, and yield protocols
- [For Enterprise](https://docs.orbitflare.com/solutions/enterprise.md): Custom infrastructure solutions for institutional and large-scale applications
- [For Traders](https://docs.orbitflare.com/solutions/traders.md): Infrastructure built for trading bots, terminals, and market makers
- [For Wallets](https://docs.orbitflare.com/solutions/wallets.md): Reliable infrastructure for wallet providers and mobile apps
- [Validator Staking](https://docs.orbitflare.com/staking.md): Stake SOL with OrbitFlare's high-performance validator
- [Jito Bundle Simulation](https://docs.orbitflare.com/trading-apis/jito-bundle-simulation.md): Jito-enabled bundle simulation through OrbitFlare Dedicated Nodes
- [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
- [Welcome to OrbitFlare](https://docs.orbitflare.com/welcome.md): High-performance Solana infrastructure for builders who demand speed and reliability.

## OpenAPI Specs

- [openapi](https://docs.orbitflare.com/api-documentation/openapi.json)

## Optional

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