API Documentation

Build powerful financial applications with SignalScript's APIs. Our platform provides orchestration capabilities and flexible data connectors to help you create sophisticated AI-powered solutions.

Core APIs

Essential functionality

Workflow API

Available

Execute AI-powered workflow templates with real-time streaming results.

POST /api/v1/workflow/execute/template/journal_template

Request

{
  "parameters": {
    "query": "Get AAPL stock price data for the last month",
    "limit": 5,
    "min_relevance": 0.7
  }
}

Parameters:

  • query (required): Natural language query to find relevant market data endpoints
  • limit (optional): Maximum number of results (default: 5)
  • min_relevance (optional): Minimum relevance score 0-1 (default: 0.5)

Response (Server-Sent Events)

// Event: Workflow Started
data: {"type": "state_update", "status": "started", "workflow_id": "wf-123", "timestamp": "2024-01-23T12:34:56Z"}

// Event: Search Progress
data: {"type": "token", "token": "Searching for relevant AlphaVantage endpoints..."}

// Event: Step Progress
data: {"type": "state_update", "status": "in_progress", "step": "endpoint_search", "progress": 0.3}

// Event: Found Endpoint
data: {"type": "token", "token": "Found TIME_SERIES_DAILY endpoint with relevance score 0.85"}

// Event: Data Collection
data: {"type": "state_update", "status": "in_progress", "step": "fetch_data", "progress": 0.6}

// Event: Analysis
data: {"type": "token", "token": "AAPL stock shows an upward trend with average volume..."}

// Event: Completion
data: {"type": "state_update", "status": "completed", "workflow_id": "wf-123", "execution_time": 2.5}

Event Types:

  • state_update: Workflow execution status and progress
  • token: Incremental results and analysis
  • error: Error information if something goes wrong

Coming Soon

GET /api/v1/workflow/templates List available templates
GET /api/v1/workflow/execution/{execution_id} Get execution status
POST /api/v1/workflow/execute/template/custom Execute custom workflow template

System API

Available

Monitor system health and status.

GET /health Check system health status

Connectors API

Coming Soon

Integrate your custom data sources with support for CSV and JSON formats.

POST /connectors

Create a Connector

{
  "name": "Portfolio Data",
  "type": "csv",
  "config": {
    "file_path": "/path/to/portfolio.csv",
    "columns": ["date", "symbol", "quantity", "price"],
    "delimiter": ","
  }
}
GET /connectors

List Connectors

{
  "connectors": [
    {
      "id": "conn_123",
      "name": "Portfolio Data",
      "type": "csv",
      "status": "active",
      "created_at": "2024-01-23T10:00:00Z"
    }
  ],
  "total": 1,
  "page": 1
}
GET /connectors/{id} Get connector details
PATCH /connectors/{id} Update connector
DELETE /connectors/{id} Delete connector

Management APIs

Platform operations

Authentication API

Available

Secure endpoints for user authentication and token management.

POST /auth/login Get access token

Coming Soon

POST /auth/signup Create new account
POST /auth/refresh Refresh access token

Usage & Billing API

Coming Soon

Monitor API usage and manage billing information.

GET /usage Get usage statistics
GET /billing Get billing information

Audit Logs API

Coming Soon

Access detailed logs of API operations and data access.

GET /logs/requests Get operation logs

Getting Started

To start using SignalScript's APIs:

  1. Get early access to API keys
  2. Choose a workflow template that matches your needs
  3. Execute the workflow with your data sources
  4. Process the streaming results in real-time
  5. Join our Discord community for support and updates
Get Free Early Access to API Keys Join Discord