Average return per month

curl --request GET \
  --url https://api.unusualwhales.com/api/seasonality/{ticker}/monthly \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.unusualwhales.com/api/seasonality/{ticker}/monthly"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.unusualwhales.com/api/seasonality/{ticker}/monthly', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unusualwhales.com/api/seasonality/{ticker}/monthly",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unusualwhales.com/api/seasonality/{ticker}/monthly"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.unusualwhales.com/api/seasonality/{ticker}/monthly")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "avg_change": 0.0034,
      "max_change": 0.0635,
      "median_change": 0.0195,
      "min_change": -0.0727,
      "month": 1,
      "positive_closes": 2,
      "positive_months_perc": 0.6667,
      "years": 3
    },
    {
      "avg_change": 0.0006,
      "max_change": 0.0334,
      "median_change": 0.0057,
      "min_change": -0.0374,
      "month": 2,
      "positive_closes": 2,
      "positive_months_perc": 0.6667,
      "years": 3
    },
    {
      "avg_change": 0.0949,
      "max_change": 0.1497,
      "median_change": 0.0949,
      "min_change": 0.0402,
      "month": 3,
      "positive_closes": 2,
      "positive_months_perc": 1,
      "years": 2
    },
    {
      "avg_change": -0.0153,
      "max_change": 0.0724,
      "median_change": -0.0153,
      "min_change": -0.1029,
      "month": 4,
      "positive_closes": 1,
      "positive_months_perc": 0.5,
      "years": 2
    }
  ]
}

{
  "code": "authentication_required",
  "documentation_url": "https://api.unusualwhales.com/docs",
  "expected_format": "uuid",
  "message": "The API token provided is not in the expected format. Unusual Whales API tokens are UUIDs, such as 123e4567-e89b-12d3-a456-426614174000.",
  "reason": "malformed_token",
  "request_id": "GNI_YTC1CRnw2LACGBvE",
  "retryable": false,
  "support_email": "[email protected]",
  "token_url": "https://unusualwhales.com/dashboard/api"
}

{
  "code": "payment_required",
  "documentation_url": "https://api.unusualwhales.com/docs",
  "message": "This API token is paused because the payment for your API subscription failed. Update your card at https://unusualwhales.com/settings. The same token works again once a payment succeeds.",
  "reason": "payment_failed",
  "request_id": "GNI_YTC1CRnw2LACGBvE",
  "retryable": false,
  "support_email": "[email protected]",
  "token_url": "https://unusualwhales.com/dashboard/api"
}

{
  "code": "missing_access",
  "documentation_url": "https://api.unusualwhales.com/docs",
  "message": "The API token provided is valid but is not permitted to access this route.",
  "reason": "route_not_permitted",
  "request_id": "GNI_YTC1CRnw2LACGBvE",
  "retryable": false,
  "support_email": "[email protected]",
  "token_url": "https://unusualwhales.com/dashboard/api"
}

{
  "msg": "Invalid path input: MSFT12 (valid example: AAPL) - Invalid query input(s): date=2023-02-140 (valid example: date=2024-01-18)",
  "path": "/api/darkpool/MSFT12",
  "query": "date=2023-02-140",
  "url": "localhost:4000/api/darkpool/MSFT12?date=2023-02-140"
}

Something went wrong

GET

api

seasonality

{ticker}

monthly

Average return per month

curl --request GET \
  --url https://api.unusualwhales.com/api/seasonality/{ticker}/monthly \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.unusualwhales.com/api/seasonality/{ticker}/monthly"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.unusualwhales.com/api/seasonality/{ticker}/monthly', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unusualwhales.com/api/seasonality/{ticker}/monthly",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unusualwhales.com/api/seasonality/{ticker}/monthly"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.unusualwhales.com/api/seasonality/{ticker}/monthly")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "avg_change": 0.0034,
      "max_change": 0.0635,
      "median_change": 0.0195,
      "min_change": -0.0727,
      "month": 1,
      "positive_closes": 2,
      "positive_months_perc": 0.6667,
      "years": 3
    },
    {
      "avg_change": 0.0006,
      "max_change": 0.0334,
      "median_change": 0.0057,
      "min_change": -0.0374,
      "month": 2,
      "positive_closes": 2,
      "positive_months_perc": 0.6667,
      "years": 3
    },
    {
      "avg_change": 0.0949,
      "max_change": 0.1497,
      "median_change": 0.0949,
      "min_change": 0.0402,
      "month": 3,
      "positive_closes": 2,
      "positive_months_perc": 1,
      "years": 2
    },
    {
      "avg_change": -0.0153,
      "max_change": 0.0724,
      "median_change": -0.0153,
      "min_change": -0.1029,
      "month": 4,
      "positive_closes": 1,
      "positive_months_perc": 0.5,
      "years": 2
    }
  ]
}

{
  "code": "authentication_required",
  "documentation_url": "https://api.unusualwhales.com/docs",
  "expected_format": "uuid",
  "message": "The API token provided is not in the expected format. Unusual Whales API tokens are UUIDs, such as 123e4567-e89b-12d3-a456-426614174000.",
  "reason": "malformed_token",
  "request_id": "GNI_YTC1CRnw2LACGBvE",
  "retryable": false,
  "support_email": "[email protected]",
  "token_url": "https://unusualwhales.com/dashboard/api"
}

{
  "code": "payment_required",
  "documentation_url": "https://api.unusualwhales.com/docs",
  "message": "This API token is paused because the payment for your API subscription failed. Update your card at https://unusualwhales.com/settings. The same token works again once a payment succeeds.",
  "reason": "payment_failed",
  "request_id": "GNI_YTC1CRnw2LACGBvE",
  "retryable": false,
  "support_email": "[email protected]",
  "token_url": "https://unusualwhales.com/dashboard/api"
}

{
  "code": "missing_access",
  "documentation_url": "https://api.unusualwhales.com/docs",
  "message": "The API token provided is valid but is not permitted to access this route.",
  "reason": "route_not_permitted",
  "request_id": "GNI_YTC1CRnw2LACGBvE",
  "retryable": false,
  "support_email": "[email protected]",
  "token_url": "https://unusualwhales.com/dashboard/api"
}

{
  "msg": "Invalid path input: MSFT12 (valid example: AAPL) - Invalid query input(s): date=2023-02-140 (valid example: date=2024-01-18)",
  "path": "/api/darkpool/MSFT12",
  "query": "date=2023-02-140",
  "url": "localhost:4000/api/darkpool/MSFT12?date=2023-02-140"
}

Something went wrong

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ticker

string

required

A single ticker

Example:

"AAPL"

Response

The price change for the ticker in the month over the given count of years.

avg_change

number

The average relative price change of the month over all counted years. A month's change runs from the previous month's last close to the month's last close.

Example:

0.09494354167379757

max_change

number

The maximum relative price change of the month over all counted years. A month's change runs from the previous month's last close to the month's last close.

Example:

0.14970489711277724

median_change

number

The median relative price change of the month over all counted years. A month's change runs from the previous month's last close to the month's last close.

Example:

0.09494354167379757

min_change

number

The minimum relative price change of the month over all counted years. A month's change runs from the previous month's last close to the month's last close.

Example:

0.0401821862348179

month

integer

The number indicating the month the data applies for. e.g. 1 -> January, 2 -> February, ...

Example:

5

positive_closes

integer

The number of counted years in which the month closed above the previous month's close.

Example:

2

positive_months_perc

number

The relative amount of times, the month had a positive close. Multiply with 100 to get the amount in percent.

Example:

0.6667

years

number

The number of years used to calculate the data. Only completed months that have the previous month's close are counted, so the current month is left out.

Example:

3

Docs

Endpoints

Average return per month

Authorizations

Path Parameters

Response