List all owned tokens (paginated) - Fireblocks Developer Docs

GET

nfts

ownership

tokens

TypeScript

const response: Promise<FireblocksResponse<GetOwnershipTokensResponse>> = fireblocks.nFTs.getOwnershipTokens(nFTsApiGetOwnershipTokensRequest);

CompletableFuture<ApiResponse<GetOwnershipTokensResponse>> response = fireblocks.nFTs().getOwnershipTokens(blockchainDescriptor, vaultAccountIds, ncwId, ncwAccountIds, walletType, ids, collectionIds, pageCursor, pageSize, sort, order, status, search, spam);

response = fireblocks.n_f_ts.get_ownership_tokens(blockchain_descriptor, vault_account_ids, ncw_id, ncw_account_ids, wallet_type, ids, collection_ids, page_cursor, page_size, sort, order, status, search, spam);

curl --request GET \
  --url https://api.fireblocks.io/v1/nfts/ownership/tokens

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/nfts/ownership/tokens', 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/nfts/ownership/tokens",
  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/nfts/ownership/tokens"

	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/nfts/ownership/tokens")

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

{
  "paging": {
    "next": "<string>"
  },
  "data": [
    {
      "id": "<string>",
      "tokenId": "<string>",
      "standard": "<string>",
      "balance": "<string>",
      "ownershipStartTime": 123,
      "ownershipLastUpdateTime": 123,
      "metadataURI": "<string>",
      "cachedMetadataURI": "<string>",
      "media": [
        {
          "url": "<string>"
        }
      ],
      "spam": {
        "result": true
      },
      "collection": {
        "id": "<string>",
        "name": "<string>",
        "symbol": "<string>"
      },
      "vaultAccountId": "<string>",
      "description": "<string>",
      "name": "<string>",
      "ncwId": "<string>",
      "ncwAccountId": "<string>"
    }
  ]
}

Query Parameters

blockchainDescriptor

enum<string>

Blockchain descriptor filter

Available options:

ETH,

ETH_TEST3,

ETH_TEST5,

ETH_TEST6,

POLYGON,

POLYGON_TEST_MUMBAI,

AMOY_POLYGON_TEST,

XTZ,

XTZ_TEST,

BASECHAIN_ETH,

BASECHAIN_ETH_TEST3,

BASECHAIN_ETH_TEST5,

ETHERLINK,

ETHERLINK_TEST,

MANTLE,

MANTLE_TEST,

GUN_GUNZILLA,

GUN_GUNZILLA_TEST,

ETH_SONEIUM,

SONEIUM_MINATO_TEST,

IOTX_IOTEX,

KLAY_KAIA,

KLAY_KAIA_TEST,

APECHAIN,

APECHAIN_TEST,

CRONOS,

CRONOS_TEST,

ROBINHOOD_CHAIN_TESTNET_TEST,

ARB

vaultAccountIds

string

A comma separated list of Vault Account IDs. Up to 100 are allowed in a single request. This field will be ignored when walletType=END_USER_WALLET or ncwId is provided.

ncwId

string

Tenant's Non-Custodial Wallet ID

ncwAccountIds

string

A comma separated list of Non-Custodial account IDs. Up to 100 are allowed in a single request. This field will be ignored when walletType=VAULT_ACCOUNT or ncwId is not provided.

walletType

enum<string>

default:VAULT_ACCOUNT

Wallet type, it can be VAULT_ACCOUNT or END_USER_WALLET

Available options:

VAULT_ACCOUNT,

END_USER_WALLET

ids

string

A comma separated list of NFT IDs. Up to 100 are allowed in a single request.

collectionIds

string

A comma separated list of collection IDs. Up to 100 are allowed in a single request.

pageCursor

string

Page cursor to fetch

pageSize

number

Items per page (max 100)

Required range: 1 <= x <= 100

sort

enum<string>[]

Sort by param, it can be one param or a list of params separated by comma

Available options:

ownershipLastUpdateTime,

name,

collection.name,

blockchainDescriptor

order

enum<string>

default:ASC

Order direction, it can be ASC for ascending or DESC for descending

Available options:

DESC,

ASC

status

enum<string>

default:LISTED

Token ownership status

Available options:

LISTED,

ARCHIVED

string

Search owned tokens and their collections. Possible criteria for search: token name and id within the contract/collection, collection name, blockchain descriptor and name.

spam

enum<string>

Token ownership spam status.

Available options:

true,

false,

all

Response

200 - application/json

paging

object

Show child attributes

data

object[]

Show child attributes

Refresh vault account tokensUpdates all tokens and balances per blockchain and vault account. Learn more about Fireblocks NFT management in the following [guide](https://developers.fireblocks.com/reference/deploy-an-nft-collection). Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

⌘I

TypeScript

const response: Promise<FireblocksResponse<GetOwnershipTokensResponse>> = fireblocks.nFTs.getOwnershipTokens(nFTsApiGetOwnershipTokensRequest);

CompletableFuture<ApiResponse<GetOwnershipTokensResponse>> response = fireblocks.nFTs().getOwnershipTokens(blockchainDescriptor, vaultAccountIds, ncwId, ncwAccountIds, walletType, ids, collectionIds, pageCursor, pageSize, sort, order, status, search, spam);

response = fireblocks.n_f_ts.get_ownership_tokens(blockchain_descriptor, vault_account_ids, ncw_id, ncw_account_ids, wallet_type, ids, collection_ids, page_cursor, page_size, sort, order, status, search, spam);

curl --request GET \
  --url https://api.fireblocks.io/v1/nfts/ownership/tokens

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/nfts/ownership/tokens', 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/nfts/ownership/tokens",
  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/nfts/ownership/tokens"

	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/nfts/ownership/tokens")

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

{
  "paging": {
    "next": "<string>"
  },
  "data": [
    {
      "id": "<string>",
      "tokenId": "<string>",
      "standard": "<string>",
      "balance": "<string>",
      "ownershipStartTime": 123,
      "ownershipLastUpdateTime": 123,
      "metadataURI": "<string>",
      "cachedMetadataURI": "<string>",
      "media": [
        {
          "url": "<string>"
        }
      ],
      "spam": {
        "result": true
      },
      "collection": {
        "id": "<string>",
        "name": "<string>",
        "symbol": "<string>"
      },
      "vaultAccountId": "<string>",
      "description": "<string>",
      "name": "<string>",
      "ncwId": "<string>",
      "ncwAccountId": "<string>"
    }
  ]
}