Transactions

GET /portfolio/{fin}/transactions

Transactions

This endpoint returns a list of transactions.

Path parameters

  • fin string Required

    The Finplex Identity Number of the user

Query parameters

  • fen string | null
  • fan string | null
  • filterCurrency string | null

    Only return transaction for this currency.

    Values are ARS, AUD, BWP, BRL, CAD, CNH, CNY, COP, CZK, DKK, DOP, EGP, EUR, GBP, HKD, HUF, IDR, INR, ISK, JPY, KZT, LTL, LUF, MXN, MYR, TWD, NZD, NOK, PEN, PLN, KRW, RON, RUB, SGD, SKK, SIT, ZAR, SEK, CHF, THB, TRY, USD, UYU, or VND.

  • fromDate string(date-time) | null

    Filter statements only after this date.

  • toDate string(date-time) | null

    Filter statements only before this date.

Responses

  • 200

    Ok

    Hide response attributes Show response attributes array[object]
    • assetName string Required
    • assetPurchasePrice number(double) | null
    • assetSymbol string Required
    • currency string Required

      Values are ARS, AUD, BWP, BRL, CAD, CNH, CNY, COP, CZK, DKK, DOP, EGP, EUR, GBP, HKD, HUF, IDR, INR, ISK, JPY, KZT, LTL, LUF, MXN, MYR, TWD, NZD, NOK, PEN, PLN, KRW, RON, RUB, SGD, SKK, SIT, ZAR, SEK, CHF, THB, TRY, USD, UYU, or VND.

    • effectiveDate string Required
    • exchangeCode string | null
    • fan string Required
    • fen string Required
    • movementId string Required
    • narrative string Required
    • quantity number(double) | null
    • totalGrossCashChange number(double) Required
    • totalNetAssetPurchasePrice number(double) | null
    • totalNetCashChange number(double) Required
    • transactionType string Required

      Values are Buy, Sell, Deposit, Withdrawal, Transaction In, Transaction Out, Cash Transfer, Dividend, Open Investment, or FX Transfer.

GET /portfolio/{fin}/transactions
curl \
 -X GET http://api.example.com/portfolio/{fin}/transactions
Response examples (200)
[
  {
    "assetName": "string",
    "assetPurchasePrice": 42.0,
    "assetSymbol": "string",
    "currency": "ARS",
    "effectiveDate": "string",
    "exchangeCode": "string",
    "fan": "string",
    "fen": "string",
    "movementId": "string",
    "narrative": "string",
    "quantity": 42.0,
    "totalGrossCashChange": 42.0,
    "totalNetAssetPurchasePrice": 42.0,
    "totalNetCashChange": 42.0,
    "transactionType": "Buy"
  }
]
Response examples (200)
[
  {
    "assetName": "string",
    "assetPurchasePrice": 42.0,
    "assetSymbol": "string",
    "currency": "ARS",
    "effectiveDate": "string",
    "exchangeCode": "string",
    "fan": "string",
    "fen": "string",
    "movementId": "string",
    "narrative": "string",
    "quantity": 42.0,
    "totalGrossCashChange": 42.0,
    "totalNetAssetPurchasePrice": 42.0,
    "totalNetCashChange": 42.0,
    "transactionType": "Buy"
  }
]