Portfolios

get/v1/portfolios/{portfolioSlug}/defi-positions/{positionRef}

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}/defi-positions/{positionRef}
  • Auth: API key in header x-api-key

Path parameters

positionRefstring required

Public DeFi position reference, as returned by the list route. An opaque base64url token, for example WyJldGgtbWFpbm5ldCIsIjB4d2FsbGV0IiwicG9vbDoxIl0

portfolioSlugstring required

Workspace-scoped portfolio slug

Response

positionRefstring required

Stable public DeFi position reference

positionKeystring required

Protocol-defined stable logical position key

positionType'LP' | 'STAKE' | 'LEND' | 'BORROW' | 'NATIVE_STAKE' | 'PROTOCOL' | 'VAULT' required

DeFi position type

status'ACTIVE' | 'CLOSED' | 'PARTIAL' required

DeFi position status

openedAtstring date-time required

Position opened timestamp

closedAtstring date-time nullable required

Position closed timestamp, if closed

tokenAddressesstring[] required

Token addresses involved in the position

custodyAddressesstring[] required

Custody addresses involved in the position

Changes

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