Skip to main content
GET
Get realized gains & losses

Authorizations

X-API-Key
string
header
required

Your organization API key. See Authentication.

Query Parameters

accounting_period_ids
string[]

Any of these accounting period IDs. Omit to include all periods within the other filters.

accounting_period_start_date_utcs
string<date-time>[]

Accounting-period start dates (ISO 8601, UTC), for a caller that holds the dates and not the period IDs. A date with no stored period is valid. Cannot be combined with period IDs (400).

asset_types
string[]

Asset type filters (such as ETH, USDC). Omit to include every asset type.

summary
boolean

Include totals across all matching pages, grouped by currency. If totals cannot be calculated, the request fails.

sort_by
enum<string>
default:date_received

Sort field. Default date_received. sold_cost_basis (cost_basis × quantity_sold), proceeds and realized_gain (proceeds − sold_cost_basis) are calculated over the listed disposals. Rows with the same value are ordered by lot ID.

Available options:
date_received,
asset_record,
quantity,
remaining_quantity,
id,
sold_cost_basis,
proceeds,
realized_gain
sort_direction
enum<string>
default:desc

Sort direction. Default desc.

Available options:
asc,
desc
expand
string

Comma-separated related objects to add to each row: acquisition_transaction, disposal_transactions. An unknown value is rejected with 400.

limit
integer
default:50

Maximum number of records to return.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page. Keep the other filters unchanged.

Filter by one or more legal entity IDs. Omit to include all authorized entities. An empty list is invalid.

Legal entity ID (le_…).

Response

The request succeeded.

data
object[]
required

The records.

has_more
boolean
required

Whether another page is available.

next_cursor
string | null
required

Cursor for the next page, or null on the last page.

summary
object

Present when summary=true. Totals cover all pages. Flat totals appear only for a single currency.