Performance

GET /portfolio/{fin}/performance

Performance

This endpoint returns performance data.

Path parameters

  • fin string Required

    The Finplex Identity Number of the user

Query parameters

  • fromDate string(date-time) Required
  • toDate string(date-time) Required
  • valCurrency 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.

  • filterCurrency string | null

    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.

  • fen string | null
  • fan string | null

Responses

  • 200

    Ok

    Hide response attributes Show response attributes array[object]
    • fan string | null
    • fen string Required
    • performance array[object] Required
      Hide performance attributes Show performance attributes array[object]
      • holdingId string Required
      • totalAccruedInterestValue number(double) Required
      • totalClosingValue number(double) Required
      • totalContributedValue number(double) Required
      • totalDividendValue number(double) Required
      • totalFinancingFeeValue number(double) Required
      • totalFxGainLossValue number(double) Required
      • totalIncomeValue number(double) Required
      • totalInterestValue number(double) Required
      • totalNetTradingValue number(double) Required
      • totalOpeningValue number(double) Required
      • totalOtherValue number(double) Required
      • totalRealisedValue number(double) Required
      • totalReturnValue number(double) Required
      • totalUnrealisedValue number(double) Required
      • totalWithdrawnValue number(double) Required
    • summary object Required
      Hide summary attributes Show summary attributes object
      • closingDate string(date) Required
      • openingDate string(date) Required
      • totalAccruedInterestValue number(double) Required
      • totalAnnualisedPerformanceValue number(double) Required
      • totalAnnualisedTwrPerformanceValue number(double) Required
      • totalClosingValue number(double) Required
      • totalContributedValue number(double) Required
      • totalDividendValue number(double) Required
      • totalFinancingFeeValue number(double) Required
      • totalFxGainLossValue number(double) Required
      • totalIncomeTakenDirectlyValue number(double) Required
      • totalInterestValue number(double) Required
      • totalNetCapitalFlowsValue number(double) Required
      • totalOpeningValue number(double) Required
      • totalRealisedValue number(double) Required
      • totalReturnValue number(double) Required
      • totalUnrealisedValue number(double) Required
      • totalWithdrawnValue number(double) Required
GET /portfolio/{fin}/performance 
curl \
 -X GET http://api.example.com/portfolio/{fin}/performance?fromDate=2023-05-04T09%3A42%3A00%2B00%3A00&toDate=2023-05-04T09%3A42%3A00%2B00%3A00&valCurrency=ARS
Response examples (200) 
[
  {
    "fan": "string",
    "fen": "string",
    "performance": [
      {
        "holdingId": "string",
        "totalAccruedInterestValue": 42.0,
        "totalClosingValue": 42.0,
        "totalContributedValue": 42.0,
        "totalDividendValue": 42.0,
        "totalFinancingFeeValue": 42.0,
        "totalFxGainLossValue": 42.0,
        "totalIncomeValue": 42.0,
        "totalInterestValue": 42.0,
        "totalNetTradingValue": 42.0,
        "totalOpeningValue": 42.0,
        "totalOtherValue": 42.0,
        "totalRealisedValue": 42.0,
        "totalReturnValue": 42.0,
        "totalUnrealisedValue": 42.0,
        "totalWithdrawnValue": 42.0
      }
    ],
    "summary": {
      "closingDate": "2023-05-04",
      "openingDate": "2023-05-04",
      "totalAccruedInterestValue": 42.0,
      "totalAnnualisedPerformanceValue": 42.0,
      "totalAnnualisedTwrPerformanceValue": 42.0,
      "totalClosingValue": 42.0,
      "totalContributedValue": 42.0,
      "totalDividendValue": 42.0,
      "totalFinancingFeeValue": 42.0,
      "totalFxGainLossValue": 42.0,
      "totalIncomeTakenDirectlyValue": 42.0,
      "totalInterestValue": 42.0,
      "totalNetCapitalFlowsValue": 42.0,
      "totalOpeningValue": 42.0,
      "totalRealisedValue": 42.0,
      "totalReturnValue": 42.0,
      "totalUnrealisedValue": 42.0,
      "totalWithdrawnValue": 42.0
    }
  }
]
Response examples (200) 
[
  {
    "fan": "string",
    "fen": "string",
    "performance": [
      {
        "holdingId": "string",
        "totalAccruedInterestValue": 42.0,
        "totalClosingValue": 42.0,
        "totalContributedValue": 42.0,
        "totalDividendValue": 42.0,
        "totalFinancingFeeValue": 42.0,
        "totalFxGainLossValue": 42.0,
        "totalIncomeValue": 42.0,
        "totalInterestValue": 42.0,
        "totalNetTradingValue": 42.0,
        "totalOpeningValue": 42.0,
        "totalOtherValue": 42.0,
        "totalRealisedValue": 42.0,
        "totalReturnValue": 42.0,
        "totalUnrealisedValue": 42.0,
        "totalWithdrawnValue": 42.0
      }
    ],
    "summary": {
      "closingDate": "2025-05-04",
      "openingDate": "2025-05-04",
      "totalAccruedInterestValue": 42.0,
      "totalAnnualisedPerformanceValue": 42.0,
      "totalAnnualisedTwrPerformanceValue": 42.0,
      "totalClosingValue": 42.0,
      "totalContributedValue": 42.0,
      "totalDividendValue": 42.0,
      "totalFinancingFeeValue": 42.0,
      "totalFxGainLossValue": 42.0,
      "totalIncomeTakenDirectlyValue": 42.0,
      "totalInterestValue": 42.0,
      "totalNetCapitalFlowsValue": 42.0,
      "totalOpeningValue": 42.0,
      "totalRealisedValue": 42.0,
      "totalReturnValue": 42.0,
      "totalUnrealisedValue": 42.0,
      "totalWithdrawnValue": 42.0
    }
  }
]