List blockchains with pagination and filtering

GET

blockchain_link

blockchains

TypeScript

const response: Promise<FireblocksResponse<ListBlockchainsResponse>> = fireblocks.blockchainLinkBeta.listBlockchainLinkChains(blockchainLinkBetaApiListBlockchainLinkChainsRequest);

CompletableFuture<ApiResponse<ListBlockchainsResponse>> response = fireblocks.blockchainLinkBeta().listBlockchainLinkChains(pageCursor, pageSize, search, status, blockchainEnv, sortBy, order, statusExclude);

response = fireblocks.blockchain_link_beta.list_blockchain_link_chains(page_cursor, page_size, search, status, blockchain_env, sort_by, order, status_exclude);

curl --request GET \
  --url https://api.fireblocks.io/v1/blockchain_link/blockchains

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/blockchain_link/blockchains', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/blockchain_link/blockchains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/blockchain_link/blockchains"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/blockchain_link/blockchains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [],
  "total": 100,
  "next": "some_value",
  "prev": "some_value"
}

{
  "message": "<string>",
  "code": 123
}

Query Parameters

pageCursor

string

tenant_id is extracted from JWT token context. Opaque cursor for the requested page. Currently encodes the 1-based page number as a decimal string ("1", "2", ...); treat as opaque on the client. Absent = first page.

pageSize

number

default:20

Maximum number of items per page. Default 20, clamped to [1, 1000].

Required range: 1 <= x <= 1000

string

Free-text search across chain and symbol name.

status

enum<string>[]

Include filter (repeated query params).

Blockchain lifecycle state used for list filtering.

Available options:

BLOCKCHAIN_STATE_CREATED,

BLOCKCHAIN_STATE_ACTIVATING,

BLOCKCHAIN_STATE_ACTIVATED,

BLOCKCHAIN_STATE_DEACTIVATING,

BLOCKCHAIN_STATE_DEACTIVATED,

BLOCKCHAIN_STATE_TECHNICAL_FAILURE

blockchainEnv

enum<string>

Filter by network. Blockchain network environment.

Available options:

MAINNET,

TESTNET

sortBy

enum<string>

Sort field. Default: createdAt. Field to sort the blockchain list by.

Available options:

createdAt,

chainName,

symbolName,

status

order

enum<string>

default:DESC

Sort order. Default: DESC.

Available options:

ASC,

DESC

statusExclude

enum<string>[]

Exclude filter (repeated query params).

Blockchain lifecycle state used for list filtering.

Available options:

BLOCKCHAIN_STATE_CREATED,

BLOCKCHAIN_STATE_ACTIVATING,

BLOCKCHAIN_STATE_ACTIVATED,

BLOCKCHAIN_STATE_DEACTIVATING,

BLOCKCHAIN_STATE_DEACTIVATED,

BLOCKCHAIN_STATE_TECHNICAL_FAILURE

Response

data

object[]

required

Blockchains for the current page.

Show child attributes

Example:

[]

total

number

required

Total number of items across all pages, matching the current filter.

Example:

100

string

Cursor for the next page; absent when the current page is the last. Opaque base64 blob bundling the target pageCursor and current query params (pageSize, search, status, statusExclude, blockchainEnv, sortBy, order).

Example:

"some_value"

string

Cursor for the previous page; absent when the current page is the first.

Example:

"some_value"

Create a new blockchainRegisters a new tenant-managed blockchain from the supplied declared properties. The blockchain starts in the CREATED state and must be activated separately before it can be used.

⌘I

TypeScript

const response: Promise<FireblocksResponse<ListBlockchainsResponse>> = fireblocks.blockchainLinkBeta.listBlockchainLinkChains(blockchainLinkBetaApiListBlockchainLinkChainsRequest);

CompletableFuture<ApiResponse<ListBlockchainsResponse>> response = fireblocks.blockchainLinkBeta().listBlockchainLinkChains(pageCursor, pageSize, search, status, blockchainEnv, sortBy, order, statusExclude);

response = fireblocks.blockchain_link_beta.list_blockchain_link_chains(page_cursor, page_size, search, status, blockchain_env, sort_by, order, status_exclude);

curl --request GET \
  --url https://api.fireblocks.io/v1/blockchain_link/blockchains

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/blockchain_link/blockchains', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/blockchain_link/blockchains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/blockchain_link/blockchains"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/blockchain_link/blockchains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [],
  "total": 100,
  "next": "some_value",
  "prev": "some_value"
}

{
  "message": "<string>",
  "code": 123
}