Brixs

On this page

API Overview

Welcome to the comprehensive Brixs Developer API reference.

Brixs provides a robust, highly-available JSON-RPC 2.0 API for interacting with the blockchain, querying state, subscribing to events, and submitting signed transactions.

Environment URLs

Local Development

https://rpc-testnet.brixs.space

Public Testnet

https://rpc-testnet.brixs.space

Current Status: Testnet

The Brixs network is currently running exclusively in a Testnet environment. The Mainnet RPC endpoints will be published closer to our official launch.

Authentication & API Keys

Public endpoints are rate-limited to 100 requests per IP per minute. For production usage and higher rate limits, you must generate a dedicated API key.

Generating an API Key:

  1. Navigate to the API Keys section in the Brixs Developer Explorer (/tools/api).
  2. Click Continue with GitHub to authenticate your developer account.
  3. Once authenticated, click Generate New Key to create a persistent, real API key linked to your GitHub account.
  4. Include this key as a header x-api-key: <YOUR_KEY> in your RPC requests.

Connection Best Practices

Phase 1: Local Setup

To begin developing, we recommend starting a local Brixs node using our developer CLI. This will instantly spin up a custom JSON-RPC gateway mapped to port 8545.

Code
# Initialize the local Brixs node brixs deploy

Phase 2: Connecting via Ethers.js

Because Brixs uses a native EVM execution layer (@ethereumjs/vm), you can connect using standard Web3 libraries without any custom SDKs.

Code
// Connect to the Testnet or Local RPC const { ethers } = require("ethers"); const provider = new ethers.providers.JsonRpcProvider("https://rpc-testnet.brixs.space"); async function checkStatus() { const blockNumber = await provider.getBlockNumber(); console.log(`Connected to Brixs! Current Block: ${blockNumber}`); } checkStatus();

Phase 3: Transaction Submission

Once connected, you can sign and submit transactions exactly as you would on Ethereum. The transactions are picked up by our Sequencer Mempool and eventually processed by our optimized execution engine.