Prerequisites

• Introduction
• Quickstart Guide or Developer Sandbox Quickstart

Overview

Postman is an application designed to help with API integration and exploration. Intuitive for different tech skill levels, this is the tool of choice both for experienced developers and no-code enthusiasts to get familiar with our available endpoints, requests, and responses.

Using our Postman Collection, you can start testing our API before you write a single line of code.

Install Postman and Fireblocks Collection

1. Download and install the Postman app or use Postman online.
2. Fork the Fireblocks API collection

After following the steps above and opening Postman, you'll see the Fireblocks API collection.

🚧

Important

Running calls in Postman for the Fireblocks API will not work unless you've properly configured your authentication settings for your environment.

Learn more about properly configuring your workspace.

Update environment variables

The Fireblocks Postman Collection comes with a built-in Fireblocks boilerplate environment (template).

Step 1: On the top right corner, select No Environment and then choose Boilerplate Fireblocks Environment.

Step 2: Select the eye icon next to it:

On the next screen, add three variables:

1. fireblocksApiKey: This is the API key you downloaded from the Users tab in Fireblocks Console.
2. fireblocksSecretKey: This is the fireblocks_secret.key file you created in the Quickstart Guide.
   You can set the type to be "secret" in order to hide the secret key content.
3. baseUrl: This should be set to either of the following, depending on the environment you are using:
   Mainnet/Testnet: https://api.fireblocks.io/v1
   Developer Sandbox: https://sandbox-api.fireblocks.io/v1

The result will look something like this:

Making your first request

🚧

Important

This Postman Collection makes use of a pre-request script to automatically generate the Authorization header for every request, which allows you to skip coding the signature process.
You can view this script by clicking on the "Pre-request Script" tab within the Collection.

1. The first API you will call is List vault accounts (Paginated) in your workspace.
2. Fireblocks API > vault > List vault accounts (Paginated)

3. An HTTP-200 "OK" response will be shown upon a successful API call.

What's next?

• API Reference