Aggregate sentiment scoring across timeframes (VWF / SDF / FIR / Composite)

curl --request GET \
  --url https://flow-api.skylit.ai/v1/aggregate/{ticker} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://flow-api.skylit.ai/v1/aggregate/{ticker}', 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://flow-api.skylit.ai/v1/aggregate/{ticker}",
  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://flow-api.skylit.ai/v1/aggregate/{ticker}"

	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://flow-api.skylit.ai/v1/aggregate/{ticker}")

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": {
    "ticker": "<string>",
    "generatedAt": "2023-11-07T05:31:56Z",
    "byTimeframe": {},
    "trend": {
      "description": "<string>"
    },
    "byMoneyness": [
      {
        "composite": 123,
        "tradeCount": 1,
        "premium": 123,
        "pctOfTotal": 123
      }
    ]
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "d7574836"
  }
}

GET

aggregate

{ticker}

Aggregate sentiment scoring across timeframes (VWF / SDF / FIR / Composite)

curl --request GET \
  --url https://flow-api.skylit.ai/v1/aggregate/{ticker} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://flow-api.skylit.ai/v1/aggregate/{ticker}', 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://flow-api.skylit.ai/v1/aggregate/{ticker}",
  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://flow-api.skylit.ai/v1/aggregate/{ticker}"

	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://flow-api.skylit.ai/v1/aggregate/{ticker}")

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": {
    "ticker": "<string>",
    "generatedAt": "2023-11-07T05:31:56Z",
    "byTimeframe": {},
    "trend": {
      "description": "<string>"
    },
    "byMoneyness": [
      {
        "composite": 123,
        "tradeCount": 1,
        "premium": 123,
        "pctOfTotal": 123
      }
    ]
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "d7574836"
  }
}

Authorizations

Authorization

string

header

required

Skylit API key in the Authorization header (Authorization: Bearer fs_live_<key>). X-API-Key is also accepted.

Path Parameters

ticker

string

required

Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Example:

"SPY"

Query Parameters

timeframes

string

default:1d

Comma-separated timeframes, or all. Supported atoms: 1h, 4h, 1d, 7d, 30d, 90d. all expands to all six. Unknown atoms are treated as a single trading day.

Example:

"1d,7d,30d"

include_breakdown

boolean

default:true

Attach the per-timeframe VWF/SDF/FIR component split.

include_moneyness

boolean

default:false

Attach a byMoneyness array (deep_itm → deep_otm).

moneyness_filter

enum<string>

default:all

Available options:

deep_itm,

itm,

atm,

otm,

deep_otm,

all

expiration_filter

enum<string>

default:all

Restrict to one expiration bucket.

Available options:

0dte,

weekly,

monthly,

leaps,

all

time_decay

boolean

default:false

Apply exponential time decay to VWF / SDF / FIR components.

time_decay_half_life

integer

default:30

Half-life in minutes for the decay (only applied when timeDecay=true).

Required range: x >= 1

date

string<date>

Response

Aggregate sentiment by timeframe.

data

object

required

Show child attributes

Flow

Sector

Market

Sweeps

Analytics

Scoring

Ratios

Underlying

Contract

Dark Pool

Meta

Aggregate sentiment scoring across timeframes (VWF / SDF / FIR / Composite)

Authorizations

Path Parameters

Query Parameters

Response