> ## Documentation Index
> Fetch the complete documentation index at: https://docs.uniblock.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Uniblock Quickstart Guide

> Quickstart guide to Uniblock! Learn how to create an Uniblock project, make your first request with our providers, create an API key, and setup up Uniblock as your client.

# 👋 Getting Started

New to Uniblock? Get access for free through our [dashboard](https://dashboard.uniblock.dev/)

Estimated time to complete this guide: \< 10 minutes

## 📋 Steps to get started with Uniblock

This guide assumes you already have an Uniblock account and access to our Dashboard.

1. 🦄 Create an Uniblock Project

2. ✍️ Make a request

3. 🔑 Get your Project API Key

4. 🤝 Set up Uniblock as your client

5. 💻 Start building!

## 1. Create an Uniblock Project 🦄

To use Uniblock's products, you need a project to authenticate your requests.

You can create a project from the dashboard. Follow the steps below to create a project:

1. First, navigate to your Uniblock's dashboard and click on the `Home` tab.

<img src="https://mintcdn.com/uniblock/ce6MWTwGsgFUjX8w/images/docs/749db1f7fec43f84358862885f1c8285cd615a71b1ee2fa3c032dc29588c8022-1732205678498.png?fit=max&auto=format&n=ce6MWTwGsgFUjX8w&q=85&s=f69f3e59f637bdbe6833ac7c55094703" alt="" width="1401" height="564" data-path="images/docs/749db1f7fec43f84358862885f1c8285cd615a71b1ee2fa3c032dc29588c8022-1732205678498.png" />

2. Next click on the create a project button in the Get Started section.

<img src="https://mintcdn.com/uniblock/ce6MWTwGsgFUjX8w/images/docs/5d6ff39096dcda3a47a70e0fcadbd1527e3049fde3c5de8752314d419f72b2c3-1732205704970.png?fit=max&auto=format&n=ce6MWTwGsgFUjX8w&q=85&s=a9ee2aede3b36c3ad805f04fd9f64b32" alt="" width="1407" height="572" data-path="images/docs/5d6ff39096dcda3a47a70e0fcadbd1527e3049fde3c5de8752314d419f72b2c3-1732205704970.png" />

3. Enter in a new project name and then click on `create`.

<img src="https://mintcdn.com/uniblock/AAmZ2PQpKS7NEhKq/images/docs/241feedcccb730797f955cdd1c609244b97a7e7d0001f0330ff1dbf037b6394b-1732205789861.png?fit=max&auto=format&n=AAmZ2PQpKS7NEhKq&q=85&s=e26afb9cbb322ce7dd037d62348cc966" alt="" width="526" height="249" data-path="images/docs/241feedcccb730797f955cdd1c609244b97a7e7d0001f0330ff1dbf037b6394b-1732205789861.png" />

## 2. Make a request ✍️

Nice! You've made your project. Next you can interact with Uniblock's providers and also make a call to our endpoints.

1. Following from before, you can click on your project. To bring you to your project dashboard.

<img src="https://mintcdn.com/uniblock/uPcmKAfw2UCOwfSR/images/docs/e1849b43bff46fe0e5c24ab17710ec49d577ad5978f24c1e61f7285167393dc6-1732205846036.png?fit=max&auto=format&n=uPcmKAfw2UCOwfSR&q=85&s=c606b28a2d551c3bc0a67814f0419d4b" alt="" width="1410" height="606" data-path="images/docs/e1849b43bff46fe0e5c24ab17710ec49d577ad5978f24c1e61f7285167393dc6-1732205846036.png" />

2. You will be present with your project home page like the following.

<img src="https://mintcdn.com/uniblock/AAmZ2PQpKS7NEhKq/images/docs/003dbc7b6b948c0c8eb8636a96d71ca3d8fc035bd84b8ecd31a954e9df5d7c32-1732204195732.jpg?fit=max&auto=format&n=AAmZ2PQpKS7NEhKq&q=85&s=57de4453ff112ae1571e6e7d3c8a23bd" alt="" width="1418" height="917" data-path="images/docs/003dbc7b6b948c0c8eb8636a96d71ca3d8fc035bd84b8ecd31a954e9df5d7c32-1732204195732.jpg" />

3. There are lots of things you can explore around and find out about but to call our endpoint you can click on the `Endpoints` -> `API Tester` section on the left nav-bar.

<img src="https://mintcdn.com/uniblock/AAmZ2PQpKS7NEhKq/images/docs/3615dadc82eaa8d8d22c55adef8b4416c308c0ab706572ced5705414fdc3fe1f-1732204710176.png?fit=max&auto=format&n=AAmZ2PQpKS7NEhKq&q=85&s=7169081fbc9c497d8f5b90f0b05f2861" alt="" width="1417" height="917" data-path="images/docs/3615dadc82eaa8d8d22c55adef8b4416c308c0ab706572ced5705414fdc3fe1f-1732204710176.png" />

4. A new tab will open to show the explorer where you can select an endpoint you like and try calling the endpoint. We will go with the `/token/metadata` endpoint.

<img src="https://mintcdn.com/uniblock/ce6MWTwGsgFUjX8w/images/docs/8980e93-image.png?fit=max&auto=format&n=ce6MWTwGsgFUjX8w&q=85&s=1544b25bc38bebfdba60711b09638594" alt="" width="1" height="1" data-path="images/docs/8980e93-image.png" />

<img src="https://mintcdn.com/uniblock/AAmZ2PQpKS7NEhKq/images/docs/32bcc92a1607c164edfdab3a7d9d096857bb0d4b1eeb1e9b1312d8b8e9341bd8-1732204871388.png?fit=max&auto=format&n=AAmZ2PQpKS7NEhKq&q=85&s=3f2997b73e847ed9a157783124aa6413" alt="" width="1346" height="915" data-path="images/docs/32bcc92a1607c164edfdab3a7d9d096857bb0d4b1eeb1e9b1312d8b8e9341bd8-1732204871388.png" />

5. You will see the details about this endpoint.

<img src="https://mintcdn.com/uniblock/uPcmKAfw2UCOwfSR/images/docs/b996a49f4d2f744d1ddfe022a0365655041373d4fc02d8696878933e6b83b34b-1732205022262.png?fit=max&auto=format&n=uPcmKAfw2UCOwfSR&q=85&s=09220a2a2cbb659b8798404fc3512661" alt="" width="1345" height="665" data-path="images/docs/b996a49f4d2f744d1ddfe022a0365655041373d4fc02d8696878933e6b83b34b-1732205022262.png" />

6. Now we try to call this endpoint, by clicking the "Try it out" button.

<img src="https://mintcdn.com/uniblock/uPcmKAfw2UCOwfSR/images/docs/e663e61ca086b66f89d2118b869e21a8b285a75d91b2199be1f39336d32e0128-1732205249017.png?fit=max&auto=format&n=uPcmKAfw2UCOwfSR&q=85&s=a6c5f54227ad0892714ba65bd7102031" alt="" width="1345" height="665" data-path="images/docs/e663e61ca086b66f89d2118b869e21a8b285a75d91b2199be1f39336d32e0128-1732205249017.png" />

7. Click "Execute" button to send a request with the provided example parameters.

<img src="https://mintcdn.com/uniblock/AAmZ2PQpKS7NEhKq/images/docs/326b7879598655de4dec4c590bfbed8f3c1193231f6987fcf1c96def396ae040-1732205354299.png?fit=max&auto=format&n=AAmZ2PQpKS7NEhKq&q=85&s=7bd541b5605268731f2c904a647bc0d8" alt="" width="1341" height="614" data-path="images/docs/326b7879598655de4dec4c590bfbed8f3c1193231f6987fcf1c96def396ae040-1732205354299.png" />

8. Here is the successful response with 200 status code.

<img src="https://mintcdn.com/uniblock/ce6MWTwGsgFUjX8w/images/docs/899e8f899723ee442c907aa5b233c2783b348175fbafd866eeefba659994c829-1732205441982.png?fit=max&auto=format&n=ce6MWTwGsgFUjX8w&q=85&s=63a4b897e3c0d24cade9ffc6ca87d4bd" alt="" width="1344" height="469" data-path="images/docs/899e8f899723ee442c907aa5b233c2783b348175fbafd866eeefba659994c829-1732205441982.png" />

9. Nice job! You've made your first call with Uniblock! 🎉

## 3. Get your Project API Key 🔑

You also can test calling the endpoint using your own API.

1. After you've created your project, you will find your API key on the `Overview` page.

<img src="https://mintcdn.com/uniblock/uPcmKAfw2UCOwfSR/images/docs/dfa3a1d6dcc45e0e55c48513bd3e4fa7fe28819055dd9c7382aa86ae5d0626bb-1732206001424.png?fit=max&auto=format&n=uPcmKAfw2UCOwfSR&q=85&s=24c75dd26579b0fa0481088fc92852d0" alt="" width="1415" height="914" data-path="images/docs/dfa3a1d6dcc45e0e55c48513bd3e4fa7fe28819055dd9c7382aa86ae5d0626bb-1732206001424.png" />

2. Add the key to the `Explorer`.

<img src="https://mintcdn.com/uniblock/AAmZ2PQpKS7NEhKq/images/docs/14a4b12e0c595880c1c41fd3d7dba8dd804bbb5e10a2fc6eeae46dd091baae9e-1732206273017.png?fit=max&auto=format&n=AAmZ2PQpKS7NEhKq&q=85&s=23847df82db6697fb7909ff993b15747" alt="" width="1397" height="891" data-path="images/docs/14a4b12e0c595880c1c41fd3d7dba8dd804bbb5e10a2fc6eeae46dd091baae9e-1732206273017.png" />

<img src="https://mintcdn.com/uniblock/AAmZ2PQpKS7NEhKq/images/docs/1e4fc23c2d0610f347ed675f4e33e2a7a2797a22918fa318d39548c9afea7d61-1732206312150.png?fit=max&auto=format&n=AAmZ2PQpKS7NEhKq&q=85&s=a591dace92c4db3a0684961362aa2104" alt="" width="651" height="334" data-path="images/docs/1e4fc23c2d0610f347ed675f4e33e2a7a2797a22918fa318d39548c9afea7d61-1732206312150.png" />

<img src="https://mintcdn.com/uniblock/ce6MWTwGsgFUjX8w/images/docs/8f5299d8513ffa081e948b5263e0478cd4087fa6f20bbe430aed9385b5042cf4-1732206447762.png?fit=max&auto=format&n=ce6MWTwGsgFUjX8w&q=85&s=58825b5839e780fce19ac6e79d999d56" alt="" width="629" height="327" data-path="images/docs/8f5299d8513ffa081e948b5263e0478cd4087fa6f20bbe430aed9385b5042cf4-1732206447762.png" />

3. Now you are logged in with your API key. The data from the requests made using this key will be collected and displayed in the project metrics.

## 4. Setup Uniblock as your Client 🤝

Want to integrate Uniblock into your production app?

Find out how to set up or switch your current provider to Uniblock by using node js. An easy way to interact and use us.

1. From your command line, create a new project directory.

With Yarn:

<CodeGroup>
  ````bash bash mkdir your-project-name cd your-project-name yarn init # (or yarn theme={null}
  init --yes) ```
  </CodeGroup>

  With NPM:

  <CodeGroup>
  ```bash bash mkdir your-project-name cd your-project-name npm init # (or npm
  init --yes) ```
  </CodeGroup>

  2. Create a file named index.js and add the following contents:

  <Info>### You should replace demo with your Uniblock's Project API key.</Info>

  index.js

  <CodeGroup>
  ```bash bash
  const options = {
    method: 'GET',
    headers: {
      accept: 'application/json',
      'X-API-KEY': 'demo-api-key'
    }
  };

  fetch('https://api.uniblock.dev/uni/v1/token/balance?chainId=1&walletAddress=0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

  ````
</CodeGroup>

3. Run it using node

<CodeGroup>
  ```bash bash theme={null}
  node index.js
  ```
</CodeGroup>

4. You should now see the latest token/balance output in your console!

<CodeGroup>
  ```bash bash theme={null}
  {
    "balances": [
      {
        "contractAddress": "0x0000000000095413afc295d19edeb1ad7b71c952",
        "balance": "100000000000000000000"
      },
      {
        "contractAddress": "0x0000000035f26e72b70552b92bf7e02f67a90549",
        "balance": "20000000000000000000000000"
      },
      {
        "contractAddress": "0x00000006e55a9364b657e3b91cd0411b4fd11ac2",
        "balance": "20082049953158728210968860"
      },
      ...
    ],
    "cursor": "ALC_0x09a3ecafa817268f77be1283176b946c4ff2e608"
  }
  ```
</CodeGroup>

Woo! Congrats! You just wrote your first web3 script using Uniblock and sent your first request to your Uniblock API endpoint 🎉

The app associated with your API key will also have more details about your endpoint call.

### Analytics & Logs:

1. After executing an API call, head over to your project and click on the **Analytics** section.

   <img src="https://mintcdn.com/uniblock/uPcmKAfw2UCOwfSR/images/docs/d955d18bab2151421db8e3057c2afd0fd8a6c014cc922c575a7c13c6d564c3ee-1733156465130.png?fit=max&auto=format&n=uPcmKAfw2UCOwfSR&q=85&s=2127ddb1c71600739876f46649c5cb9d" alt="" width="1871" height="912" data-path="images/docs/d955d18bab2151421db8e3057c2afd0fd8a6c014cc922c575a7c13c6d564c3ee-1733156465130.png" />

2. Here, scroll down to **See Detailed Logs** to delve deeper into each call's specifics.

   <img src="https://mintcdn.com/uniblock/AAmZ2PQpKS7NEhKq/images/docs/0b26f5702a03e8def8c8de6dc43c61f057b39061eff23e591aa062a02d9a8361-1733156557425.png?fit=max&auto=format&n=AAmZ2PQpKS7NEhKq&q=85&s=624a7bf16d66c1aa0bc364f4114a83ce" alt="" width="1522" height="639" data-path="images/docs/0b26f5702a03e8def8c8de6dc43c61f057b39061eff23e591aa062a02d9a8361-1733156557425.png" />

3. View detailed information for each call, such as request type, timestamp, response time, headers, and much more.

<img src="https://mintcdn.com/uniblock/AAmZ2PQpKS7NEhKq/images/docs/4e2377f325adc426a06e9784ba6372b6696b214d0bc388d0bc9b6329e96321ac-1733156671380.png?fit=max&auto=format&n=AAmZ2PQpKS7NEhKq&q=85&s=9207014d3023b104a5c94d665a55d06c" alt="" width="1524" height="774" data-path="images/docs/4e2377f325adc426a06e9784ba6372b6696b214d0bc388d0bc9b6329e96321ac-1733156671380.png" />

### Congratulations! 🎉

You've now successfully set up and utilized Uniblock for your project.

***

[Overview](/reference/unified-api/overview-unified-apis)

***

<Card title="Ready to get started with Uniblock?" icon="rocket" href="https://dashboard.uniblock.dev">
  Create your free account and start building with unified blockchain infrastructure across 100+ chains.
</Card>

<CardGroup cols={2}>
  <Card title="View API reference" icon="book" href="/reference/unified-api-reference-overview">
    Explore all available endpoints and interactive playgrounds
  </Card>

  <Card title="Join our community" icon="discord" href="https://discord.gg/uniblock">
    Get help from our team and connect with other developers
  </Card>
</CardGroup>
