Yellowstone gRPC - Authentication
Authentication guide for Yellowstone gRPC on FluxRPC. Learn how to use API keys and request headers correctly.
Required Header
Pass your API key in the x-token header:
x-token: <your-API-key>
Plan Requirements
Yellowstone gRPC access requires a Developer plan or higher. Free and Starter plans do not have access to gRPC services.
Bandwidth Requirements
Your Internet connection must be fast enough to receive the data you subscribe to on Yellowstone. If your connection is too slow, our server will disconnect you with an appropriate error. We buffer some updates on our end to account for temporary issues and will never drop updates.
If you encounter connection speed issues, move your server closer to FluxRPC or subscribe to less data.
API Key Types
Only standard API keys work with gRPC. Shielded API keys are not supported. You must have bandwidth remaining in your account for the service to function.
Open the section overview for the broader context, live navigation, and interactive code examples.
Continue in this section
- Yellowstone gRPC - API Reference — API reference for Yellowstone gRPC on FluxRPC, including SubscribeRequest and SubscribeUpdate message shapes.
- Yellowstone gRPC - Subscriptions — Learn about Yellowstone gRPC subscription types for accounts, transactions, blocks, and slots on FluxRPC.
- Yellowstone gRPC - Account Subscriptions — Monitor account changes in real time with Yellowstone gRPC account subscriptions for balances, token accounts, and program state.
- Yellowstone gRPC - Compressed Filters — Update Yellowstone account subscriptions without re-sending the full key list using a compressed Cuckoo filter on FluxRPC.
- Yellowstone gRPC - Transaction Subscriptions — Stream confirmed transactions filtered by accounts, signatures, or program involvement using Yellowstone gRPC on FluxRPC.
- Yellowstone gRPC - Block Subscriptions — Receive full block data including transactions, rewards, and metadata with Yellowstone gRPC block subscriptions.