Skip to main content
GET
Get traders linked by a shared device or IP address

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Headers

If-None-Match
string

Optional. The ETag of the answer you already have. When the answer would be the same, the response is 304 without a body.

Query Parameters

days
integer
default:30

Look back this many days, 1–90

Required range: 1 <= x <= 90
signal
enum<string>
default:all

device: only shared devices; ip: only shared IP addresses; all: both

Available options:
all,
device,
ip
minTraders
integer
default:2

Only groups with at least this many traders

Required range: 2 <= x <= 50
maxTradersPerSignal
integer
default:10

Leave out a device or IP address used by more traders than this (mobile carriers, VPNs, offices); listed in noisySignals instead

Required range: 2 <= x <= 50
limit
integer
default:100

Most groups to return

Required range: 1 <= x <= 500

Response

Groups of linked traders with the shared devices and IP addresses and their accounts

success
boolean
Example:

true

data
object