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
  • Changelog
Powered by GitBook
On this page
  1. API Models
  2. Portfolio

ChainSummary

Chains summary is the summary of the assets and protocols holdings, by chains.

{
  "chains": {
    "arbitrum": {
      "name": "Arbitrum",
      "key": "arbitrum",
      "chainId": "42161",
      "value": "216.023333769675975169",
      "valuePercentile": "0.291349316133329174",
      "totalCostBasis": "N/A",
      "totalClosedPnl": "N/A",
      "totalOpenPnl": "N/A",
      "imgSmall": "path-to-img.png"
    },
    "avalanche": {
      "name": "Avalanche",
      "key": "avalanche",
      "chainId": "43114",
      "value": "16.58625743771249472",
      "valuePercentile": "0.022369781436857085",
      "totalCostBasis": "N/A",
      "totalClosedPnl": "N/A",
      "totalOpenPnl": "N/A",
      "imgSmall": "path-to-img.png"
    }
  }
}

Typing

Key
Type
Description

name

string

Name of the blockchain network.

key

string

Identifier for the blockchain.

chainId

string

Blockchain network ID.

value

string

Total value of assets on this chain.

valuePercentile

string

Percentile value of the chain.

totalCostBasis

totalClosedPnl

totalOpenPnl

imgSmall

string

Url of the protocol image (small) includeImages param must be set to true

imgLarge

string

Url of the protocol image (large) includeImages param must be set to true



PreviousAssetNextNFTCollection

Last updated 27 days ago

N/A
N/A
N/A