Celo is an EVM-compatible blockchain designed to provide financial tools and services to anyone with a mobile phone. Known for its focus on usability and inclusive finance, Celo offers a robust environment for deploying Ethereum-based applications with an emphasis on mobile-first experiences.

The Celo API facilitates interaction with the Celo network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum’s JSON-RPC APIs will find working with Celo both intuitive and straightforward.

Send Your First Request on Alchemy

Let’s use the viem package to create a Celo client connected to Alchemy and fetch the latest block number!

npm install --save viem

Create Client Connected to Alchemy

1
import { createPublicClient, http } from "viem"; 
2
import { celo } from "viem/chains";
3
4
const client = createPublicClient({
5
  chain: celo,
6
  transport: http("https://celo-mainnet.g.alchemy.com/v2/YOUR_ALCHEMY_API_KEY"),
7
});

Now that you’ve created a client connected to Alchemy, you can continue with some basics:

Get Latest Block Number

1
const blockNumber = await client.getBlockNumber();
2
console.log("Current block number:", blockNumber);

Get an Address Balance

1
const balance = await client.getBalance({ address: "0xab5801a7d398351b8be11c439e05c5b3259aec9b" });
2
console.log("Balance (CELO):", Number(balance) / 1e18);

Read Block Data

1
const block = await client.getBlock({
2
  blockNumber: blockNumber, // from previous example
3
});
4
console.log(block);

Fetch a Transaction by Hash

1
const tx = await client.getTransaction({ hash: "0xYOUR_TX_HASH" });
2
console.log(tx);

Fetch Transaction Receipt

1
const receipt = await client.getTransactionReceipt({
2
  hash: "0xYOUR_TX_HASH"
3
});
4
console.log(receipt);

Celo APIs

For the full list of Celo APIs, see the Celo API Endpoints.