Seasonax Core API Documentation

Basics

Base URL

All requests are relative to:

https://app.seasonax.com/core-api

Authentication

Use a static key in the request header:

X-API-Key: MY-SECRET-API-KEY

Content-Type

All requests use JSON and UTF-8 encoding:

Content-Type: application/json

Endpoints

GET /baskets

Retrieve a list of available baskets.

Request

GET /baskets

Response (HTTP 200)

[
  {
    "uuid": "1dc5adaf-bd00-4f44-904d-a14addc11813",
    "name": "My awesome Basket"
  }
]

POST /patterns

Retrieve seasonal patterns for a specific basket.

Request

POST /patterns
{
  "basket": "1dc5adaf-bd00-4f44-904d-a14addc11813",
  "days": 1,
  "range": 5,
  "duration": 1,
  "is_short": false
}

Attributes

Attribute	Type	Description	Allowed Values	Default
basket	String	UUID of the basket	—	—
days	Integer	Days relative to today	0, 1, 7, 14, 30	0
range	Integer	Years used for historical calculation	5, 10, 15, 20	5
duration	Integer	Investment horizon	1, 2, 3	1
is_short	Boolean	Return short patterns	true, false	false

Durations

1: 5 to 30 days
2: 31 to 60 days
3: 61 to 90 days

Response (HTTP 200)

[
  {
    "asset": "My Test Instrument",
    "symbol": "TEST",
    "isin": "XS2265370234",
    "range_start": "2020-04-01",
    "range_end": "2025-04-01",
    "pattern_start": "0513",
    "pattern_end": "0613",
    "average_return": -2.56,
    "annualized_return": -26.63,
    "median_return": -2.17,
    "profit_rate": 80,
    "standard_deviation": 6.22,
    "pattern_count": 5,
    "winner_count": 1,
    "winner_profit": 5.75,
    "looser_count": 4,
    "looser_profit": -4.53,
    "calendar_days": 31,
    "trading_days": 26,
    "max_profit": 5.75,
    "max_loss": -10.74,
    "total_profit": -0.78,
    "average_profit": -0.16,
    "current_streak": 1,
    "sharpe_ratio": -1.59,
    "sortino_ratio": -2.56,
    "volatility": 15.31
  }
]

Notes

Dates are in ISO 8601 format.
pattern_start and pattern_end use MMDD format.
Returns and ratios are percentage points.
profit_rate = Win Ratio %