Octav - API Documentation
  • Welcome
  • Getting Started
    • API Access
    • Portfolio
    • Wallet
    • Transactions
    • Synchronization
    • Status
    • credits
  • API Models
    • Portfolio
      • AssetByProtocols
      • Chains
      • ProtocolPosition
      • Asset
      • ChainSummary
      • NFTCollection
      • NFTChain
      • NFTAsset
    • Transaction
      • Asset
      • NativeAssetFees
  • Additional Informations
    • Chains supported by Octav
    • Protocol types supported by Octav
    • Transaction type
    • Data freshness
    • AI agents / LLMS
  • Changelog
Powered by GitBook
On this page
  1. API Models
  2. Portfolio

NFTCollection

The nftsByCollection object organizes NFT collections by their key and contains details about chains and assets within those collections. NFTCollection is a record of key / NFTCollection, ex :

{
  "nftsByCollection": {
    "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85": {
      "name": "ENS: Ethereum Name Service",
      "key": "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85",
      "sellPrice": "0",
      "spotPrice": "0",
      "contract": "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85",
      "value": "0",
      "vaultId": "0",
      "vaultAddress": "0",
      "totalCostBasis": "N/A",
      "totalClosedPnl": "N/A",
      "totalOpenPnl": "N/A",
      "chains": {
        "ethereum": {
          "name": "Ethereum",
          "key": "ethereum",
          "value": "0",
          "totalCostBasis": "N/A",
          "totalClosedPnl": "N/A",
          "totalOpenPnl": "N/A",
          "assets": [
            {
              "averageClosedPnl": "N/A",
              "balance": "1",
              "balanceClosedPnl": "N/A",
              "category": "ERC721",
              "chain": "ethereum",
              "chainContract": "ethereum:0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85",
              "contract": "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85",
              "costBasis": "0",
              "decimal": "0",
              "name": "mbaril010.eth",
              "openPnl": "N/A",
              "price": "0",
              "tokenId": "6.3497744960286705017099019095945769897192966437114518675941725371725569413179e+76",
              "totalClosedPnl": "N/A",
              "totalCostBasis": "N/A",
              "type": "UNDEFINED",
              "value": "0"
            }
          ]
        }
      }
    }
  }
}

NFTCollection

Field

Type

Description

name

string

The name of the NFT collection.

key

string

The unique key (contract address) for the collection.

imgSmall

string

URL for the small-sized image of the collection.

imgLarge

string

URL for the large-sized image of the collection.

sellPrice

string

Sell price of the NFT collection.

spotPrice

string

Spot price of the NFT collection.

contract

string

Contract address of the collection.

value

string

Total value of the collection.

vaultId

string

Vault ID associated with the collection.

vaultAddress

string

Vault address associated with the collection.

totalCostBasis

totalClosedPnl

totalOpenPnl

chains

Chain-specific NFTs details


PreviousChainSummaryNextNFTChain

Last updated 2 months ago

Record<string, >

N/A
N/A
N/A
NFTChain