REST API›Trade›Margin

GET

Get positions activity

Returns unsettled fill legs and position transfers that make up the unsettled position as of a specified historical time range.

Path Params

  • accountId string required
    The ID of the account

Query Params

  • transactionDateGte string date-time
    Return activity with transactionDate greater than or equal to this timestamp.
  • transactionDateLt string date-time
    Return activity with transactionDate less than this timestamp.
  • currency array of strings
    Filter by currencies. If omitted, returns activity for all currencies.
  • type array of string enums
    Filter by activity type.
    fill-base-legfill-quote-legposition-transfer
  • offset integer
    Pagination offset.

    Defaults to 0

  • limit integer
    Number of items per page.

    <= 500

    Defaults to 500

Responses

200
Positions activity

Response Body

object

  • positionsActivity array of objects required
    positionsActivity object
    • type string enum required
      The type of activity
      fill-base-legfill-quote-legposition-transfer
    • id string required
      The unique identifier of the fill or position transfer
    • currency string required
      The currency symbol for this activity
    • quantity string required
      The quantity contribution to the open position. Negative values indicate short positions, positive values indicate long positions.

      matches ^-?[0-9]+(\.[0-9]+)?$

    • enterpriseId string required
      The enterprise ID for the activity
    • accountId string required
      The trading account ID for the activity
    • transactionDate string date-time required
      The date and time when the activity occurred
400
Bad request - Invalid query parameters

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.
401
Unauthorized - Invalid or missing authentication

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.
403
Forbidden - Insufficient permissions

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.
500
Internal Server Error

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.