API product catalogSub-Accounts & White-Label Retail KYC

Open tax lots (sub-account)

Sub-Accounts & White-Label Retail KYC

GET

/users/{userId}/tax-lots

Sandbox availablegetSubAccountTaxLots

Open tax lots for a sub-account — each remaining acquired quantity with per-unit cost basis and acquisition date, derived FIFO from settled orders. Pair with /gains for realized disposals.

Parameters

userIdstringpathRequired

Example: usr_abc123

symbolstringquery

Filter to one symbol.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

subAccountIdstring | null

accountTypestring

currencystring

Example: "USD"

countinteger

totalCostUsdnumber

lotsobject[]

lots[].lotIdstring

The acquiring order id.

lots[].symbolstring

lots[].exchangestring | null

lots[].quantitynumber

Remaining open quantity.

lots[].originalQuantitynumber

lots[].costBasisPerUnitUsdnumber

lots[].remainingCostUsdnumber

lots[].acquiredAtstring | null

lots[].acquisitionFeeUsdnumber

Response codes

200Open lots.

404Sub-account not found.

Sandbox playground

Read-only sandbox request

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

https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/tax-lots

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "description": "Open tax lots (remaining acquired quantity, cost basis, acquisition date).",
  "properties": {
    "subAccountId": {
      "type": [
        "string",
        "null"
      ]
    },
    "accountType": {
      "type": "string"
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "count": {
      "type": "integer"
    },
    "totalCostUsd": {
      "type": "number"
    },
    "lots": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "lotId": {
            "type": "string",
            "description": "The acquiring order id."
          },
          "symbol": {
            "type": "string"
          },
          "exchange": {
            "type": [
              "string",
              "null"
            ]
          },
          "quantity": {
            "type": "number",
            "description": "Remaining open quantity."
          },
          "originalQuantity": {
            "type": "number"
          },
          "costBasisPerUnitUsd": {
            "type": "number"
          },
          "remainingCostUsd": {
            "type": "number"
          },
          "acquiredAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "acquisitionFeeUsd": {
            "type": "number"
          }
        }
      }
    }
  }
}

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

POST /users/{userId}/subscribe

POST /users/{userId}/trade