Signa

https://getsigna.ai/docs
Admin
Signa is an API platform providing real-time market data, trading signals, technical analysis, and...
Tokens:2,194
Snippets:13
Trust Score:3
Update:5 months ago
Show doc for...
Tokens:
Raw
### API Authentication Example

Source: https://getsigna.ai/docs/reference

Example of how to authenticate API requests using an Authorization Bearer token. Obtain your API key from the Dashboard.

```text
Authorization: Bearer cmts_a1b2c3d4e5f6...
```

--------------------------------

### Get Real-Time Quote Response

Source: https://getsigna.ai/docs/reference

Example response for the GET /api/v1/quote/:symbol endpoint, providing real-time price data for a given symbol.

```json
{
  "ok": true,
  "symbol": "AAPL",
  "data": {
    "price": 178.23,
    "change": 2.45,
    "changePercent": 1.39,
    "volume": 54382910,
    "high": 179.10,
    "low": 176.80,
    "open": 177.00,
    "source": "signa",
    "timestamp": "2026-03-31T16:00:00Z"
  }
}
```

--------------------------------

### GET /api/v1/index/signa

Source: https://getsigna.ai/docs/reference

Provides the Signa Signal Index, a real-time composite market-wide sentiment and signal strength score. Requires an Enterprise plan.

```APIDOC
## GET /api/v1/index/signa

### Description
The Signa Signal Index — a composite market-wide sentiment and signal strength score updated in real-time.

### Method
GET

### Endpoint
`/api/v1/index/signa`

### Note
Full documentation, including request parameters, response schema, code examples, error handling, and rate limit headers, is available with an Enterprise plan.
```

--------------------------------

### Get Health Check Response

Source: https://getsigna.ai/docs/reference

Example response for the GET /api/v1/health endpoint, indicating the operational status of data providers. No authentication is required.

```json
{
  "ok": true,
  "status": "healthy",
  "providers": [
    { "name": "Signa Market Data", "healthy": true, "latency_ms": 42 }
  ],
  "meta": {
    "api_version": "v1",
    "engine_version": "2.0",
    "checked_at": "2026-03-31T16:00:00Z"
  }
}
```

--------------------------------

### GET /api/v1/signal

Source: https://getsigna.ai/docs/reference

Retrieves the full Signa Action Card for a symbol, including bias, stage, confidence, triggers, and technical indicator values. Requires a Pro plan.

```APIDOC
## GET /api/v1/signal

### Description
Returns the full Signa Action Card for a symbol — bias, Weinstein stage, confidence, triggers, entry/stop/target, and all technical indicator values.

### Method
GET

### Endpoint
`/api/v1/signal?sym=:symbol`

### Parameters
#### Query Parameters
- **sym** (string) - Required - Ticker symbol (e.g. AAPL, QQQ, BTC/USD)

### Note
Full documentation, including request parameters, response schema, code examples, error handling, and rate limit headers, is available with a Pro plan.
```

--------------------------------

### GET /api/v1/analysis

Source: https://getsigna.ai/docs/reference

Retrieves extended analysis for a symbol, including chart patterns, market opportunities, sentiment context, and full technical data. Requires a Pro plan.

```APIDOC
## GET /api/v1/analysis

### Description
Returns extended analysis including chart patterns, market opportunities, sentiment context, and full technical data.

### Method
GET

### Endpoint
`/api/v1/analysis?sym=:symbol`

### Note
Full documentation, including request parameters, response schema, code examples, error handling, and rate limit headers, is available with a Pro plan.
```

--------------------------------

### GET /api/v1/health

Source: https://getsigna.ai/docs/reference

Checks the health status of all data providers. This endpoint does not require authentication and is available to all users.

```APIDOC
## GET /api/v1/health

### Description
Returns the health status of all data providers. No authentication required.

### Method
GET

### Endpoint
`/api/v1/health`

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the request was successful.
- **status** (string) - The overall health status (e.g., "healthy").
- **providers** (array) - A list of data providers and their status.
  - **name** (string) - The name of the provider.
  - **healthy** (boolean) - Indicates if the provider is healthy.
  - **latency_ms** (number) - The latency in milliseconds.
- **meta** (object) - Metadata about the health check.
  - **api_version** (string) - The API version.
  - **engine_version** (string) - The engine version.
  - **checked_at** (string) - The timestamp of the health check.

#### Response Example
```json
{
  "ok": true,
  "status": "healthy",
  "providers": [
    { "name": "Signa Market Data", "healthy": true, "latency_ms": 42 }
  ],
  "meta": {
    "api_version": "v1",
    "engine_version": "2.0",
    "checked_at": "2026-03-31T16:00:00Z"
  }
}
```
```

--------------------------------

### GET /api/v1/quote/:symbol

Source: https://getsigna.ai/docs/reference

Retrieves a real-time price quote for a given stock, ETF, or crypto symbol. This is a core endpoint available to all users.

```APIDOC
## GET /api/v1/quote/:symbol

### Description
Returns a real-time price quote for any stock, ETF, or crypto symbol.

### Method
GET

### Endpoint
`/api/v1/quote/:symbol`

### Parameters
#### Path Parameters
- **symbol** (string) - Required - Ticker symbol (e.g. AAPL, QQQ, BTC/USD)

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the request was successful.
- **symbol** (string) - The requested ticker symbol.
- **data** (object) - Contains the quote details.
  - **price** (number) - The current price.
  - **change** (number) - The price change since the previous close.
  - **changePercent** (number) - The percentage change since the previous close.
  - **volume** (number) - The trading volume.
  - **high** (number) - The day's high price.
  - **low** (number) - The day's low price.
  - **open** (number) - The opening price.
  - **source** (string) - The data source.
  - **timestamp** (string) - The timestamp of the quote.

#### Response Example
```json
{
  "ok": true,
  "symbol": "AAPL",
  "data": {
    "price": 178.23,
    "change": 2.45,
    "changePercent": 1.39,
    "volume": 54382910,
    "high": 179.10,
    "low": 176.80,
    "open": 177.00,
    "source": "signa",
    "timestamp": "2026-03-31T16:00:00Z"
  }
}
```
```

--------------------------------

### GET /api/v1/history/:symbol

Source: https://getsigna.ai/docs/reference

Fetches historical OHLCV (Open, High, Low, Close, Volume) candle data for a given symbol. Supports various timeframes and up to 500 bars. Requires a Pro plan.

```APIDOC
## GET /api/v1/history/:symbol

### Description
Returns historical OHLCV candle data. Supports daily, 4h, 1h, and intraday timeframes. Up to 500 bars.

### Method
GET

### Endpoint
`/api/v1/history/:symbol`

### Note
Full documentation, including request parameters, response schema, code examples, error handling, and rate limit headers, is available with a Pro plan.
```

--------------------------------

### POST /api/v1/backtest

Source: https://getsigna.ai/docs/reference

Runs Monte Carlo backtests on any strategy using historical Signa signals, returning probability of ruin, expected return, and outcome distribution. Requires an Enterprise plan.

```APIDOC
## POST /api/v1/backtest

### Description
Run Monte Carlo backtests on any strategy using historical Signa signals. Returns probability of ruin, expected return, and outcome distribution.

### Method
POST

### Endpoint
`/api/v1/backtest`

### Note
Full documentation, including request parameters, response schema, code examples, error handling, and rate limit headers, is available with an Enterprise plan.
```

--------------------------------

### POST /api/v1/screener

Source: https://getsigna.ai/docs/reference

Provides an advanced screener with full Action Card data for each symbol, returning a ranked list sorted by overall score. Requires a Pro plan.

```APIDOC
## POST /api/v1/screener

### Description
Advanced screener with full Action Card data for each symbol. Returns a ranked list sorted by overall score.

### Method
POST

### Endpoint
`/api/v1/screener`

### Note
Full documentation, including request parameters, response schema, code examples, error handling, and rate limit headers, is available with a Pro plan.
```

--------------------------------

### POST /api/v1/a2a/route

Source: https://getsigna.ai/docs/reference

Enables AI agents to request signals, analysis, and execution recommendations in a structured agent protocol format. Requires an Enterprise plan.

```APIDOC
## POST /api/v1/a2a/route

### Description
Agent-to-Agent routing endpoint. Allows AI agents to request signals, analysis, and execution recommendations in a structured agent protocol format.

### Method
POST

### Endpoint
`/api/v1/a2a/route`

### Note
Full documentation, including request parameters, response schema, code examples, error handling, and rate limit headers, is available with an Enterprise plan.
```

--------------------------------

### POST /api/v1/scan

Source: https://getsigna.ai/docs/reference

Scans multiple symbols simultaneously and returns results ranked by signal score. Allows filtering by tier and minimum score. Requires a Pro plan.

```APIDOC
## POST /api/v1/scan

### Description
Scan multiple symbols simultaneously and return results ranked by signal score. Filter by tier (HOT/WATCH/NEUTRAL) and minimum score.

### Method
POST

### Endpoint
`/api/v1/scan`

### Note
Full documentation, including request parameters, response schema, code examples, error handling, and rate limit headers, is available with a Pro plan.
```
Tokens:
Raw