# GetSimResults

Return free SIM subscription results, measured since each SIM started, not over a fixed 90-day window. Use IsResultReady before displaying performance; unavailable values are null or omitted. This is not an eligibility check or a daily-history endpoint. Non-Paginated endpoint.

Endpoint: GET /Autotrade/GetSimResults
Version: v4
Security: 

## Query parameters:

  - `PersonId` (integer,null)
    PersonId (optional)

  - `WhiteLabelSiteId` (integer,null)
    The WhiteLabel SiteId (optional)

  - `ActiveOnly` (boolean)
    Set to FALSE to get the full history of all Simulation results (optional). Default is TRUE

  - `MaxAccountDays` (integer,null)
    The maximum account number of days to include (optional). Maximum default value is 365 days

  - `MinLoginDays` (integer,null)
    The minimum number of days since the user logged in (optional)

## Response 200 fields (application/json):

  - `Results` (array,null)
    Result array

  - `Results.PersonId` (integer)
    The C2 PersonId

  - `Results.FirstName` (string,null)
    The person's first name

  - `Results.LastName` (string,null)
    The person's last name

  - `Results.Email` (string,null)
    The person's email

  - `Results.Account` (string,null)
    The SIM Account

  - `Results.StrategyId` (integer)
    StrategyId

  - `Results.StrategyName` (string,null)
    The Strategy Name

  - `Results.StartDate` (string)
    UTC Date when the person started SIM for the Strategy

  - `Results.EndDate` (string,null)
    UTC Date when the person stopped SIM for the Strategy

  - `Results.StartEquity` (number,null)
    Unscaled strategy model equity, net of trading commissions, at the SIM starting snapshot. Null or omitted until initialized. This is not the customer's $500,000 SIM account balance.

  - `Results.EndEquity` (integer,null)
    Unscaled strategy model equity, net of trading commissions. Latest stored valuation for an active SIM; ending snapshot for a stopped SIM. Null or omitted while unavailable.

  - `Results.TotalReturn` (number,null)
    Since-start scaled change divided by unscaled StartEquity, expressed as a decimal ratio (0.05 means 5%). Not a fixed 90-day return. Null or omitted when unavailable or StartEquity is not positive. Do not add returns across strategies.

  - `Results.TotalDelta` (number,null)
    Whole-dollar change from the SIM starting snapshot through the latest valuation or ending snapshot, multiplied by ScalingFactor. Net of trading commissions; excludes subscription and AutoTrade fees. Null or omitted when unavailable.

  - `Results.ScalingFactor` (number,null)
    Allocation multiplier: 1 means 1x, 2 means 2x, and 0.1 means one tenth. Not a percentage. Null or omitted if unavailable.

  - `Results.SubscriptionId` (integer)
    Stable identifier of this simulation subscription. Restarting creates a different subscription; retain this ID when storing history.

  - `Results.IsResultReady` (boolean,null)
    True when both equity snapshots and a valid scaling factor are available. When false, performance is unavailable and TotalDelta/TotalReturn are null or omitted. A SIM stopped before initialization can remain unavailable.

  - `ResponseStatus` (object)

  - `ResponseStatus.ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `ResponseStatus.Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `ResponseStatus.Errors` (array,null)

  - `ResponseStatus.Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `ResponseStatus.Errors.FieldName` (string,null)
    The affected parameter.

  - `ResponseStatus.Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 400 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 401 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 403 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 404 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 406 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 409 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 429 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 500 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 503 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.


## Response 304 fields