API Documentation

Welcome to the StockAlert.pro API

Our API allows you to programmatically create and manage stock alerts, integrate with your applications, and receive real-time notifications when market conditions meet your criteria.

What you can build

• Trading bots that automatically set alerts based on technical indicators
• Portfolio management tools with price monitoring
• Discord/Slack bots for team notifications
• Custom dashboards with webhook integrations
• Automated stock analysis workflows with n8n.io

Quick Start Guide

curl -X GET https://stockalert.pro/api/v1/alerts \
  -H "X-API-Key: sk_your_api_key"

curl -X POST https://stockalert.pro/api/v1/alerts \
  -H "X-API-Key: sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "symbol": "AAPL",
    "condition": "price_above",
    "threshold": 200
  }'

Base URL

https://stockalert.pro/api/v1

OpenAPI spec: GET /openapi.yaml

Response Format

All API responses are in JSON format and follow a consistent structure:

// Success Response
{
  "success": true,
  "data": { /* ... */ },
  "meta": {
    "rate_limit": {
      "limit": 1000,
      "remaining": 999,
      "reset": 1736180400000
    }
  }
}

// Error Response
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": { /* optional */ }
  }
}