Quickstart - Ralph Studio

This page gets you from zero to a working request. By the end you’ll have an API key and a live response from the Alephium node.

1. Create an account

Go to developer.ralphstudio.xyz and sign up with GitHub or Google. It takes about 30 seconds.

2. Create an app

Go to developer.ralphstudio.xyz, click New App. Give it a name, pick a network (mainnet or testnet), and hit create. You’ll get a slug and a default API key automatically. Copy both, you’ll need them for every request.

3. Make your first request

Replace {slug} and API_KEY with the values from your app.

curl https://rpc.ralphstudio.xyz/{slug}/infos/version \
  -H "Authorization: Bearer API_KEY"

You should get back something like:

{
  "version": "v4.5.1"
}

4. Check the node status

curl https://rpc.ralphstudio.xyz/{slug}/infos/self-clique \
  -H "Authorization: Bearer API_KEY"

The synced field tells you if the node is caught up with the chain. If it’s true you’re good to go.

5. Query an address balance

curl https://rpc.ralphstudio.xyz/{slug}/addresses/{address}/balance \
  -H "Authorization: Bearer API_KEY"

Replace {address} with any Alephium address. The response includes the balance in attoALPH: divide by 10^18 to get ALPH.

{
  "balance": "1000000000000000000",
  "balanceHint": "1 ALPH",
  "lockedBalance": "0",
  "lockedBalanceHint": "0 ALPH",
  "utxoNum": 1
}

What’s next

Now that you have a working request, you can explore the full API surface:

RPC API: raw node endpoints for blocks, transactions, contracts, and more
Indexer API: richer indexed data for transaction history and token balances
Smart Contracts: deploy and interact with Ralph contracts
Guides: practical examples in JavaScript and Python

​1. Create an account

​2. Create an app

​3. Make your first request

​4. Check the node status

​5. Query an address balance

​What’s next