API product catalogSub-Accounts & White-Label Retail KYC

List sub-account watchlist

Sub-Accounts & White-Label Retail KYC

GET

/users/{userId}/watchlist

Sandbox availablelistWatchlist

Returns the watchlist for a sub-account, including delayed price and day-change for each stock where available.

Parameters

userIdstringpathRequired

Example: usr_abc123

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

dataobject[]

data[].assetIdstring

data[].symbolstring

data[].namestring

data[].exchangestring

data[].sourceTypestring

Example: "LISTED_STOCK"

data[].addedAtstring

data[].pricenumber

Live local-currency price (omitted if unavailable).

data[].usdPricenumber

data[].changenumber

Day change percent.

data[].currencystring

countinteger

metaobject

Standard response metadata included on every market-data envelope.

meta.request_idstring

Unique identifier for this request. Include in support tickets for tracing.

Example: "4f6e1a2b-3c4d-5e6f-7a8b-9c0d1e2f3a4b"

meta.timestampstring

ISO 8601 UTC timestamp of when the response was generated.

Example: "2026-06-04T10:23:45.123Z"

meta.exchangestring | null

Exchange code the request was scoped to, when applicable.

Example: "NSE"

meta.symbolstring | null

Ticker symbol the request was scoped to, when applicable.

Example: "SCOM.KE"

Response codes

200Watchlist items with delayed prices and freshness metadata.

Sandbox playground

Read-only sandbox request

userId Required · pathSandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "assetId": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "exchange": {
            "type": "string"
          },
          "sourceType": {
            "type": "string",
            "example": "LISTED_STOCK"
          },
          "addedAt": {
            "type": "string",
            "format": "date-time"
          },
          "price": {
            "type": "number",
            "description": "Live local-currency price (omitted if unavailable)."
          },
          "usdPrice": {
            "type": "number"
          },
          "change": {
            "type": "number",
            "description": "Day change percent."
          },
          "currency": {
            "type": "string"
          }
        }
      }
    },
    "count": {
      "type": "integer"
    },
    "meta": {
      "type": "object",
      "description": "Standard response metadata included on every market-data envelope.",
      "properties": {
        "request_id": {
          "type": "string",
          "format": "uuid",
          "description": "Unique identifier for this request. Include in support tickets for tracing.",
          "example": "4f6e1a2b-3c4d-5e6f-7a8b-9c0d1e2f3a4b"
        },
        "timestamp": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 UTC timestamp of when the response was generated.",
          "example": "2026-06-04T10:23:45.123Z"
        },
        "exchange": {
          "type": [
            "string",
            "null"
          ],
          "description": "Exchange code the request was scoped to, when applicable.",
          "example": "NSE"
        },
        "symbol": {
          "type": [
            "string",
            "null"
          ],
          "description": "Ticker symbol the request was scoped to, when applicable.",
          "example": "SCOM.KE"
        }
      }
    }
  }
}

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

GET /users/{userId}/wallet

POST /users/{userId}/watchlist