Call/Put Net/Vol Ticks

curl --request GET \
  --url https://api.unusualwhales.com/api/stock/{ticker}/net-prem-ticks \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.unusualwhales.com/api/stock/{ticker}/net-prem-ticks"

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/stock/{ticker}/net-prem-ticks', 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/stock/{ticker}/net-prem-ticks",
  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/stock/{ticker}/net-prem-ticks"

	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/stock/{ticker}/net-prem-ticks")

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": [
    {
      "call_volume": 1145,
      "call_volume_ask_side": 822,
      "call_volume_bid_side": 182,
      "date": "2025-03-21T00:00:00.000Z",
      "net_call_premium": "2234.00",
      "net_call_volume": 640,
      "net_delta": "26294.85817964231814400",
      "net_put_premium": "-11106.00",
      "net_put_volume": -137,
      "put_volume": 241,
      "put_volume_ask_side": 49,
      "put_volume_bid_side": 186,
      "tape_time": "2025-03-21T19:58:00.000Z"
    },
    {
      "call_volume": 1255,
      "call_volume_ask_side": 912,
      "call_volume_bid_side": 192,
      "date": "2025-03-21T00:00:00.000Z",
      "net_call_premium": "3234.00",
      "net_call_volume": 720,
      "net_delta": "28294.85817964231814400",
      "net_put_premium": "-9106.00",
      "net_put_volume": -127,
      "put_volume": 231,
      "put_volume_ask_side": 59,
      "put_volume_bid_side": 166,
      "tape_time": "2025-03-21T19:59:00.000Z"
    }
  ]
}

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

stock

Call/Put Net/Vol Ticks

Returns the net premium ticks for a given ticker which can be used to build the following chart: Net Prem chart

For real time streaming of net call and put premium and volume, subscribe to the net_flow:<TICKER> websocket channel, see https://api.unusualwhales.com/docs/websocket/net-flow.

Each tick is resembling the data for a single minute tick. To build a daily chart you would have to add the previous data to the current tick:

const url =
  'https://api.unusualwhales.com/api/stock/AAPL/net-prem-ticks';
const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer YOUR_TOKEN'
  }
};

fetch(url, options)
.then(r => r.json())
.then(r => {
  const {data} = r.data;
  const fieldsToSum = [
    "net_call_premium",
    "net_call_volume",
    "net_put_premium",
    "net_put_volume"
  ];

  let result = [];
  data.forEach((e, idx) => {
    e.net_call_premium = parseFloat(e.net_call_premium);
    e.net_put_premium = parseFloat(e.net_put_premium);
    if (idx !== 0) {
      fieldsToSum.forEach((field) => {
        e[field] = e[field] + result[idx-1][field];
      })
    }
    result.push(e);
  })

  return result;
});

GET

api

stock

{ticker}

net-prem-ticks

Call/Put Net/Vol Ticks

curl --request GET \
  --url https://api.unusualwhales.com/api/stock/{ticker}/net-prem-ticks \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.unusualwhales.com/api/stock/{ticker}/net-prem-ticks"

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/stock/{ticker}/net-prem-ticks', 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/stock/{ticker}/net-prem-ticks",
  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/stock/{ticker}/net-prem-ticks"

	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/stock/{ticker}/net-prem-ticks")

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": [
    {
      "call_volume": 1145,
      "call_volume_ask_side": 822,
      "call_volume_bid_side": 182,
      "date": "2025-03-21T00:00:00.000Z",
      "net_call_premium": "2234.00",
      "net_call_volume": 640,
      "net_delta": "26294.85817964231814400",
      "net_put_premium": "-11106.00",
      "net_put_volume": -137,
      "put_volume": 241,
      "put_volume_ask_side": 49,
      "put_volume_bid_side": 186,
      "tape_time": "2025-03-21T19:58:00.000Z"
    },
    {
      "call_volume": 1255,
      "call_volume_ask_side": 912,
      "call_volume_bid_side": 192,
      "date": "2025-03-21T00:00:00.000Z",
      "net_call_premium": "3234.00",
      "net_call_volume": 720,
      "net_delta": "28294.85817964231814400",
      "net_put_premium": "-9106.00",
      "net_put_volume": -127,
      "put_volume": 231,
      "put_volume_ask_side": 59,
      "put_volume_bid_side": 166,
      "tape_time": "2025-03-21T19:59:00.000Z"
    }
  ]
}

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

Query Parameters

date

string

A trading date in the format of YYYY-MM-DD. This is optional and by default the last trading date.

Example:

"2024-01-18T00:00:00.000Z"

Response

The net premium for each trading minute.

call_volume

integer

The sum of the size of all the call transactions that executed.

Example:

990943

call_volume_ask_side

integer

The sum of the size of all the call transactions that executed on the ask side.

Example:

417251

call_volume_bid_side

integer

The sum of the size of all the call transactions that executed on the bid side.

Example:

498271

date

string

A trading date in ISO format.

Example:

"2023-09-08T00:00:00.000Z"

net_call_premium

string

Defined as (call premium ask side) - (call premium bid side).

Example:

"-29138464"

net_call_volume

integer

Defined as (call volume ask side) - (call volume bid side).

Example:

1049

net_delta

string

Net delta

Example:

"26294.85"

net_put_premium

string

Defined as (put premium ask side) - (put premium bid side).

Example:

"23924325"

net_put_volume

integer

Defined as (put volume ask side) - (put volume bid side).

Example:

1313

put_volume

integer

The sum of the size of all the put transactions that executed.

Example:

808326

put_volume_ask_side

integer

The sum of the size of all the put transactions that executed on the ask side.

Example:

431791

put_volume_bid_side

integer

The sum of the size of all the put transactions that executed on the bid side.

Example:

314160

tape_time

string

The start time of the tick as a timestamp with timezone.

Example:

"2023-09-07T13:30:00.000Z"

Docs

Endpoints

Call/Put Net/Vol Ticks

Authorizations

Path Parameters

Query Parameters

Response