Skip to main content
GET
/
v3
/
perps
/
flow
/
{instrument}
Trade flow / CVD
curl --request GET \
  --url https://api.polynode.dev/v3/perps/flow/{instrument} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.polynode.dev/v3/perps/flow/{instrument}"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.polynode.dev/v3/perps/flow/{instrument}', 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.polynode.dev/v3/perps/flow/{instrument}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$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.polynode.dev/v3/perps/flow/{instrument}"

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

req.Header.Add("x-api-key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.polynode.dev/v3/perps/flow/{instrument}")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.polynode.dev/v3/perps/flow/{instrument}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "instrument_id": 6,
  "symbol": "BTC-USD",
  "bucket": "1h",
  "data": [
    {
      "timestamp": 1783612800000,
      "buy_notional": "69650.25",
      "sell_notional": "50066.44",
      "net_qty": "0.31442",
      "cvd": "0.314420",
      "trades": 417
    }
  ]
}
Order-flow analytics per time bucket: taker buy vs sell notional, net quantity, and the running cumulative volume delta (CVD) — a classic pressure signal. side is the taker’s direction (long = bought). Choose bucket (1m to 1d) and bound with after / before.

Authorizations

x-api-key
string
header
required

Path Parameters

instrument
string
required

Instrument id (6), symbol (BTC-USD), or bare asset (btc).

Query Parameters

bucket
string

1m, 5m, 15m, 1h, 4h, 1d (default 1h)

after
string

Only rows after this time (Unix s or ms).

before
string

Only rows before this time (Unix s or ms).

limit
integer

Max rows.

Response

200 - application/json

Success