Skip to main content
GET
Get accounting yield period summary

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

walletId
string<uuid>

Wallet ID for a wallet-scoped report. Provide exactly one of walletId or scope=organization.

scope
enum<string>

Use organization for an organization-wide report. Provide exactly one of walletId or scope=organization.

Available options:
organization
start
string<date-time>
required

Inclusive ISO-8601 UTC period start.

end
string<date-time>
required

Exclusive ISO-8601 UTC period end.

costBasisMethod
enum<string>
default:fifo

Cost basis method used for realized performance calculations.

Available options:
fifo,
average_cost

Response

Yield period summary

periodStart
string<date-time>
periodEnd
string<date-time>
scope
enum<string>
Available options:
wallet,
all
portfolioWalletId
string<uuid> | null
costBasisMethod
enum<string>
Available options:
fifo,
average_cost
status
enum<string>
Available options:
exact,
incomplete
reason
string | null
summary
object
yieldSources
object[]