Getting Started
Welcome to Syndica. This guide will walk you through everything you need to know about using Syndica, from setting up your first Stack to equipping your team with all of the tools they need to get the job done. Each section includes easy-to-follow steps, tips, and templates that will turn you into a Syndica champion in no time.
Create an Account and Login
Navigate to app.syndica.io and Register for an Account
After logging into the Syndica app, you'll be prompted to name your first stack and optionally tell us a little about yourself. Giving your stack a unique name will help you identify it later on. You can also add a description to your stack to help you remember what it's for.
After naming your first stack you'll see the stack overview page which will give you a quick, high-level glance at important metrics for your stack, including network status and top-level statistics.
These top-level statistics will display based on your account usage:
- RPC/WebSocket Calls: (within the last 24H)
- Data Transfer: Total data transferred through the Syndica network for this account in the last 24H)
- Active API Key: Currently active API Keys within this Account
- Main Chart: Display RPC Traffic over the last 7-day period
Getting Started with Syndica and RPC
Estimated time to complete this guide: approx. 10 minutes
This guide assumes you already have a Syndica account. To create a free account click here.
- Create an API Key
- Make a request using Syndica RPC Node platform
Making your first RPC request on Syndica
Once your API key is created, copy and paste the API key string to make a live request to the Syndica platform. Let's review the steps below
Open a command line window where you can execute curl requests. Use the code below to execute your first command.
For our first request, we would like to use JSON-RPC
via a POST
method. Use the following parameters:
jsonrpc
: JSON-RPC version is set to 2.0method
: The Solana API Method you wish to execute. See the Solana API Referenceparams
: The list of parameters that you'll be passing in the requestid
: ID of the request you'll be sending. This ID will be returned with the response so you can track which responses belong to which request.
Don't forget to include the namespace in the method parameter before the method name you're trying to call. Currently solana-mainnet
is the only supported namespace, but solana-testnet
and solana-devnet
will be supported in the future.
The example below outlines how to use Syndica's Solana RPC network with your API key created in your Stack. You will receive a server response from the RPC request made.
API Key URL Embedded
curl https://solana-mainnet.api.syndica.io/api-key/<YOUR_API_KEY> \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":"1", "method":"solana-mainnet.getHealth"}'
API Key Header Embedded
curl https://solana-mainnet.api.syndica.io/ \
-X POST \
-H "Content-Type: application/json" \
-H "X-Syndica-Api-Key: <YOUR_API_KEY>" \
-d '{"jsonrpc":"2.0","id":"1", "method":"solana-mainnet.getHealth"}'
Valid RPC Server Response, which will be returned from the request above.
{ "jsonrpc": "2.0", "result": "ok", "id": 1 }
We also support WebSocket connections:
wss://solana-mainnet.api.syndica.io/api-key/<YOUR_API_KEY>/
After making a few curl requests: Navigate to the RPC Analytics page (From Stack home, navigate to Elastic Nodes, then RPC Analytics) to see the rise in RPC calls being made using the current API key.
Getting Started Actions: