API product catalogPan-African Market Data & Intelligence

List price alerts

Pan-African Market Data & Intelligence

GET

/price-alerts

List price alerts

Production onlylistPriceAlerts

Returns the price alerts registered by this partner.

Parameters

stateARMED | TRIGGERED | DISARMEDquery

Filter by alert state.

limitintegerquery

Example: 100

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

dataobject[]

data[].alertIdstring

Example: "alr_abc123"

data[].clientAlertIdstring

Your own reference, supplied at creation.

data[].symbolstring

Example: "SCOM.KE"

data[].exchangestring

Example: "NSE"

data[].conditionabove | below

data[].thresholdnumber

In the instrument's local trading currency.

Example: 20

data[].currencystring

The local trading currency the threshold is denominated in.

Example: "KES"

data[].repeatboolean

data[].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.

data[].lastPriceLocalnumber

data[].triggerCountinteger

data[].createdAtstring

data[].lastTriggeredAtstring

Response codes

200The partner's price alerts.

Request reference

Production only

state Optional · querylimit Optional · query

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

https://mystocks.africa/api/v1/partner/price-alerts

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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' \
  -H "Authorization: Bearer $MYSTOCKS_API_KEY"

GET /market/snapshot

POST /price-alerts