API product catalogExecution & Order Management (OMS)

Opportunity or pre-IPO detail

Execution & Order Management (OMS)

GET

/opportunities/{id}

Sandbox availablegetOpportunity

Returns full detail for a single private market deal or pre-IPO offering. Resolves from the opportunities collection first, then preIPOOfferings. Accepts document ID or slug.

Parameters

idstringpathRequired

Opportunity document ID or URL slug.

Example: acme-series-b-2026

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

idstringRequired

assetTypePRE_IPO | OPPORTUNITY

namestring | null

currencystring

expectedReturnnumber | string | null

minInvestmentnumber | null

pricePerSharenumber | null

minimumSharesnumber | null

catalogueSourcePUBLISHED | SYNTHETIC

Sandbox only. Published catalogue information or a synthetic demonstration product.

simulationOnlyboolean

Sandbox only. Does not create a real IPO reservation.

commitmentCurrencyUSD

minimumCommitmentUsdnumber | null

subscriptionAvailableboolean

subscriptionRestrictionstring | null

targetAmountnumber | null

currentRaisednumber | null

riskLevelstring | null

statusstring | null

descriptionstring | null

maturityDatestring | null

expectedExitDatestring | null

createdAtstring | null

Response codes

200Opportunity detail.

404Opportunity not found.

Sandbox playground

Read-only sandbox request

id Required · path

Sandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/opportunities/%7Bid%7D

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "assetType": {
      "type": "string",
      "enum": [
        "PRE_IPO",
        "OPPORTUNITY"
      ]
    },
    "name": {
      "type": [
        "string",
        "null"
      ]
    },
    "currency": {
      "type": "string"
    },
    "expectedReturn": {
      "type": [
        "number",
        "string",
        "null"
      ]
    },
    "minInvestment": {
      "type": [
        "number",
        "null"
      ]
    },
    "pricePerShare": {
      "type": [
        "number",
        "null"
      ]
    },
    "minimumShares": {
      "type": [
        "number",
        "null"
      ]
    },
    "catalogueSource": {
      "type": "string",
      "enum": [
        "PUBLISHED",
        "SYNTHETIC"
      ],
      "description": "Sandbox only. Published catalogue information or a synthetic demonstration product."
    },
    "simulationOnly": {
      "type": "boolean",
      "description": "Sandbox only. Does not create a real IPO reservation."
    },
    "commitmentCurrency": {
      "type": "string",
      "enum": [
        "USD"
      ]
    },
    "minimumCommitmentUsd": {
      "type": [
        "number",
        "null"
      ]
    },
    "subscriptionAvailable": {
      "type": "boolean"
    },
    "subscriptionRestriction": {
      "type": [
        "string",
        "null"
      ]
    },
    "targetAmount": {
      "type": [
        "number",
        "null"
      ]
    },
    "currentRaised": {
      "type": [
        "number",
        "null"
      ]
    },
    "riskLevel": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "type": [
        "string",
        "null"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "maturityDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "expectedExitDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

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

GET /opportunities

GET /orders