API product catalogExecution & Order Management (OMS)

Private credit & pre-IPO

Execution & Order Management (OMS)

GET

/opportunities

Sandbox availablelistOpportunities

Returns open private credit deals and pre-IPO opportunities available to your sub-accounts. Each deal has a minimum ticket size, close date, and target return.

Parameters

typeALL | PRE_IPO | OPPORTUNITYquery

Example: ALL

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

opportunitiesobject[]Required

opportunities[].idstringRequired

opportunities[].assetTypePRE_IPO | OPPORTUNITYRequired

opportunities[].namestring | nullRequired

opportunities[].currencystringRequired

opportunities[].expectedReturnnumber | string | nullRequired

opportunities[].minInvestmentnumber | nullRequired

opportunities[].pricePerSharenumber | null

opportunities[].minimumSharesnumber | null

opportunities[].catalogueSourcePUBLISHED | SYNTHETIC

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

opportunities[].simulationOnlyboolean

Sandbox only. Does not create a real IPO reservation.

opportunities[].commitmentCurrencyUSD

opportunities[].minimumCommitmentUsdnumber | null

opportunities[].subscriptionAvailableboolean

opportunities[].subscriptionRestrictionstring | null

opportunities[].targetAmountnumber | nullRequired

opportunities[].currentRaisednumber | nullRequired

opportunities[].riskLevelstring | nullRequired

opportunities[].statusstring | nullRequired

opportunities[].descriptionstring | nullRequired

opportunities[].maturityDatestring | nullRequired

opportunities[].expectedExitDatestring | nullRequired

opportunities[].createdAtstring | nullRequired

countintegerRequired

Response codes

200Open opportunities.

Sandbox playground

Read-only sandbox request

type Optional · querySandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "opportunities",
    "count"
  ],
  "properties": {
    "opportunities": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "assetType",
          "name",
          "currency",
          "expectedReturn",
          "minInvestment",
          "targetAmount",
          "currentRaised",
          "riskLevel",
          "status",
          "description",
          "maturityDate",
          "expectedExitDate",
          "createdAt"
        ],
        "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"
            ]
          }
        }
      }
    },
    "count": {
      "type": "integer"
    }
  }
}

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

GET /market/status

GET /opportunities/{id}