Skip to main content

Type Breakdown

The window's transactions split into each family's sub-kinds, per currency: trades by side, crypto transfers by direction, bank transfers by instrument. Draw it as a breakdown chart; filter on a slice with kind.

New in v3: v2 has no equivalent.

A workspace-scoped key gets the whole workspace's breakdown; an account-scoped key gets its own account's. There is no account_id parameter.

Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
  Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

GET

/v3/reports/type-breakdown

Query parameters​

The same as Report Summary: from and to are required, and the filters narrow the breakdown exactly as they narrow the summary.

FamilySplit byTypical kind values
tradeThe trade's side.buy, sell
cryptoThe transfer's direction.deposit, withdraw
bankThe bank instrument.ach, wire, swift, pix, …

A kind value is the one the transaction was recorded with, so its casing may vary; the kind filter matches it in any casing.

Response Sample​

GET /v3/reports/type-breakdown?from=2026-07-01T00:00:00Z&to=2026-08-01T00:00:00Z

{
  "breakdown": [
    {
      "type": "trade",
      "kinds": [
        { "kind": "buy", "currency": "EUR", "amount": "150.75", "usd_amount": "163.95", "count": 2 },
        { "kind": "sell", "currency": "USD", "amount": "200", "usd_amount": "200", "count": 1 }
      ]
    },
    {
      "type": "crypto",
      "kinds": [
        { "kind": "deposit", "currency": "BTC", "amount": "0.05", "usd_amount": "3050.25", "count": 1 },
        { "kind": "withdraw", "currency": "USDT", "amount": "500", "usd_amount": "499.6", "count": 1 }
      ]
    },
    {
      "type": "bank",
      "kinds": [
        { "kind": "cvu", "currency": "ARS", "amount": "150000", "count": 1 }
      ]
    }
  ],
  "unconverted_currencies": ["ARS"]
}

Response Schema​

FieldTypeDescription
breakdownarrayOne entry per family the filters cover (trade, crypto, bank), in that order.
breakdown[].typestringThe family.
breakdown[].kindsarrayOne row per sub-kind and currency. Empty when the family had nothing in the window.
breakdown[].kinds[].kindstringThe sub-kind (see the table above). Empty when the transaction recorded none.
breakdown[].kinds[].currencystringThe currency of amount. Empty when the transaction recorded none.
breakdown[].kinds[].amountstring (decimal)What moved, measured as in the summary.
breakdown[].kinds[].usd_amountstring (decimal)The same in USD, at the current market price. Absent when the currency has no price.
breakdown[].kinds[].countintegerHow many transactions make up amount.
unconverted_currenciesarray of stringsCurrencies with no USD price right now; their rows carry no usd_amount. Absent when every row converted.

Errors​

The same as Report Summary.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!