Start building

Published Pre-IPO integration

MyStocks Partner API

Discover published offerings and distinguish virtual Sandbox commitments from real reservations.

Integration guides Get a sandbox key

Explore endpoints

1 of 1

GET

/opportunities

Private credit & pre-IPO

Full endpoint documentation

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"

What can a partner browse?

GET /opportunities?type=PRE_IPO includes published offering information with PUBLISHED, LISTED or ALLOCATED status, including Dangote when published. catalogueSource distinguishes PUBLISHED information from SYNTHETIC demos. Sandbox rows have simulationOnly: true. Neither publication nor Sandbox availability guarantees production allocation eligibility.

How do we commit virtual funds?

Follow the executable Pre-IPO recipe. Obtain an actual ID from the list, read /opportunities/{id}, check subscriptionAvailable, subscriptionRestriction and minimumCommitmentUsd, then submit { assetType: "PRE_IPO", assetId, amount } to the Sandbox customer's subscribe endpoint with a stable Idempotency-Key.

The customer must already have sufficient virtual USD. IDs are canonical subscription identifiers; slugs are browsing aliases. No real shares, production reservations, customer wallets or offering funding totals change. Verify the resulting virtual holding, order and wallet, then replay the identical request to prove it cannot debit twice.

What does admin handle?

/admin/partners tracks partner access and acceptance evidence. /admin/pre-ipo owns real published offering information and the actual offering lifecycle. Keep those controls distinct from virtual Sandbox commitments. Production eligibility, reservation and allocation require their separate reviewed workflow.

What errors should we handle?

An unknown or unpublished offering returns 404. Wrong asset type, unavailable USD terms or a below-minimum virtual commitment are rejected. Display the returned restriction; do not invent FX or assume that a listed offering remains open for new real subscriptions.

See API Reference, acceptance and errors.

Was this page useful?

Your signal helps us tighten partner onboarding docs.

Send note

Last updated on

Integration Guides

Hosted API, OnPrem or both