API

Stream NFT API rental integration

The Asset Manager API provides functionalities for managing asset managers in a blockchain-based ecosystem. Asset managers are entities responsible for managing various assets, such as digital tokens, NFTs (Non-Fungible Tokens), and other digital assets, on a blockchain network. These APIs allows users to retrieve information about asset managers based on their chain ID and contract address.

Endpoint:

• Main Net Base URL: https://indexer.streamnft.tech/

• Test Net Base URL: https://stagingindexer.streamnft.tech/

1. Use StreamNFT Indexer (1 API Call to get all User NFTs)

Retrieve user's NFTs

This API endpoint retrieves all NFTs associated with a specific wallet address on a given blockchain network. It provides an option to include rented NFTs in the response based on a query parameter.

GEThttps://devnfts.streamnft.tech/getNFTs/{chainId}/{wallet}

Path parameters

chainId*string

The chain ID to retrieve NFTs from

wallet*string

The wallet address to retrieve NFTs for

Query parameters

Response

200500

A list of NFTs

Body

application/json

resultarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://devnfts.streamnft.tech/getNFTs/{chainId}/{wallet}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "result": [
    {
      "chainId": "text",
      "collection": "text",
      "collectionName": "text",
      "collectionImage": "text",
      "lastUpdated": "2024-10-09T10:42:17.545Z",
      "tokenType": "text",
      "tokenId": [
        {
          "tokenId": "text",
          "balance": "text",
          "name": "text",
          "description": "text",
          "image": "text",
          "attributes": [
            {
              "trait_type": "text",
              "value": "text"
            }
          ]
        }
      ]
    }
  ]
}

2. Use External Indexer (2 API Call to get all User NFTs)

Query Parameters specific for rentals:

• collection: Filter for token address of the NFT collection

• rentee: Filter for assets rented by a wallet

• state: Filter for all assets on Marketplace (STALE) or rented out (RENT)

• onlyRentData : Output only rental data (NFT rentee, NFT owner, rental expiry, state)

Get Asset Manager by Chain ID

GEThttps://stagingindexer.streamnft.tech/assetManager/{chainId}

Path parameters

chainId*string

The ID of the blockchain chain

Example: "296"

Query parameters

Response

200500

Successful response

Body

application/json

idinteger (int64)

initializerstring

loan_pool_indexinteger (int64)

loan_offer_indexinteger (int64)

statestring

Specifies the state of the asset. Possible values include 'STALE', indicating that the asset is on the marketplace listed by a user, and 'RENT', indicating that the asset is currently rented out.

loan_expiryinteger (int64)

providerstring

rateinteger (int64)

validity_expiryinteger (int64)

is_fixedboolean

fixed_minutesinteger (int64)

rent_expiryinteger (int64)

renteestring

Specifies the current rentee of the asset. If the asset is not currently rented out, this field may be null.

private_rentalboolean

owner_shareinteger (int64)

whitelistarray of string

metadata_uristring

metadata_linkstring

namestring

imagestring

chain_idstring

contract_addressstring

token_addressstring

token_idstring

rental_typestring

profitinteger (int64)

domintboolean

loan_amountinteger (int64)

indexinteger (int64)

tx_hashstring

master_indexinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://stagingindexer.streamnft.tech/assetManager/{chainId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

[
  {
    "initializer": "text",
    "state": "text",
    "provider": "text",
    "is_fixed": false,
    "rentee": "text",
    "private_rental": false,
    "whitelist": [
      "text"
    ],
    "metadata_uri": "text",
    "metadata_link": "text",
    "name": "text",
    "image": "text",
    "chain_id": "text",
    "contract_address": "text",
    "token_address": "text",
    "token_id": "text",
    "rental_type": "text",
    "domint": false,
    "tx_hash": "text"
  }
]

Response:

• Successful responses return an array of asset managers for provided token address with detailed information, such as the current rentee and the state of each asset.

Example: How to Integrate

• Get all rented collection NFTs by user wallet

let nfts= indexerCall(wallet.address) // indexer call to get nfts by wallet
nfts.push.apply(nfts, await getNFTs(chainId,wallet.address,tokenAddress));

async function getNFTs(chainId, address,tokenAddress){
    const nfts = await fetch(`https://indexer.streamnft.tech/assetManager/${chainId}?user=${walletAddress}&collection=${collectionAddress}`)
    .then(response => {
        if (!response.ok) {
        throw new Error(`HTTP error! Status: ${response.status}`);
        }
        return response.json();
    })
    .catch(error => {
        // Handle network errors or API response errors here
        console.error('Error:', error.message);
    });
    return nfts;
}

• Get all rented NFTs by user wallet

let nfts= indexerCall(wallet.address) // indexer call to get nfts by wallet
nfts.push.apply(nfts, await getNFTs(chainId,wallet.address));

async function getNFTs(chainId, address){
    const nfts = await fetch(`https://indexer.streamnft.tech/assetManager/${chainId}?user=${walletAddress}`)
    .then(response => {
        if (!response.ok) {
        throw new Error(`HTTP error! Status: ${response.status}`);
        }
        return response.json();
    })
    .catch(error => {
        // Handle network errors or API response errors here
        console.error('Error:', error.message);
    });
    return nfts;
}