Month Performers

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

import requests

url = "https://api.unusualwhales.com/api/seasonality/{month}/performers"

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/{month}/performers', 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/{month}/performers",
  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/{month}/performers"

	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/{month}/performers")

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.0592",
      "marketcap": "19427901578",
      "max_change": "0.1104",
      "median_change": "0.0639",
      "min_change": "0.0091",
      "month": 5,
      "positive_closes": 10,
      "positive_months_perc": "1",
      "sector": "Healthcare",
      "ticker": "ICLR",
      "years": 10
    },
    {
      "avg_change": "0.0577",
      "marketcap": "1927713687",
      "max_change": "0.2301",
      "median_change": "0.0417",
      "min_change": "-0.2485",
      "month": 5,
      "positive_closes": 10,
      "positive_months_perc": "1",
      "sector": "Technology",
      "ticker": "AMBA",
      "years": 10
    },
    {
      "avg_change": "0.0664",
      "marketcap": "60982620879",
      "max_change": "0.1791",
      "median_change": "0.07291",
      "min_change": "-0.0878",
      "month": 5,
      "positive_closes": 15,
      "positive_months_perc": "0.9375",
      "sector": "Healthcare",
      "ticker": "MCK",
      "years": 16
    },
    {
      "avg_change": "0.0674",
      "marketcap": "24233152429",
      "max_change": "0.2167",
      "median_change": "0.0723",
      "min_change": "-0.1812",
      "month": 5,
      "positive_closes": 15,
      "positive_months_perc": "0.9375",
      "sector": "Communication Services",
      "ticker": "TTWO",
      "years": 16
    }
  ]
}

{
  "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

{month}

performers

Month Performers

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

import requests

url = "https://api.unusualwhales.com/api/seasonality/{month}/performers"

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/{month}/performers', 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/{month}/performers",
  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/{month}/performers"

	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/{month}/performers")

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.0592",
      "marketcap": "19427901578",
      "max_change": "0.1104",
      "median_change": "0.0639",
      "min_change": "0.0091",
      "month": 5,
      "positive_closes": 10,
      "positive_months_perc": "1",
      "sector": "Healthcare",
      "ticker": "ICLR",
      "years": 10
    },
    {
      "avg_change": "0.0577",
      "marketcap": "1927713687",
      "max_change": "0.2301",
      "median_change": "0.0417",
      "min_change": "-0.2485",
      "month": 5,
      "positive_closes": 10,
      "positive_months_perc": "1",
      "sector": "Technology",
      "ticker": "AMBA",
      "years": 10
    },
    {
      "avg_change": "0.0664",
      "marketcap": "60982620879",
      "max_change": "0.1791",
      "median_change": "0.07291",
      "min_change": "-0.0878",
      "month": 5,
      "positive_closes": 15,
      "positive_months_perc": "0.9375",
      "sector": "Healthcare",
      "ticker": "MCK",
      "years": 16
    },
    {
      "avg_change": "0.0674",
      "marketcap": "24233152429",
      "max_change": "0.2167",
      "median_change": "0.0723",
      "min_change": "-0.1812",
      "month": 5,
      "positive_closes": 15,
      "positive_months_perc": "0.9375",
      "sector": "Communication Services",
      "ticker": "TTWO",
      "years": 16
    }
  ]
}

{
  "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

month

enum<string>

required

A month number indicating the month, e.g. 1 -> January, 2 -> February, ...

Available options:

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12

Example:

"3"

Query Parameters

min_years

integer

default:10

The minimum amount of years data for the month need to be available for the ticker. Default: 10. Min: 1.

Required range: x >= 1

Example:

3

ticker_for_sector

string

A single ticker. The result will only contain tickers in the same sector as the given ticker, e.g. 'MSFT' will only yield result tickers in sector 'Technology'.

Example:

"AAPL"

s_p_500_nasdaq_only

boolean

default:false

Only return tickers, that are in the S&P 500 index or the Nasdaq 100 index.

Example:

true

min_oi

integer

The minimum open interest. Min: 0.

Required range: x >= 0

Example:

10000

limit

integer

default:50

How many items to return. Default: 50. Min: 1.

Required range: x >= 1

Example:

10

order

enum<string>

Optional columns to order the result by

Available options:

month,

positive_closes,

years,

positive_months_perc,

median_change,

avg_change,

max_change,

min_change

Example:

"ticker"

order_direction

enum<string>

default:desc

Whether to sort descending or ascending. Descending by default.

Available options:

desc,

asc

Example:

"asc"

Response

The price change for the ticker 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

marketcap

string

The marketcap of the underlying ticker. If the issue type of the ticker is ETF then the marketcap represents the AUM.

Example:

"2965813810400"

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

sector

enum<string>

The financial sector of the ticker. Empty if unknown or not applicable such as ETF/Index.

Available options:

Basic Materials,

Communication Services,

Consumer Cyclical,

Consumer Defensive,

Energy,

Financial Services,

Healthcare,

Industrials,

Real Estate,

Technology,

Utilities

Example:

"Technology"

ticker

string

The stock ticker.

Example:

"AAPL"

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

Month Performers

Authorizations

Path Parameters

Query Parameters

Response