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

ProtocolPosition

ProtocolPositions is a record of key / Protocol.The protocol's key is indicated by its type (e.g., WALLET, LENDING, STAKING).

More detail Protocol types supported by Octav

"protocolPositions": { 
        "LENDING": { // Ex of a protocol
          "assets": [],
          "name": "Lending",
          "protocolPositions": [
                {
                "assets": [],
                "borrowAssets": [
                    {
                        "balance": "45977.83354",
                        "chainContract": "ethereum:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
                        "chainKey": "ethereum",
                        "contract": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
                        "decimal": "6",
                        "name": "usd coin",
                        "openPnl": "0",
                        "price": "1.001201441730076",
                        "symbol": "usdc",
                        "totalCostBasis": "N/A",
                        "value": "46033.07322787344393954904"
                    }
                ],
                "dexAssets": [],
                "healthRate": "1.9318371766478242",
                "name": "steth",
                "rewardAssets": [],
                "supplyAssets": [
                    {
                        "balance": "33.284399154760166",
                        "chainContract": "ethereum:0xae7ab96520de3a18e5e111b5eaab095312d7fe84",
                        "chainKey": "ethereum",
                        "contract": "0xae7ab96520de3a18e5e111b5eaab095312d7fe84",
                        "decimal": "18",
                        "name": "lido staked ether",
                        "openPnl": "N/A",
                        "price": "3336.4273905860614",
                        "symbol": "steth",
                        "totalCostBasis": "N/A",
                        "value": "111050.9810191413682901442995501924"
                    }
                ],
                "totalCostBasis": "N/A",
                "totalClosedPnl": "N/A",
                "totalOpenPnl": "N/A",
                "unlockAt": "0",
                "vaultAddress": "",
                "poolAddress": "0x4e033931ad43597d96d6bcc25c280717730b58b1",
                "value": "65017.9077912679243505952595501924"
            }
            ],
            "totalOpenPnl": "N/A",
            "totalCostBasis": "N/A",
            "totalValue": "65017.9077912679243505952595501924",
            "unlockAt": "0"
        }

}

Nested protocol positions are managing diverse asset types (borrow, supplied, rewards, etc.)

Typing

Key
Type
Description

name

string

Name of the protocol.

totalOpenPnl

totalCostBasis

totalValue

string

Total value of all protocol assets.

unlockAt

string (timestamp)

Unlock time for protocol assets, if applicable.

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

explorerUrl

string

Explorer link includeExplorerUrls param must be set to true

assets

Asset[]

Array of assets held in the protocol (if applicable) See #protocol-positions-details

supplyAssets

Array of supplied assets (if applicable) See #protocol-positions-details

borrowAssets

Array of borrowed assets (if applicable) See #protocol-positions-details

rewardAssets

Array of reward assets (if applicable) See #protocol-positions-details

dexAssets

Array of dex assets (if applicable) See #protocol-positions-details

protocolPositions

Sub array of containing the protocol positions. See #protocol-positions-details


PreviousChainsNextAsset

Last updated 27 days ago

[]

[]

[]

[]

[]

N/A
N/A
Asset
Asset
Asset
Asset
ProtocolPosition