Boost Quickstart - Goldsky Docs

This quickstart configures one upstream, makes an eligible historical read, and confirms whether Boost or your provider answered.

Prerequisites

A Goldsky account
An HTTPS RPC endpoint for a supported Boost network
A verified Goldsky organization

A verified Goldsky organization has at least one Owner, Admin, or Editor whose email uses a company domain. Generic email providers such as Gmail, Outlook, and Proton Mail do not qualify. Verification is required to use Boost.

Configure an upstream

Open Boost in the dashboard. Choose one of two setup paths:

Connect a QuickNode, Alchemy, Chainstack, or dRPC account. Boost creates dedicated resources in QuickNode, Alchemy, and Chainstack; with dRPC, it uses an unrestricted key already in your account.
Paste an HTTPS RPC URL and any authentication headers it needs.

Enabling Boost creates one Boost API key for the project. Copy it from the Boost dashboard; the same key works across every network you enable.

Prefer the CLI?

Run the interactive configuration flow:

goldsky boost enable

The setup wizard asks for a provider account, its management credential, and the networks to enable. See the goldsky boost CLI reference for non-interactive provider and endpoint management commands.

Make an eligible historical read

Boost endpoints use this format:

https://edge.goldsky.com/boost/{chain}?key={your-api-key}

Use a network name or chain ID. For example, /boost/ethereum and /boost/1 identify the same network.Enter your key, choose a network, and copy the generated command:

The first request for a range that has not been served recently can return x-cache: MISS while Boost warms the reader from storage. Run the request again before treating the method as ineligible.

Confirm who answered

Include -i in the curl request so the response headers are visible. A single request served by Boost looks like this:

x-cache: HIT
x-edge-source: cache
x-edge-billable: 1
x-edge-duration-ms: 14
x-edge-region: us-west-2

x-edge-billable is the number of request items Boost served. The name predates Boost’s free pricing; it is a count, not a charge.

Compare a forwarded request

Make a state read at latest, which remains with your provider:

curl "https://edge.goldsky.com/boost/ethereum?key=YOUR_KEY" \
  -i -X POST \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":2,"method":"eth_getBalance","params":["0x0000000000000000000000000000000000000000","latest"]}'

A forwarded response includes:

x-cache: MISS
x-edge-source: endpoint
x-edge-billable: 0

Update an existing client

Change the transport URL. The rest of the client configuration stays the same.

import { createPublicClient, http } from 'viem'
import { mainnet } from 'viem/chains'

const client = createPublicClient({
  chain: mainnet,
  transport: http('https://edge.goldsky.com/boost/ethereum?key=YOUR_KEY')
})

import { JsonRpcProvider } from 'ethers'

const provider = new JsonRpcProvider(
  'https://edge.goldsky.com/boost/ethereum?key=YOUR_KEY'
)

import Web3 from 'web3'

const web3 = new Web3(
  'https://edge.goldsky.com/boost/ethereum?key=YOUR_KEY'
)

Boost

Reference

Set up Boost

Prerequisites

Update an existing client

Next steps

Understand routing

Measure your hit rate

​Prerequisites

​Update an existing client

​Next steps

Understand routing

Measure your hit rate

Prerequisites

Update an existing client

Next steps