Nirvana Labs API | Vektor › Balances

Vektor

vektor

Domain types

Account = string

An EVM address

AddressEVM = string

An EVM address

APY = { apy, asset, type }

APY Data

Asset = { id, address, blockchain, 3 more... }

On-chain asset (aka token)

AssetID = string

An asset ID, represented as a TypeID with asset prefix

AssetIDOrAddressEVMOrAssetSymbol = string

An asset ID, represented as a TypeID with asset prefix

AssetSymbol = string

An asset symbol

Balance = { account, amount, asset_id, 3 more... }

Balance properties

BlockNumber = number

A block number

Blockchain = { id, chain_data, chain_type, 4 more... }

Data about a blockchain

BlockchainID = string

A blockchain ID, represented as a TypeID with blockchain prefix

BlockchainIDOrBlockchainSymbol = string

A blockchain ID, represented as a TypeID with blockchain prefix

BlockchainName = string

BlockchainName

BlockchainSymbol = string

A blockchain symbol

Blockstamp = { block_number, blockchain, timestamp }

Information about a specific block number and its timestamp

BorrowAccount = { account, available_borrow, blockstamp, 5 more... }

A borrow account

BorrowMarket = { id, apys, asset, 5 more... }

A borrow market

BorrowPosition = { account, blockstamp, debt_amount, 3 more... }

A borrow position

BridgeQuote = { fee_estimate, receive_amount, receive_asset, 5 more... }

A bridge quote

BuyQuote = { blockchain, fee_estimate, quote_asset_symbol, 7 more... }

A buy quote

ChainType = "evm"

Blockchain ecosystem

Decimal = string

An arbitrary precision decimal represented as a string

ErrorWrapper = { errors }

Wraps a list of errors into an error response

EVMChainData = { chain_id }

Data about an EVM blockchain

Execution = { id, created_at, request, 5 more... }

An execution

ExecutionEVMTransactionEIP1559Payload = { data, from, gasLimit, 6 more... }

The payload of an EIP-1559 transaction

ExecutionEVMTransactionPayload = { data, from, gasLimit, 6 more... }

The payload of an EIP-1559 transaction

ExecutionEVMTransactionState = "not_started" | "signature_required" | "signed" | 3 more...

The state of an EVM transaction

ExecutionID = string

An execution ID, represented as a TypeID with execution prefix

ExecutionState = "not_started" | "started" | "success" | 2 more...

The state of an execution

ExecutionStepID = string

An execution step ID, represented as a TypeID with execution_step prefix

HexString = string

A hex string starting with 0x

IncentivizeMarket = { amounts, assets, blockstamp, 6 more... }

A lp pool incentive market

LendBorrowAPYs = { base, rewards, total }

APY Data for lend/borrow markets

LendBorrowMarketID = string

A lend/borrow market ID, represented as a TypeID with lend_borrow_market prefix

LendMarket = { id, apys, asset, 5 more... }

A lend market

LendPosition = { account, blockstamp, collateral_enabled, 4 more... }

A lend position

LockMarket = { asset, blockchain, venue }

A lock market

LockPosition = { account, blockstamp, locked_amount, 5 more... }

A lock position

LPPool = { id, assets, attributes, 9 more... }

A liquidity pool

LPPoolSolidlyAttributes = { stable }

Attributes for Solidly venue type pools

LPPoolUniswapV3Attributes = { fee }

Attributes for Uniswap V3 venue type pools

LPPosition = { account, amounts, attributes, 7 more... }

A position in a liquidity pool

LPPositionAttributes = { in_range, lower, price, 3 more... }

Attributes for Uniswap V3 venue type positions

LPPositionUniswapV3Attributes = { in_range, lower, price, 3 more... }

Attributes for Uniswap V3 venue type positions

LPQuote = { account, amounts, amounts_delta, 5 more... }

An LP quote

LPUniswapV3PositionSpecifier = { position_nft }

Uniswap position specifier

LPUniswapV3Range = { lower, upper }

A Uniswap V3 range. Lower and upper bounds should satisfy 0 <= lower < upper. The value -1 can be used in upper for infinity

NetworkFeeEstimate = { amount, asset, cost, 1 more... }

Estimated cost of an operation

NetworkName = string

Blockchain's network

NFT = { id, collection }

A NFT

NFTCollection = { address, blockchain, name }

A NFT Collection

OffChainHistoricalRange = { from, to }

A range of timestamps

OnChainHistoricalRange = { from, to }

A range of blockstamps

Price = { asset_symbol, change_1h, change_1y, 6 more... }

A price

QuoteInfo0x = { estimated_gas_used, route }

Quote info for 0x

QuoteInfo0xFill = { from, proportion_bps, source, 1 more... }

A fill in a 0x quote

QuoteInfo0xRoute = { fills, tokens }

A route in a 0x quote

QuoteInfo0xToken = { address, symbol }

A token in a 0x quote

QuoteInfoCurve = { i_index, j_index, pool_id, 1 more... }

Quote info for Curve

QuoteInfoUniswapV2 = { pool_ids }

Quote info for Uniswap V2

QuoteInfoUniswapV3 = { pool_ids }

Quote info for Uniswap V3

RegistryLendBorrowMarket = { id, asset, blockchain, 1 more... }

Registry data for a lend borrow market

RegistryLPPool = { id, assets, blockchain, 1 more... }

Registry data for an LP pool

SellQuote = { blockchain, fee_estimate, quote_asset_symbol, 7 more... }

A sell quote

Timestamp = string

ISO8601 Timestamp

TimestampOrBlockNumber =

Timestamp

BlockNumber

Either a ISO8601 timestamp or a block number

TransactionHash = string

A transaction hash

VektorError = { message, params, type }

An error

Venue = { id, blockchain_ids, name, 3 more... }

On-chain venue

VenueID = string

A venue ID, represented as a TypeID with venue prefix

VenueIDOrVenueSymbol = string

A venue ID, represented as a TypeID with venue prefix

VenueSymbol = string

A venue symbol

VoteMarket = { blockstamp, market, quote_asset_symbol, 5 more... }

A LP incentive vote market

VoteReward = { account, blockstamp, fee_amounts, 7 more... }

A LP vote reward

Vektor

Balances

vektor.balances

Methods

List Balances -> { items }

post/v1/vektor/balances

List balances for a given set of assets and addresses

Response fields

items: Array<

Balance

Array of Balance

Request example

curl https://api.nirvanalabs.io//v1/vektor/balances \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "accounts": [
            "0x6b175474e89094c44da98b954eedeac495271d0f"
          ],
          "assets": [
            "asset_01jbz9qc00f8wr64hfe459gb7y"
          ],
          "blockchain": "blockchain_01jbz9nsy8egar70jg79dkwmaf",
          "quote_asset_symbol": "eth"
        }'

200Example

{
  "items": [
    {
      "account": "0x6b175474e89094c44da98b954eedeac495271d0f",
      "amount": "10.0000000000000024",
      "asset_id": "asset_01jbz9qc00f8wr64hfe459gb7y",
      "blockstamp": {
        "block_number": 18656966
      },
      "value": "10.0000000000000024",
      "quote_asset_symbol": "eth"
    }
  ]
}

List Balances Historical -> { historical, items }

post/v1/vektor/balances/historical

List balances for a given set of assets and addresses

Vektor

Borrow

vektor.borrow

Vektor Borrow

Accounts

vektor.borrow.accounts

Methods

List Borrow Accounts -> { items }

post/v1/vektor/borrow/accounts

Get account-level borrow info on specified accounts

List Borrow Accounts Historical -> { historical, items }

post/v1/vektor/borrow/accounts/historical

Get account-level borrow info on specified accounts

vektor.bridge

Vektor Bridge

Quotes

vektor.bridge.quotes

Methods

List Quotes -> { items }

post/v1/vektor/bridge/quotes

Get quotes for bridging an exact amount of an asset to another blockchain

Vektor

Buy

vektor.buy

Vektor Buy

Buy

vektor.buy.buy

Methods

Buy An Asset ->

Execution

post/v1/vektor/buy/buy

Buy an asset with another asset

Vektor Buy

Quotes

vektor.buy.quotes

Methods

List Buy Quotes -> { items }

post/v1/vektor/buy/quotes

Get quotes for buying an exact amount of an asset at current market rate

Vektor

Executions

vektor.executions

Methods

Get An Execution ->

Execution

get/v1/vektor/executions/{execution_id}

Get an execution

Get A List Of Executions -> Array<

Execution

get/v1/vektor/executions

Get a list of executions

Vektor Executions

Steps

vektor.executions.steps

Methods

Get A Step Of An Execution -> { id, created_at, definition, 3 more... }

get/v1/vektor/executions/{execution_id}/steps/{step_id}

Get a step of an execution

Sign An EVM Transaction Step ->

post/v1/vektor/executions/{execution_id}/steps/{step_id}/sign

Sign an EVM transaction step

Vektor

Incentivize

vektor.incentivize

Methods

List Incentivize Markets -> { items }

post/v1/vektor/incentivize/markets

List the current incentive markets

Vektor

Lend

vektor.lend

vektor.lend.set_collateral

Methods

Set Unset A Position As Collateral ->

Execution

post/v1/vektor/lend/set_collateral

Enable/disable a specific lending position to be used as collateral

Vektor Lend

Withdraw

vektor.lend.withdraw

Methods

Withdraw An Asset ->

Execution

post/v1/vektor/lend/withdraw

Withdraw an asset

Vektor

Lock

vektor.lock

Vektor Lock

Markets

vektor.lock.markets

Methods

List Lock Markets -> { items }

post/v1/vektor/lock/markets

vektor.lp.withdraw_quote

Methods

Withdraw Quote -> { items }

post/v1/vektor/lp/withdraw_quote

Simulate withdrawing liquidity from a specific existing LP position

Vektor

Move

vektor.move

Methods

Move Balance ->

Execution

post/v1/vektor/move/move

Move balance from one address to another

Vektor

Prices

vektor.prices

Methods

List Prices -> { items }

post/v1/vektor/prices

Get a list of asset prices

List Prices Historical -> { historical, items }

vektor.sell

Vektor Sell

Quotes

vektor.sell.quotes

Methods

List Sell Quotes -> { items }

post/v1/vektor/sell/quotes

Get quotes for selling an exact amount of an asset at current market rate

Vektor Sell

Sell

vektor.sell.sell

Methods

Sell An Asset ->

Execution

post/v1/vektor/sell/sell

Sell an asset for another asset

Vektor

Vote

vektor.vote

Vektor Vote

Markets

vektor.vote.markets

Methods

List Vote Markets -> { items }

post/v1/vektor/vote/markets

Get the current LP voting markets

Vektor Vote

Rewards

vektor.vote.rewards

Methods

List Vote Rewards -> { items }

post/v1/vektor/vote/rewards

Get the unclaimed rewards from LP voting markets

Vektor

Wrap

vektor.wrap

Vektor Wrap

Unwrap

vektor.wrap.unwrap

Methods

Unwrap Wrapped Native Asset ->

Execution

post/v1/vektor/wrap/unwrap

Unwrap the wrapped native asset

Vektor Wrap

Wrap

vektor.wrap.wrap

Methods

Wrap Native Asset ->

Execution

post/v1/vektor/wrap/wrap

Wrap the native asset