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. Additional Informations

Data freshness

All addresses data we provided are synced on demand. It means that the first time you will load an address, if we dont have any data for this address we'll sync it.

Portfolio data

The portfolio is updated on demand and the cache time is 1 min. If you call the portfolio endpoint and the data is fresh (last sync <1 min) we'll return you the cached data. If the portfolio is stale (last time > 1 min) we'll return you the cached data and sync the portfolio in the background. Next time you will call the portfolio we'll return you the fresh data (if the sync is over). If you prefer to wait for the sync and always get the fresh data, you can set the waitForSync param to true on the request. Calls on the portfolio endpoint only trigger the portoflio sync (not the transactions).

Transactions data

The transactions data are updated on demand and the cache time is 10 min. If you call the transactions endpoint and the data is fresh (last sync <10 min) we'll return you the cached data.

If the data are stale (last sync > 10 min), a call on the transactions endpoint will trigger the transactions sync and the cached data will be returned until the synchronization is done.

As we sync addresses on demand, the first time you call the transactions endpoint, it's possible that we return you an empty array (we're syncing). You can check the sync status with the Statusendpoint.

Status

You can check the sync status of an address by calling the Status endpoint.

Sync

At any moment, you can call the /sync-transactions endpoint to trigger the synchronization of the transactions.

PreviousTransaction typeNextChangelog

Last updated 9 hours ago