API product catalogPan-African Market Data & Intelligence

Unified asset catalog

Pan-African Market Data & Intelligence

GET

/assets

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"

Pan-African Market Data & Intelligence

GET /companies