API product catalogDeveloper Platform, Sandbox & Key Management

Get data API key

Developer Platform, Sandbox & Key Management

GET

/api-keys/data-key

Get data API key

Sandbox availablelistDataKey

Returns a masked registry identifier in dataKey and the keyId (if issued), never the usable credential. Data keys can access market data endpoints but cannot execute trades or move funds. ⚠️ Prefer server-side use. An embedded pk_data_ key can be extracted from any client bundle, shares the parent full key's rate-limit bucket, and rotating it breaks every shipped install (only one is active per partner). For production apps, proxy market data through your backend or use short-lived tokens from POST /oauth/token; reserve embedded data keys for low-stakes surfaces such as public widgets.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

dataKeystring | null

Masked registry identifier for display only; not a usable credential. null if not yet issued. Retrieve the usable key only from the creation POST response.

keyIdstring | null

Internal identifier for the active data key. null if none is active.

Response codes

200Data API key info.

Sandbox playground

Read-only sandbox request

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

https://mystocks.africa/api/sandbox/v1/partner/api-keys/data-key

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "dataKey": {
      "type": [
        "string",
        "null"
      ],
      "description": "Masked registry identifier for display only; not a usable credential. null if not yet issued. Retrieve the usable key only from the creation POST response."
    },
    "keyId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Internal identifier for the active data key. null if none is active."
    }
  }
}

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

DELETE /api-keys/data-key

POST /api-keys/data-key