Trigger an Inventory Summary Report

Triggers an asynchronous inventory summary report containing per-account asset details such as quantities, cost basis, and average unit cost. Use the GET /reports/inventory-summary/{reportId} endpoint to poll for status and download the report once complete.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Report Fields

The downloaded report is a CSV file with one row per account-asset combination. Each row contains the following fields:

FieldDescription
account_idExternal account ID from your system (Taxbit account_external_id).
asset_codeCode/symbol of the asset from Taxbit's asset registry (e.g. BTC).
fiat_asset_codeCode of the fiat asset used for cost values (e.g. USD).
as_of_timestampSnapshot timestamp for which the inventory summary was computed (ISO-8601, UTC).
went_negativeWhether this asset's inventory for the account ever went negative at or before the snapshot time.
client_modified_by_transaction_idExternal transaction ID (from your system) of the latest transaction that modified this asset's inventory summary.
latest_transaction_datetimeDatetime of the most recent transaction that affected this asset's inventory summary (ISO-8601, UTC).
locked_quantitiesJSON object of quantities currently locked by lock type (e.g. {"stake":"0.5"}), representing portions that are staked, loaned, etc.
total_quantityTotal ending quantity of the asset held in the account as of the snapshot (including amounts with and without cost basis).
total_quantity_with_cost_basisPortion of the total quantity that has known cost basis.
total_quantity_missing_cost_basisPortion of the quantity whose cost basis is missing (e.g. due to transfers without acquisition history). May be null when zero.
total_costTotal cost basis (in fiat_asset_code) for the quantity with cost basis, as of the snapshot.
average_unit_costAverage cost per unit of the asset (total_cost ÷ total_quantity). Units without cost basis effectively contribute zero cost.
Body Params
date-time
required

The point-in-time for which to generate the inventory summary.

account_ids
array of strings
length ≤ 10000

Optional list of your system's unique identifiers for the accounts to include in the report. If omitted, all accounts in the organization are included.

account_ids
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json