Recent flows

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

import requests

url = "https://api.unusualwhales.com/api/stock/{ticker}/flow-recent"

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}/flow-recent', 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}/flow-recent",
  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}/flow-recent"

	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}/flow-recent")

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_otm_premium": "3885339",
      "call_otm_trades": 10213,
      "call_otm_volume": 81598,
      "call_premium": "5839180",
      "call_premium_ask_side": "2615356",
      "call_premium_bid_side": "2722619",
      "call_trades": 11383,
      "call_volume": 89177,
      "call_volume_ask_side": 43669,
      "call_volume_bid_side": 40164,
      "date": "2024-01-22T00:00:00.000Z",
      "expiry": "2024-01-26T00:00:00.000Z",
      "put_otm_premium": "632247",
      "put_otm_trades": 2077,
      "put_otm_volume": 12164,
      "put_premium": "4802145",
      "put_premium_ask_side": "3593584",
      "put_premium_bid_side": "690572",
      "put_trades": 2744,
      "put_volume": 20101,
      "put_volume_ask_side": 7396,
      "put_volume_bid_side": 8113,
      "ticker": "BABA"
    },
    {
      "call_otm_premium": "1264038",
      "call_otm_trades": 2550,
      "call_otm_volume": 17525,
      "call_premium": "1869073",
      "call_premium_ask_side": "885103",
      "call_premium_bid_side": "832727",
      "call_trades": 2936,
      "call_volume": 19268,
      "call_volume_ask_side": 7778,
      "call_volume_bid_side": 9875,
      "date": "2024-01-22T00:00:00.000Z",
      "expiry": "2024-02-02T00:00:00.000Z",
      "put_otm_premium": "206709",
      "put_otm_trades": 588,
      "put_otm_volume": 3581,
      "put_premium": "627117",
      "put_premium_ask_side": "191982",
      "put_premium_bid_side": "354687",
      "put_trades": 847,
      "put_volume": 4709,
      "put_volume_ask_side": 1238,
      "put_volume_bid_side": 3004,
      "ticker": "BABA"
    }
  ],
  "date": "2024-01-22T00:00: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

Recent flows

Returns the latest flows for the given ticker. Optionally a min premium and a side can be supplied in the query for further filtering.

For real time streaming of option trades for a ticker, subscribe to the option_trades:<TICKER> websocket channel, see https://api.unusualwhales.com/docs/websocket/option-trades.

For CBOE index tickers such as SPX or VIX the index price is returned as null and the row is marked missing_periscope. If the request filters with min_underlying_price, max_underlying_price, min_stock_price, max_stock_price, min_diff, max_diff, min_implied_move, max_implied_move, min_return_on_capital, max_return_on_capital, min_return_on_capital_perc or max_return_on_capital_perc, rows for these index tickers are left out of the response. CBOE index prices require provisioned access and CBOE approval. Contact [email protected], [email protected] or [email protected] to request access.

GET

api

stock

{ticker}

flow-recent

Recent flows

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

import requests

url = "https://api.unusualwhales.com/api/stock/{ticker}/flow-recent"

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}/flow-recent', 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}/flow-recent",
  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}/flow-recent"

	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}/flow-recent")

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_otm_premium": "3885339",
      "call_otm_trades": 10213,
      "call_otm_volume": 81598,
      "call_premium": "5839180",
      "call_premium_ask_side": "2615356",
      "call_premium_bid_side": "2722619",
      "call_trades": 11383,
      "call_volume": 89177,
      "call_volume_ask_side": 43669,
      "call_volume_bid_side": 40164,
      "date": "2024-01-22T00:00:00.000Z",
      "expiry": "2024-01-26T00:00:00.000Z",
      "put_otm_premium": "632247",
      "put_otm_trades": 2077,
      "put_otm_volume": 12164,
      "put_premium": "4802145",
      "put_premium_ask_side": "3593584",
      "put_premium_bid_side": "690572",
      "put_trades": 2744,
      "put_volume": 20101,
      "put_volume_ask_side": 7396,
      "put_volume_bid_side": 8113,
      "ticker": "BABA"
    },
    {
      "call_otm_premium": "1264038",
      "call_otm_trades": 2550,
      "call_otm_volume": 17525,
      "call_premium": "1869073",
      "call_premium_ask_side": "885103",
      "call_premium_bid_side": "832727",
      "call_trades": 2936,
      "call_volume": 19268,
      "call_volume_ask_side": 7778,
      "call_volume_bid_side": 9875,
      "date": "2024-01-22T00:00:00.000Z",
      "expiry": "2024-02-02T00:00:00.000Z",
      "put_otm_premium": "206709",
      "put_otm_trades": 588,
      "put_otm_volume": 3581,
      "put_premium": "627117",
      "put_premium_ask_side": "191982",
      "put_premium_bid_side": "354687",
      "put_trades": 847,
      "put_volume": 4709,
      "put_volume_ask_side": 1238,
      "put_volume_bid_side": 3004,
      "ticker": "BABA"
    }
  ],
  "date": "2024-01-22T00:00: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

side

enum<string>

default:ALL

The side of a stock trade. Must be one of ASK, BID, MID. If not set, will return all side's trades.

Available options:

ALL,

ASK,

BID,

MID

Example:

"ASK"

min_premium

integer

default:0

The minimum premium requested trades should have.

Required range: x >= 0

Example:

50000

Response

The flow data per expiry for a trading day.

call_otm_premium

string

The sum of the premium of all the out the money (OTM) call transactions that executed.

Example:

"9908777.0"

call_otm_trades

integer

The amount of out the money (OTM) call transactions that executed.

Example:

6338

call_otm_volume

integer

The sum of the size of all the out the money (OTM) call transactions that executed.

Example:

40385

call_premium

string

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

Example:

"9908777.0"

call_premium_ask_side

string

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

Example:

"5037703.0"

call_premium_bid_side

string

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

Example:

"4055973.0"

call_trades

integer

The amount of call transactions that executed.

Example:

6338

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"

expiry

string

The contract expiry date in ISO format.

Example:

"2023-12-22T00:00:00.000Z"

put_otm_premium

string

The sum of the premium of all the out the money (OTM) put transactions that executed.

Example:

"1204570.0"

put_otm_trades

integer

The amount of out the money (OTM) put transactions that executed.

Example:

4270

put_otm_volume

integer

The sum of the size of all the out the money (OTM) put transactions that executed.

Example:

12638

put_premium

string

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

Example:

"163537151"

put_premium_ask_side

string

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

Example:

"799873.0"

put_premium_bid_side

string

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

Example:

"4055973.0"

put_trades

integer

The amount of put transactions that executed.

Example:

841

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

ticker

string

The stock ticker.

Example:

"AAPL"

Docs

Endpoints

Recent flows

Authorizations

Path Parameters

Query Parameters

Response