API docs by Redocly

QuantumSignals API (v0.1.0)

Download OpenAPI specification:

Unified API for QuantumSignals trading signal platform

streaming

Real-time signal streaming via Server-Sent Events

Signal Endpoint

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
null

inference

Model catalog and inference service

Models

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

key_server

API key management

Get Keys

Retrieve API keys (keyauth_credentials) for the authenticated user from Kong

Responses

Response samples

Content type
application/json
null

Post Keys

Create a new API key (keyauth_credential) for the authenticated user in Kong

Responses

Response samples

Content type
application/json
null

Delete Key

Delete a specific API key (keyauth_credential) for the authenticated user in Kong. Provide either key_id or key in the request body, but not both.

query Parameters
Key Id (string) or Key Id (null) (Key Id)
Key (string) or Key (null) (Key)

Responses

Response samples

Content type
application/json
null

backtest

Backtest results storage and retrieval

Get most recent backtest

Retrieve the most recently created backtest job for a given model hash and symbol

Authorizations:
ApiKeyAuth
query Parameters
model_hash
required
string (Model Hash)

Model configuration hash

symbol
required
string (Symbol)

Trading symbol (e.g., AAPL, NVDA)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "model_id": "string",
  • "model_hash": "string",
  • "symbol": "string",
  • "backtest_from_date": "2019-08-24",
  • "backtest_to_date": "2019-08-24",
  • "generation_timestamp": "2019-08-24T14:15:22Z",
  • "ingestion_timestamp": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Get backtest metadata

Retrieve metadata for a specific backtest job by ID

Authorizations:
ApiKeyAuth
query Parameters
id
required
string (Id)

Backtest job ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "model_id": "string",
  • "model_hash": "string",
  • "symbol": "string",
  • "backtest_from_date": "2019-08-24",
  • "backtest_to_date": "2019-08-24",
  • "generation_timestamp": "2019-08-24T14:15:22Z",
  • "ingestion_timestamp": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z"
}

Get backtest results

Retrieve prediction results for a specific backtest with optional pagination and date filtering

Authorizations:
ApiKeyAuth
query Parameters
backtest_id
required
string (Backtest Id)

Backtest job ID

format
string (Format)
Default: "json"
Enum: "json" "csv" "parquet"

Response format

From Date (string) or From Date (null) (From Date)

Start date filter (YYYY-MM-DD, inclusive)

To Date (string) or To Date (null) (To Date)

End date filter (YYYY-MM-DD, exclusive)

Page (integer) or Page (null) (Page)

Page number (starts at 1)

page_size
integer (Page Size) [ 1 .. 10000 ]
Default: 1000

Results per page

Responses

Response samples

Content type
application/json
null

Get backtest accuracy

Retrieve daily accuracy metrics for a specific backtest with optional date filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
backtest_id
required
string (Backtest Id)

Backtest job ID

format
string (Format)
Default: "json"
Enum: "json" "csv" "parquet"

Response format

From Date (string) or From Date (null) (From Date)

Start date filter (YYYY-MM-DD, inclusive)

To Date (string) or To Date (null) (To Date)

End date filter (YYYY-MM-DD, exclusive)

Page (integer) or Page (null) (Page)

Page number (starts at 1)

page_size
integer (Page Size) [ 1 .. 10000 ]
Default: 1000

Results per page

Responses

Response samples

Content type
application/json
null