Sync

post/v1/portfolios/{portfolioSlug}/sync

Request

  • Base URL: https://api.tokenbooks.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.tokenbooks.io/v1/portfolios/{portfolioSlug}/sync
  • Auth: API key in header x-api-key

Path parameters

portfolioSlugstring required

Workspace-scoped portfolio slug

Request body

fullboolean

Full resync if true, incremental if false

toBlockinteger

Stop at a specific block. This is allowed only for test API keys.

ignoreBalanceCheckboolean

Bypass the wallet balance gate. This is allowed only for test API keys.

amountOfIgnoredLatestTxnsinteger

Omit the newest N transactions. This is allowed only for test API keys and requires full=true.

Response

jobIdstring required

Job ID for tracking progress

portfolioSlugstring required

Portfolio slug being synced

Changes

No recorded changes to this operation across all 1 revision of this API.