Choose your API

Partner Capability Index

MyStocks Partner API

Find the production endpoint, webhook, sandbox scenario, and integration guidance for common partner workflows.

Integration guides Get a sandbox key

Explore endpoints

11 of 11

GET

/assets

Unified asset catalog

Full endpoint documentation

Sandbox availablelistAssets

Returns stocks, ETFs, bonds, and funds in one normalized catalog. Instruments that exist but cannot currently be transacted remain discoverable with tradable: false, a status, and capability flags. Unknown exchange order constraints are returned as null rather than inferred.

Parameters

assetClassSTOCK | ETF | BOND | FUNDquery

exchangestringquery

statusstringquery

tradablebooleanquery

searchstringquery

limitintegerquery

Example: 100

cursorstringquery

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

dataobject[]Required

data[].assetIdstringRequired

Example: "stock:SCOM.KE"

data[].sourceIdstringRequired

data[].symbolstring | null

data[].namestring | null

data[].assetClassSTOCK | ETF | BOND | FUNDRequired

data[].exchangestring | null

data[].exchangeMicstring | null

data[].currencystringRequired

data[].statusstringRequired

data[].statusReasonstring | null

data[].tradablebooleanRequired

data[].fractionablebooleanRequired

data[].shortablebooleanRequired

data[].marginablebooleanRequired

data[].minOrderSizenumber | null

data[].lotSizenumber | null

data[].tickSizenumber | null

data[].settlementCyclestring | null

data[].capabilitiesobjectRequired

data[].fractionalEligibilityobjectRequired

data[].orderRulesobjectRequired

data[].settlementunion

countintegerRequired

hasMorebooleanRequired

nextCursorstring | null

Response codes

200Normalized asset page.

Sandbox playground

Read-only sandbox request

assetClass Optional · queryexchange Optional · querystatus Optional · querytradable Optional · querysearch Optional · querylimit Optional · querycursor Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/assets

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "data",
    "count",
    "hasMore"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "assetId",
          "sourceId",
          "assetClass",
          "currency",
          "status",
          "tradable",
          "fractionable",
          "shortable",
          "marginable",
          "capabilities",
          "fractionalEligibility",
          "orderRules"
        ],
        "properties": {
          "assetId": {
            "type": "string",
            "example": "stock:SCOM.KE"
          },
          "sourceId": {
            "type": "string"
          },
          "symbol": {
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "type": [
              "string",
              "null"
            ]
          },
          "assetClass": {
            "type": "string",
            "enum": [
              "STOCK",
              "ETF",
              "BOND",
              "FUND"
            ]
          },
          "exchange": {
            "type": [
              "string",
              "null"
            ]
          },
          "exchangeMic": {
            "type": [
              "string",
              "null"
            ]
          },
          "currency": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "statusReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "tradable": {
            "type": "boolean"
          },
          "fractionable": {
            "type": "boolean"
          },
          "shortable": {
            "type": "boolean",
            "const": false
          },
          "marginable": {
            "type": "boolean",
            "const": false
          },
          "minOrderSize": {
            "type": [
              "number",
              "null"
            ]
          },
          "lotSize": {
            "type": [
              "number",
              "null"
            ]
          },
          "tickSize": {
            "type": [
              "number",
              "null"
            ]
          },
          "settlementCycle": {
            "type": [
              "string",
              "null"
            ]
          },
          "capabilities": {
            "type": "object",
            "required": [
              "buy",
              "sell",
              "subscribe",
              "redeem",
              "fractional",
              "short",
              "margin"
            ],
            "properties": {
              "buy": {
                "type": "boolean"
              },
              "sell": {
                "type": "boolean"
              },
              "subscribe": {
                "type": "boolean"
              },
              "redeem": {
                "type": "boolean"
              },
              "fractional": {
                "type": "boolean"
              },
              "short": {
                "type": "boolean"
              },
              "margin": {
                "type": "boolean"
              }
            }
          },
          "fractionalEligibility": {
            "type": "object",
            "required": [
              "fractional",
              "minOrderSize",
              "quantityIncrement",
              "quantityPrecision",
              "supportedSizingModes"
            ],
            "properties": {
              "fractional": {
                "type": "boolean",
                "description": "Whether the instrument supports fractional units."
              },
              "minOrderSize": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Minimum quantity or subscription amount configured for this instrument."
              },
              "quantityIncrement": {
                "type": "number",
                "exclusiveMinimum": 0,
                "description": "Smallest accepted quantity step."
              },
              "quantityPrecision": {
                "type": "integer",
                "minimum": 0,
                "maximum": 6,
                "description": "Maximum decimal places implied by quantityIncrement."
              },
              "supportedSizingModes": {
                "type": "array",
                "minItems": 1,
                "uniqueItems": true,
                "items": {
                  "type": "string",
                  "enum": [
                    "QUANTITY",
                    "CASH_VALUE"
                  ]
                }
              }
            }
          },
          "orderRules": {
            "type": "object",
            "properties": {
              "minQuantity": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "minNotional": {
                "oneOf": [
                  {
                    "type": "object",
                    "required": [
                      "amount",
                      "currency"
                    ],
                    "properties": {
                      "amount": {
                        "type": "number"
                      },
                      "currency": {
                        "type": "string"
                      }
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "quantityIncrement": {
                "type": "number"
              },
              "quantityPrecision": {
                "type": "integer",
                "minimum": 0,
                "maximum": 6
              },
              "lotSize": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "tickSize": {
                "type": [
                  "number",
                  "null"
                ]
              }
            }
          },
          "settlement": {
            "oneOf": [
              {
                "type": "object",
                "required": [
                  "cycle",
                  "cycleDays"
                ],
                "properties": {
                  "cycle": {
                    "type": "string"
                  },
                  "cycleDays": {
                    "type": "integer"
                  }
                }
              },
              {
                "type": "null"
              }
            ]
          }
        }
      }
    },
    "count": {
      "type": "integer"
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/assets' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

Use this index when you know the workflow you need and want the authoritative contract immediately. All endpoint paths are relative to /api/v1/partner in production and /api/sandbox/v1/partner in sandbox.

Capability	Production contract	Test and implementation guidance
Batch portfolio quotes	`GET /market/quotes?symbols=SCOM.KE,MTN.ZA` — up to 50 symbols	Quotes and freshness
Tradeable price quote	`GET /quote/{symbol}` — single-use, 60-second TTL	Quote refresh pattern
Replace a resting order	`PATCH /orders/{orderId}` or `PATCH /users/{userId}/orders/{orderId}`	Advanced order types
Market open/closed state	`GET /market/status`	Market state
Holidays and closures	`GET /market/holidays`	Market calendar
KYC status changes	`kyc.updated` webhook; inspect `kycStatus`	KYC webhook handling
Instrument eligibility	`GET /assets`; inspect `fractionalEligibility` and `orderRules`	Fractional trading
Raw equity history	`GET /portfolio/history` and sub-account equivalent	Trading API
Cash-flow-adjusted performance	`GET /portfolio/performance` and sub-account equivalent	Optional `benchmark=SCOM.KE`; daily TWR, P&L, and excess return
Partial fill and failure simulation	`POST /test-tools/trade`, then `PATCH /test-tools/orders/{orderId}`	Paper and demo trading
Idempotent mutation retry	Reuse the same `Idempotency-Key` and identical request	Authentication and idempotency

A market-data quote and a tradeable quote are different. Batch /market/quotes responses are for display and portfolio refresh. MARKET orders require the single-use quoteId from /quote/{symbol}.

For machine consumers, use the OpenAPI JSON, OpenAPI YAML, or the documentation catalog.

Was this page useful?

Your signal helps us tighten partner onboarding docs.

Send note

Last updated on

Partner API Specification

About MyStocks