Botanix API Quickstart

To use the Botanix API you’ll need to create a free Alchemy account first!

Introduction

Botanix is a Bitcoin-native, EVM-compatible Layer 2 that makes it easy to build and run smart contracts using Bitcoin as the native asset.

What is the Botanix API?

The Botanix API allows interaction with the Botanix network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum’s JSON-RPC APIs, making it intuitive and straightforward to use.

Getting Started Instructions

1. Choose a Package Manager (npm or yarn)

Select a package manager to manage your project’s dependencies. Choose between npm and yarn based on your preference or project requirements.

$
# Begin with npm by following the npm documentation
>
# https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

2. Set Up Your Project

Open your terminal and execute the following commands to create and initialize your project:

$
mkdir botanix-api-quickstart
>
cd botanix-api-quickstart
>
npm init --yes

This creates a new directory named botanix-api-quickstart and initializes a Node.js project within it.

3. Make Your First Request

Install Axios, a popular HTTP client, to make API requests:

$
npm install axios

Create an index.js file in your project directory and paste the following code:

1
const axios = require('axios');
2
3
const url = 'https://botanix-mainnet.g.alchemy.com/v2/${your-api-key}';
4
5
const payload = {
6
  jsonrpc: '2.0',
7
  id: 1,
8
  method: 'eth_blockNumber',
9
  params: []
10
};
11
12
axios.post(url, payload)
13
  .then(response => {
14
    console.log('Latest Block:', response.data.result);
15
  })
16
  .catch(error => {
17
    console.error(error);
18
  });

Remember to replace your-api-key with your actual Alchemy API key that you can get from your Alchemy dashboard.

4. Run Your Script

Execute your script to make a request to the Botanix network:

$
node index.js

You should see the latest block information from Botanix’s network outputted to your console:

$
Latest Block: 0x...

Next Steps

Congratulations! You’ve made your first request to the Botanix network. You can now explore the various JSON-RPC methods available on Botanix and start building your dApps on this innovative platform.