API-Dokumentation

RESTful API für MarketMetrix StockLens Pro/Enterprise

Willkommen zur MarketMetrix StockLens API

Die MarketMetrix StockLens API ermöglicht programmatischen Zugriff auf alle Screening-, Watchlist- und Marktdaten-Funktionen. Integriere MarketMetrix StockLens in deine Trading-Systeme, Spreadsheets oder eigene Anwendungen.

Base URL: https://marketmetrix.io/api/v1
Schnellstart
cURL
curl -X GET "https://marketmetrix.io/api/v1/universes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Authentifizierung

API-Authentifizierung via API-Key

POST /api/v1/auth/token

Erstellt einen temporären Access-Token

Parameter
Name Typ Pflicht Beschreibung
api_key string Ja Dein API-Key
Beispiel-Response
JSON
{
  "expires_in": 3600,
  "token": "eyJhbGciOiJIUzI1NiIs..."
}
Screening

Aktien-Screening nach Minervini-Kriterien

POST /api/v1/screening/run

Führt ein Screening für ein Universe durch

Parameter
Name Typ Pflicht Beschreibung
universe_id string Ja Universe ID
min_score integer Nein Minimaler Score (1-9) (Default: 7)
Beispiel-Response
JSON
{
  "screening_id": "scr_123456",
  "started_at": "2025-01-15T10:30:00Z",
  "status": "running",
  "universe": "russell_1000"
}
GET /api/v1/screening/{screening_id}

Ruft Screening-Ergebnisse ab

Parameter
Name Typ Pflicht Beschreibung
screening_id string Ja Screening ID
Beispiel-Response
JSON
{
  "results": {
    "passed": 45,
    "stocks": [
      {
        "price": 850.5,
        "score": 9,
        "ticker": "NVDA"
      }
    ],
    "total_screened": 1000
  },
  "screening_id": "scr_123456",
  "status": "completed"
}
GET /api/v1/screening/history

Liste aller Screenings

Parameter
Name Typ Pflicht Beschreibung
limit integer Nein Max. Anzahl (Default: 20)
offset integer Nein Offset für Pagination
Beispiel-Response
JSON
{
  "screenings": [],
  "total": 150
}
Universes

Aktien-Universes verwalten

GET /api/v1/universes

Liste aller verfügbaren Universes

Beispiel-Response
JSON
{
  "universes": [
    {
      "id": "russell_1000",
      "name": "Russell 1000",
      "stock_count": 1000
    }
  ]
}
GET /api/v1/universes/{universe_id}

Details eines Universe

Parameter
Name Typ Pflicht Beschreibung
universe_id string Ja Universe ID
Beispiel-Response
JSON
{
  "id": "russell_1000",
  "name": "Russell 1000",
  "stocks": [
    "AAPL",
    "MSFT",
    "..."
  ]
}
POST /api/v1/universes

Erstellt ein neues Universe

Parameter
Name Typ Pflicht Beschreibung
name string Ja Name des Universe
tickers array Ja Liste der Ticker-Symbole
Beispiel-Response
JSON
{
  "id": "custom_123",
  "name": "My Universe",
  "stock_count": 50
}
Watchlist

Watchlist-Verwaltung

GET /api/v1/watchlist

Aktuelle Watchlist abrufen

Beispiel-Response
JSON
{
  "stocks": [
    {
      "added_at": "2025-01-10T08:00:00Z",
      "notes": "Tech leader",
      "ticker": "AAPL"
    }
  ]
}
POST /api/v1/watchlist/add

Aktie zur Watchlist hinzufügen

Parameter
Name Typ Pflicht Beschreibung
ticker string Ja Ticker-Symbol
notes string Nein Notizen
Beispiel-Response
JSON
{
  "success": true
}
DELETE /api/v1/watchlist/{ticker}

Aktie von Watchlist entfernen

Parameter
Name Typ Pflicht Beschreibung
ticker string Ja Ticker-Symbol
Beispiel-Response
JSON
{
  "success": true
}
Alerts

Preisalarme verwalten

GET /api/v1/alerts

Liste aller Alerts

Beispiel-Response
JSON
{
  "alerts": [
    {
      "id": "alert_123",
      "target_price": 200.0,
      "ticker": "AAPL",
      "type": "above"
    }
  ]
}
POST /api/v1/alerts

Neuen Alert erstellen

Parameter
Name Typ Pflicht Beschreibung
ticker string Ja Ticker-Symbol
type string Ja above oder below
target_price number Ja Zielpreis
Beispiel-Response
JSON
{
  "id": "alert_123",
  "success": true
}
Marktdaten

Echtzeit- und historische Kursdaten

GET /api/v1/quote/{ticker}

Aktueller Kurs einer Aktie

Parameter
Name Typ Pflicht Beschreibung
ticker string Ja Ticker-Symbol
Beispiel-Response
JSON
{
  "change": 2.35,
  "change_percent": 1.28,
  "price": 185.5,
  "ticker": "AAPL",
  "volume": 45000000
}
GET /api/v1/history/{ticker}

Historische Kursdaten

Parameter
Name Typ Pflicht Beschreibung
ticker string Ja Ticker-Symbol
period string Nein 1d, 5d, 1mo, 3mo, 6mo, 1y, 5y (Default: 1y)
Beispiel-Response
JSON
{
  "data": [
    {
      "close": 185.5,
      "date": "2025-01-15",
      "high": 186.0,
      "low": 183.5,
      "open": 184.0,
      "volume": 45000000
    }
  ],
  "ticker": "AAPL"
}
GET /api/v1/indices

Weltweite Marktindizes

Beispiel-Response
JSON
{
  "indices": [
    {
      "change_percent": 0.45,
      "name": "S\u0026P 500",
      "price": 5850.0,
      "symbol": "^GSPC"
    }
  ]
}
Rate Limits
Plan Requests/Minute Requests/Tag Concurrent Screenings
Free 10 100 1
Pro 60 5.000 3
Enterprise 300 Unbegrenzt 10
Rate Limit Headers werden in jeder Response mitgeliefert: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
Fehler-Codes
Code Status Beschreibung
400 Bad Request Ungültige Parameter oder fehlende Pflichtfelder
401 Unauthorized Fehlender oder ungültiger API-Key
403 Forbidden Keine Berechtigung für diese Ressource
404 Not Found Ressource nicht gefunden
429 Too Many Requests Rate Limit überschritten
500 Internal Server Error Serverfehler - bitte später erneut versuchen
Fehler-Response Format
{
  "error": {
    "code": "invalid_parameter",
    "message": "Der Parameter 'universe_id' ist erforderlich.",
    "details": {
      "field": "universe_id",
      "type": "required"
    }
  }
}