API product catalogSub-Accounts & White-Label Retail KYC

Realized capital gains (sub-account)

Sub-Accounts & White-Label Retail KYC

GET

/users/{userId}/gains

Sandbox availablegetSubAccountGains

Realized gains/losses for a sub-account — each disposal FIFO-matched to its acquiring lot, with acquisition + disposal dates, cost basis, proceeds, holding period, and gain. Feed a capital-gains tax statement.

Parameters

userIdstringpathRequired

Example: usr_abc123

symbolstringquery

fromstringquery

tostringquery

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

subAccountIdstring | null

accountTypestring

currencystring

Example: "USD"

methodFIFO

countinteger

totalProceedsUsdnumber

totalCostUsdnumber

realizedGainUsdnumber

periodobject

period.fromstring | null

period.tostring | null

disposalsobject[]

disposals[].symbolstring

disposals[].exchangestring | null

disposals[].quantitynumber

disposals[].acquiredAtstring | null

disposals[].disposedAtstring | null

disposals[].holdingPeriodDaysinteger | null

disposals[].costBasisUsdnumber

disposals[].proceedsUsdnumber

disposals[].gainUsdnumber

disposals[].methodFIFO

disposals[].buyOrderIdstring

disposals[].sellOrderIdstring

Response codes

200Realized disposals.

404Sub-account not found.

Sandbox playground

Read-only sandbox request

userId Required · pathsymbol Optional · queryfrom Optional · queryto Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/gains

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "description": "Realized capital gains/losses, each disposal FIFO-matched to its lot.",
  "properties": {
    "subAccountId": {
      "type": [
        "string",
        "null"
      ]
    },
    "accountType": {
      "type": "string"
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "method": {
      "type": "string",
      "enum": [
        "FIFO"
      ]
    },
    "count": {
      "type": "integer"
    },
    "totalProceedsUsd": {
      "type": "number"
    },
    "totalCostUsd": {
      "type": "number"
    },
    "realizedGainUsd": {
      "type": "number"
    },
    "period": {
      "type": "object",
      "properties": {
        "from": {
          "type": [
            "string",
            "null"
          ]
        },
        "to": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "disposals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "symbol": {
            "type": "string"
          },
          "exchange": {
            "type": [
              "string",
              "null"
            ]
          },
          "quantity": {
            "type": "number"
          },
          "acquiredAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "disposedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "holdingPeriodDays": {
            "type": [
              "integer",
              "null"
            ]
          },
          "costBasisUsd": {
            "type": "number"
          },
          "proceedsUsd": {
            "type": "number"
          },
          "gainUsd": {
            "type": "number"
          },
          "method": {
            "type": "string",
            "enum": [
              "FIFO"
            ]
          },
          "buyOrderId": {
            "type": "string"
          },
          "sellOrderId": {
            "type": "string"
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/gains' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

POST /users/{userId}/fx/quote

POST /users/{userId}/kyc