OpenTrade Sandbox Docs
  • 🏖️OpenTrade Sandbox
    • 🖥️Sandbox API & Web App
    • 📧Contract Addresses
    • 🏎️Getting Started
    • 4️⃣Version 4 Integrations
      • 🔌On-Chain Integration for Flexible Term Vault (V4)
      • ⚙️API Integrations for Flexible Term Vaults (V4)
        • REST API
          • Return a list of vaults
          • Query a specific vault
          • Query a specific account
        • GraphQL API
    • 5️⃣Version 5 Integrations
      • 🔌Protocol Integrations (V5)
      • ⚙️API Integrations (V5)
        • Return a list of vaults
        • Query a specific vault
        • Query a specific account
        • Query withdrawal activity
        • Get events for a vault
        • Get events for an account
        • Get historical data for a vault
        • Get historical data for an account
Powered by GitBook

Copyright Open Trade Technology Ltd 2023-2024. All rights reserved.

On this page
  1. OpenTrade Sandbox
  2. Version 5 Integrations
  3. API Integrations (V5)

Return a list of vaults

This endpoint will return a list of active vaults

PreviousAPI Integrations (V5)NextQuery a specific vault

Last updated 6 days ago

Return a list of vaults

The GET /Vaults endpoint returns a list of active vaults and key information about them.

Vaults with poolType of "0" are (V4)

Vaults with poolType of "1" are (V4)

Vaults with poolType of "2" are Dynamic Vaults (V5)

🏖️
5️⃣
⚙️
Fixed Term Vaults
Flexible Term Vaults
get

getPoolListFunction

Authorizations
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opentradeqa.com/vaults' \
  --header 'x-api-key: YOUR_API_KEY'
200
[
  {
    "businessDayRegistryAddr": "0x67a6235338b995159da9bd90ef6807d357c45c7b",
    "closeOfDepositTime": 0,
    "closeOfWithdrawTime": 0,
    "transferInDays": 0,
    "transferOutDays": 0,
    "nonBusinessDays": "",
    "feeVaultAddr": "0xe44c4bcce7fca721ea0cb0b726b87bdce3cc0f4a",
    "withdrawControllerAddr": "0x7138c5feed17245465d805e9204800f3216fe495",
    "borrowerVaultAddr": "0x5c9e3437e882af31643cbff88f51ac5b869db7c0",
    "maxCapacity": "0",
    "id": "",
    "poolType": 0,
    "poolAddr": "0x1365382073524f9747f5b4e3890d4fd99566f857",
    "liquidityAssetAddr": "0xfd7e65a2e5e8c8e9fd892650115d39ed363b1e7c",
    "poolControllerAddr": "0x5d94d060a1fe8fcb9609866398c5be3e68dd65b8",
    "name": "TokenName",
    "symbol": "OTT",
    "borrowerManagerAddr": "0x666283560c99123b55c1a0cef5d587b9d22625cd",
    "poolAdminAddr": "0xbeb34959d3812d0a7a28418ac4b0daff2602f455",
    "borrowerWalletAddr": "0x73daa298e4ffa8250cefea81f938e745e069fa14",
    "chainConfigurationName": "",
    "creationBlock": 0
  }
]

Vault list

get

getPoolEventsFunction

Authorizations
Path parameters
vaultAddressstring · EthAddrrequired
Query parameters
startDayStrstringoptional

The start day in format DD-MM-YYYY

Example: 21-02-2025
Pattern: ^\d{2}-\d{2}-\d{4}$
endDayStrstringoptional

The end day in format DD-MM-YYYY

Example: 21-03-2025
Pattern: ^\d{2}-\d{2}-\d{4}$
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opentradeqa.com/poolEvents/{vaultAddress}' \
  --header 'x-api-key: YOUR_API_KEY'
200
[
  {
    "id": "",
    "poolAddr": "0x2e81ae38d3c9fabbec7ae746b38ebea322c61284",
    "poolName": "",
    "poolAddrAccountAddr": "0xa4e6bf4add535407e916e5bd4874186d2169a7a9",
    "eventType": "",
    "eventName": "",
    "currency": "",
    "symbol": "OTT",
    "accountAddr": "0x2b26ba70c1ce05ea175a454bbec8e666cf7c8e57",
    "withdrawSequenceId": "",
    "withdrawStage": "",
    "loanAddr": "0x98249cb2fd7735ca4f6419ce006da41d5724a463",
    "receiverAddr": "0x1a35144d465aa5bd80cb7a3feb51624588066615",
    "senderAddr": "0x4bd604c04366a08a4d49bdde25473e27199f2353",
    "priorLoanAddr": "0xecabb953cab9274e2e9978c16bc0235d1fa27ed3",
    "blockNumber": 0,
    "transactionHash": "",
    "timestamp": 0,
    "transferOutDayTimestamp": 0,
    "transferInDayTimestamp": 0,
    "chainId": "5",
    "assets": "12000000000",
    "liquidityTokenSymbol": "",
    "shares": "42000000000",
    "assetsFromPool": "9000000000",
    "assetsFromPriorToNextLoan": "16000000000",
    "assetToReturnToPool": "39000000000",
    "fees": "69000000000",
    "principal": "63000000000",
    "repayment": "15000000000",
    "liquidityAssetAddr": "0x5a3c55391b052c1a2db7094df599f55696443473",
    "poolLiquidityAssetBalance": "35000000000",
    "borrowerVaultLiquidityAssetBalance": "20000000000",
    "borrowerWalletLiquidityAssetBalance": "55000000000",
    "feeVaultLiquidityAssetBalance": "80000000000",
    "poolAdminLiquidityAssetBalance": "32000000000",
    "accountLiquidityAssetBalance": "39000000000",
    "accountTokenBalance": "32000000000",
    "interestAccrued": "89000000000",
    "emailStatus": "",
    "depositType": 0,
    "transferTxHash": ""
  }
]

Get Pool Events

get

get Pool Events for a given accountAddress

Authorizations
Path parameters
vaultAddressstring · EthAddrrequired
accountAddressstring · EthAddrrequired
Query parameters
startDayStrstringoptional

The start day in format DD-MM-YYYY

Example: 21-02-2025
Pattern: ^\d{2}-\d{2}-\d{4}$
endDayStrstringoptional

The end day in format DD-MM-YYYY

Example: 21-03-2025
Pattern: ^\d{2}-\d{2}-\d{4}$
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opentradeqa.com/poolEvents/{vaultAddress}/{accountAddress}' \
  --header 'x-api-key: YOUR_API_KEY'
200
[
  {
    "id": "",
    "poolAddr": "0x2e81ae38d3c9fabbec7ae746b38ebea322c61284",
    "poolName": "",
    "poolAddrAccountAddr": "0xa4e6bf4add535407e916e5bd4874186d2169a7a9",
    "eventType": "",
    "eventName": "",
    "currency": "",
    "symbol": "OTT",
    "accountAddr": "0x2b26ba70c1ce05ea175a454bbec8e666cf7c8e57",
    "withdrawSequenceId": "",
    "withdrawStage": "",
    "loanAddr": "0x98249cb2fd7735ca4f6419ce006da41d5724a463",
    "receiverAddr": "0x1a35144d465aa5bd80cb7a3feb51624588066615",
    "senderAddr": "0x4bd604c04366a08a4d49bdde25473e27199f2353",
    "priorLoanAddr": "0xecabb953cab9274e2e9978c16bc0235d1fa27ed3",
    "blockNumber": 0,
    "transactionHash": "",
    "timestamp": 0,
    "transferOutDayTimestamp": 0,
    "transferInDayTimestamp": 0,
    "chainId": "5",
    "assets": "12000000000",
    "liquidityTokenSymbol": "",
    "shares": "42000000000",
    "assetsFromPool": "9000000000",
    "assetsFromPriorToNextLoan": "16000000000",
    "assetToReturnToPool": "39000000000",
    "fees": "69000000000",
    "principal": "63000000000",
    "repayment": "15000000000",
    "liquidityAssetAddr": "0x5a3c55391b052c1a2db7094df599f55696443473",
    "poolLiquidityAssetBalance": "35000000000",
    "borrowerVaultLiquidityAssetBalance": "20000000000",
    "borrowerWalletLiquidityAssetBalance": "55000000000",
    "feeVaultLiquidityAssetBalance": "80000000000",
    "poolAdminLiquidityAssetBalance": "32000000000",
    "accountLiquidityAssetBalance": "39000000000",
    "accountTokenBalance": "32000000000",
    "interestAccrued": "89000000000",
    "emailStatus": "",
    "depositType": 0,
    "transferTxHash": ""
  }
]

Get Pool Events

get

getWithdrawActivityFunction

Authorizations
Path parameters
vaultAddressstring · EthAddrrequired
accountAddressstring · EthAddrrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opentradeqa.com/withdrawalActivity/{vaultAddress}/{accountAddress}' \
  --header 'x-api-key: YOUR_API_KEY'
200
[
  {
    "requestedShares": "64000000000",
    "requestedAssets": "32000000000",
    "requestedPrinipal": "28000000000",
    "requestedRepayment": "15000000000",
    "requestTimestamp": 0,
    "processedTimestamp": 0,
    "repaidTimestamp": 0,
    "lender": "0x07e00792a79c04e7391e38880aca33f7210dba08",
    "loanAddr": "0xec53ffbcfcde5d297b9130bccefa67caa534da3b",
    "status": "",
    "eventId": "",
    "transactionHash": ""
  }
]

Get Withdrawal Activities

get

getPoolAccountCTOFunction

Authorizations
Path parameters
vaultAddressstring · EthAddrrequired
accountAddressstring · EthAddrrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opentradeqa.com/vaultsAccount/{vaultAddress}/{accountAddress}' \
  --header 'x-api-key: YOUR_API_KEY'
200
{
  "poolAddress": "text",
  "accountAddress": "text",
  "vaultAccountCTO": {
    "id": "",
    "blockNumber": 0,
    "timestamp": 0,
    "dayNumber": 0,
    "timeOfDay": 0,
    "poolType": 0,
    "poolAddr": "0xf15bb1b644f73f596b291b8f6606fb02731678d3",
    "liquidityAssetAddr": "0x7dffac9c554c5b1bc5710534c47d650c7caf2ba2",
    "accountAddr": "0x0b497a7bded9e9b30010cfd3db13058db52d2e1a",
    "tokenBalance": "6000000000",
    "interestRate": "",
    "interestInDay": "71000000000",
    "principalEarningInterest": "27000000000",
    "dailyInterestRate": "",
    "maxWithdrawRequest": "56000000000",
    "maxRedeemRequest": "77000000000",
    "requestedSharesOf": "46000000000",
    "requestedAssetsOf": "42000000000",
    "interestAccrued": "32000000000",
    "assetsDeposited": "82000000000",
    "assetsWithdrawn": "48000000000",
    "sharesTransitioningIn": "82000000000",
    "assetsTransitioningIn": "82000000000",
    "assetsDueForWithdraws": "16000000000",
    "accountOutstandingLoanPrincipals": "87000000000"
  }
}

Get Account CTO

get

getDailyAccountCTOFunction

Authorizations
Path parameters
vaultAddressstring · EthAddrrequired
accountAddressstring · EthAddrrequired
Query parameters
startDayStrstringrequired

The start day in format DD-MM-YYYY

Example: 21-02-2025
Pattern: ^\d{2}-\d{2}-\d{4}$
endDayStrstringrequired

The end day in format DD-MM-YYYY

Example: 21-03-2025
Pattern: ^\d{2}-\d{2}-\d{4}$
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opentradeqa.com/dailyAccounts/{vaultAddress}/{accountAddress}?startDayStr=21-02-2025&endDayStr=21-03-2025' \
  --header 'x-api-key: YOUR_API_KEY'
200
{
  "poolAddress": "text",
  "accountAddress": "text",
  "vaultAccountCTO": {
    "id": "",
    "blockNumber": 0,
    "timestamp": 0,
    "dayNumber": 0,
    "timeOfDay": 0,
    "poolType": 0,
    "poolAddr": "0xf15bb1b644f73f596b291b8f6606fb02731678d3",
    "liquidityAssetAddr": "0x7dffac9c554c5b1bc5710534c47d650c7caf2ba2",
    "accountAddr": "0x0b497a7bded9e9b30010cfd3db13058db52d2e1a",
    "tokenBalance": "6000000000",
    "interestRate": "",
    "interestInDay": "71000000000",
    "principalEarningInterest": "27000000000",
    "dailyInterestRate": "",
    "maxWithdrawRequest": "56000000000",
    "maxRedeemRequest": "77000000000",
    "requestedSharesOf": "46000000000",
    "requestedAssetsOf": "42000000000",
    "interestAccrued": "32000000000",
    "assetsDeposited": "82000000000",
    "assetsWithdrawn": "48000000000",
    "sharesTransitioningIn": "82000000000",
    "assetsTransitioningIn": "82000000000",
    "assetsDueForWithdraws": "16000000000",
    "accountOutstandingLoanPrincipals": "87000000000"
  }
}

Get Daily Account CTO

get

getDailyPoolOverviewCTOFunction

Authorizations
Path parameters
vaultAddressstring · EthAddrrequired
Query parameters
startDayStrstringrequired

The start day in format DD-MM-YYYY

Example: 21-02-2025
Pattern: ^\d{2}-\d{2}-\d{4}$
endDayStrstringrequired

The end day in format DD-MM-YYYY

Example: 21-03-2025
Pattern: ^\d{2}-\d{2}-\d{4}$
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opentradeqa.com/dailyVaults/{vaultAddress}?startDayStr=21-02-2025&endDayStr=21-03-2025' \
  --header 'x-api-key: YOUR_API_KEY'
200
{
  "vaultAddress": "text",
  "vaultOverviewCTO": {
    "businessDayRegistryAddr": "0x4e60010b795ec519ea363f60d7341bcf1918ca50",
    "closeOfDepositTime": 0,
    "closeOfWithdrawTime": 0,
    "transferInDays": 0,
    "transferOutDays": 0,
    "nonBusinessDays": "",
    "feeVaultAddr": "0xa62f022188cfb2707d44f3b25e246c318573c340",
    "withdrawControllerAddr": "0xe9ef4c2aa6078886bc125c2b37a1a0010498618e",
    "borrowerVaultAddr": "0xfbfae7d7dbfed90303273525631a55e9934a2312",
    "maxCapacity": "68000000000",
    "id": "",
    "poolType": 0,
    "poolAddr": "0x0bf8be456514bbc8b520b3b90ed7b472601daf2f",
    "liquidityAssetAddr": "0x4f211d5faf194406a0c47a01dfa9e89cb4ceb287",
    "poolControllerAddr": "0x88567a84e7d072f0f99784b9723aa51b0ea502d9",
    "name": "TokenName",
    "symbol": "OTT",
    "borrowerManagerAddr": "0xd8dabc45732065c8e49cb034fa1a325c1bd93ac0",
    "poolAdminAddr": "0x247e798d60c36bc9a9af59bb56eb5e881a0c26e8",
    "borrowerWalletAddr": "0x6dab5c9b4aaa0133988ad30d532c02d98bd55620",
    "chainConfigurationName": "",
    "creationBlock": 0,
    "blockNumber": 0,
    "timestamp": 0,
    "dayNumber": 0,
    "timeOfDay": 0,
    "chainId": "5",
    "totalOutstandingLoanPrincipal": "18000000000",
    "interestRate": "",
    "dailyInterestRate": "",
    "state": 0,
    "totalPrincipalEarningInterest": "23000000000",
    "totalInterestAccrued": "45000000000",
    "totalAssetsDeposited": "33000000000",
    "totalAssetsWithdrawn": "37000000000",
    "exchangeRate": "",
    "totalSupply": "94000000000",
    "totalRequestedShares": "29000000000",
    "totalRequestedAssets": "59000000000",
    "totalSharesTransitioningIn": "75000000000",
    "totalAssetsTransitioningIn": "59000000000",
    "totalAssetsDueForWithdraws": "98000000000",
    "lastDayAccrued": 0
  }
}

Get Daily Pool Overview

  • Return a list of vaults
  • GET/vaults
  • GET/poolEvents/{vaultAddress}
  • GET/poolEvents/{vaultAddress}/{accountAddress}
  • GET/withdrawalActivity/{vaultAddress}/{accountAddress}
  • GET/vaultsAccount/{vaultAddress}/{accountAddress}
  • GET/dailyAccounts/{vaultAddress}/{accountAddress}
  • GET/dailyVaults/{vaultAddress}