Getting Started
Initial Setup
There are three steps to complete before starting to use FluxRPC:
Create an account
Create an API key and select a region
Buy bandwidth or select a plan (optional)
1. Creating an Account
To create an account on FluxRPC, simply sign in for the first time at dashboard using the "Get Started" button in the top right on the FluxRPC website.
We support three ways of signing in — with your Solana Wallet (e.g. Solflare), via your Google account, or via your Github account. This will not change the features available to you.
When signing in with a Solana wallet, it should pop up once to connect to the website, and again to sign a message to prove you are the owner of the wallet. This is normal and does not incur any transaction fees.
2. Creating an API Key and Selecting a Region
If the API key interface does not load immediately, select it from the menu to the left. Or navigate directly to this page:
To begin creating a new API key, select the green "Create API Key" button in the top right. It is required that you give the API key a name. After you have done that, select "Create". You should see your new API key displayed on the page now. It is immediately available for use.
Note: An account may have multiple API keys. Usage from any of these keys will deduct bandwidth from the account that owns them.
To begin using your API key, first select a region using the region selector in the top left of the page. Selecting the region closest to you will offer the best performance. The regions are:
EU
US
Tokyo (Coming Soon)
Now, click on the "Details" button corresponding to your API key. You will see a dialogue containing all information about this API key, including the value of the API key itself. It will look something like "8a5ab0f4-f188-3a3e-a10e-a77a1b68651e". This is what you need to begin using the API key.
Note: In the Details view, you may also rename or delete your API keys. Renaming an active key does not affect its functionality. Deleting a key is irreversible, and the key will immediately stop functioning.
3. Binary Stream Endpoints
We also provide endpoints that will stream the results of large RPC calls, for example large getProgramAccount calls. This can save a substantial amount of memory when processing the result of a large call — you can process the results as they come in instead of waiting for them all to arrive at once.
To use this feature, POST your getAccountInfo, getMultipleAccounts, and getProgramAccounts calls to:
Substituting <your-api-key> with your actual API key. Note that the response you receive will need to be decoded — it is in binary.
4. Buying Bandwidth
We charge by bandwidth. One gigabyte of bandwidth costs USD 0.06. This is true for all RPC calls. New accounts are granted a little bandwidth to get started, but to continue using our service, you will need to purchase more bandwidth.
There are two ways to pay for bandwidth: With Stripe, or with USDC. You can pay as you go, or for best performance, purchase a plan. For more information, visit our Pricing page.
Using Your API Key
Now that you have an API Key and have selected a region, you may call the FluxRPC servers. To do this, simply include your API Key in either the request URL or via a header field.
Query String
Header
Last updated