API product catalogPan-African Market Data & Intelligence

Get a price alert

Pan-African Market Data & Intelligence

GET

/price-alerts/{alertId}

Get a price alert

Production onlygetPriceAlert

Parameters

alertIdstringpathRequired

Example: alr_abc123

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

alertIdstring

Example: "alr_abc123"

clientAlertIdstring

Your own reference, supplied at creation.

symbolstring

Example: "SCOM.KE"

exchangestring

Example: "NSE"

conditionabove | below

thresholdnumber

In the instrument's local trading currency.

Example: 20

currencystring

The local trading currency the threshold is denominated in.

Example: "KES"

repeatboolean

stateARMED | TRIGGERED | DISARMED

ARMED — waiting for the threshold to be crossed. TRIGGERED — a repeat alert that has fired and is waiting for the price to cross back before re-arming. DISARMED — a one-shot alert that has fired and is spent.

lastPriceLocalnumber

triggerCountinteger

createdAtstring

lastTriggeredAtstring

Response codes

200The price alert.

404Price alert not found.

Request reference

Production only

alertId Required · path

Use the API Reference for this production-only or streaming operation.

https://mystocks.africa/api/v1/partner/price-alerts/%7BalertId%7D

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "description": "A registered price threshold. Crossing it while the exchange is open fires the `price.alert` webhook.",
  "properties": {
    "alertId": {
      "type": "string",
      "example": "alr_abc123"
    },
    "clientAlertId": {
      "type": "string",
      "nullable": true,
      "description": "Your own reference, supplied at creation."
    },
    "symbol": {
      "type": "string",
      "example": "SCOM.KE"
    },
    "exchange": {
      "type": "string",
      "example": "NSE"
    },
    "condition": {
      "type": "string",
      "enum": [
        "above",
        "below"
      ]
    },
    "threshold": {
      "type": "number",
      "description": "In the instrument's local trading currency.",
      "example": 20
    },
    "currency": {
      "type": "string",
      "nullable": true,
      "description": "The local trading currency the threshold is denominated in.",
      "example": "KES"
    },
    "repeat": {
      "type": "boolean"
    },
    "state": {
      "type": "string",
      "enum": [
        "ARMED",
        "TRIGGERED",
        "DISARMED"
      ],
      "description": "ARMED — waiting for the threshold to be crossed.\nTRIGGERED — a repeat alert that has fired and is waiting for the price to cross back before re-arming.\nDISARMED — a one-shot alert that has fired and is spent.\n"
    },
    "lastPriceLocal": {
      "type": "number",
      "nullable": true
    },
    "triggerCount": {
      "type": "integer"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "lastTriggeredAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    }
  }
}

curl -X GET 'https://mystocks.africa/api/v1/partner/price-alerts/%7BalertId%7D' \
  -H "Authorization: Bearer $MYSTOCKS_API_KEY"

DELETE /price-alerts/{alertId}

GET /stocks