Get Performance History

Retrieve comprehensive performance analytics including historical account value, PnL trends, and trading volume for a subaccount over a specified period. Optimized for charting and performance analysis.

Endpoint

POST https://papi.synthetix.io/v1/trade

Request

Request Format

{
  "params": {
    "action": "getPerformanceHistory",
    "subAccountId": "1867542890123456789",
    "period": "week"
  },
  "expiresAfter": 1735689600,
  "signature": {
    "v": 28,
    "r": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "s": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
  }
}

Request Parameters

If params.period is omitted, the service returns day performance history by default.

:::info Common Parameters These are top-level request parameters. The subAccountId parameter is specified within the params object (see each endpoint's parameter table). :::

:::info SubAccountAction Endpoints Endpoints using SubAccountAction signing (getPositions, getOpenOrders, getOrdersHistory, getTrades, getFundingPayments, getSubAccount, getDelegatedSigners, getBalanceUpdates) do not require the nonce parameter. Only signature and optional expiresAfter are needed. :::

Response

Success Response

{
  "status": "ok",
  "response": {
    "subAccountId": "123456789",
    "period": "day",
    "performanceHistory": {
      "history": [
        {
          "sampledAt": 1736947200000,
          "accountValue": "10000.50",
          "pnl": "12.34"
        },
        {
          "sampledAt": 1736950800000,
          "accountValue": "10020.10",
          "pnl": "15.67"
        }
      ],
      "volume": "250000.00"
    }
  },
  "request_id": "abcd1234"
}

Response Structure

Performance History Object

The response also echoes the subAccountId and the period that was requested.

Error Response

{
  "status": "error",
  "error": {
    "message": "Failed to retrieve performance history",
    "code": "INTERNAL_ERROR"
  },
  "request_id": "5ccf215d37e3ae6d"
}

Code Examples

Get Performance History

{
  "params": {
    "action": "getPerformanceHistory",
    "subAccountId": "1867542890123456789",
    "period": "month"
  },
  "expiresAfter": 1735689600,
  "signature": {
    "v": 28,
    "r": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "s": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
  }
}

EIP-712 Signature

const domain = {
  name: "Synthetix",
  version: "1",
  chainId: 1,
  verifyingContract: "0x0000000000000000000000000000000000000000"
};
 
const types = {
  SubAccountAction: [
    { name: "subAccountId", type: "uint256" },
    { name: "action", type: "string" },
    { name: "expiresAfter", type: "uint256" }
  ]
};
 
const message = {
  subAccountId: "1867542890123456789",
  action: "getPerformanceHistory",
  expiresAfter: 0
};
 
const signature = await signer._signTypedData(domain, types, message);

Performance Information

• Historical Analytics: Account value and PnL tracking for a selected timeframe (day, week, month, threeMonth, YTD, all-time)
• Volume Tracking: Trading activity metrics for performance analysis over the requested period
• Time Series Data: Ideal for charting and portfolio performance visualization
• Performance Focus: Dedicated to performance analytics, separate from account balances and margin data
• USDT Denomination: All monetary values are denominated in USDT for consistency
• Optimized for Analytics: Structured for performance dashboards and reporting tools

Use Cases

• Performance Dashboards: Build comprehensive performance tracking interfaces
• PnL Analysis: Track profit and loss trends over different time periods
• Trading Analytics: Analyze trading volume and activity patterns
• Portfolio Reporting: Generate performance reports for users
• Charting Applications: Power performance charts and visualizations
• Trend Analysis: Identify performance patterns and trading behavior

Validation Rules

• expiresAfter is optional; if provided, request must be used before this timestamp
• Must be signed by account owner or authorized delegate
• Subaccount ID must be valid and accessible

EIP-712 Domain Separator

All signature-based authentication uses the following domain separator:

{
  "name": "Synthetix",
  "version": "1",
  "chainId": 1,
  "verifyingContract": "0x0000000000000000000000000000000000000000"
}

Signing

All trading methods are signed using EIP-712. Each successful trading request will contain:

• A piece of structured data that includes the sender address
• A signature of the hash of that structured data, signed by the sender

For detailed information on EIP-712 signing, see EIP-712 Signing.

Nonce Management

The nonce system prevents replay attacks and ensures order uniqueness:

• Use current timestamp in milliseconds as nonce
• Each nonce must be greater than the previous one
• Recommended: Use Date.now() or equivalent
• If nonce conflicts occur, increment by 1 and retry

:::note SubAccountAction Exception SubAccountAction endpoints (getPositions, getOpenOrders, getOrdersHistory, getTrades, getFundingPayments, getSubAccount, getDelegatedSigners, getBalanceUpdates) do not require a nonce. Only the signature and optional expiresAfter parameters are needed. :::

Error Handling

Common error scenarios:

Related Endpoints

• Get Subaccount - Account information and balances
• Get Positions - Current position details
• Get Orders - Trading history
• Get Trades - Trade execution details

Data Format Notes

• Timestamps: Unix timestamp in milliseconds
• Time Series: Array of objects with sampledAt, accountValue, and pnl, ordered chronologically
• Numeric Precision: All numeric values returned as strings to preserve precision
• Volume (volume): Represents total volume traded during the requested time period