Skip to main content
GET
List stored trading patterns

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

report
enum<string>
default:hedge_pairs

Which kind of pattern

Available options:
hedge_pairs,
self_hedges,
copy_pairs,
copy_groups
days
integer
default:7

Trading days to include, 1 to 90

Required range: 1 <= x <= 90
minLevel
enum<string>
default:low

Lowest finding level to include

Available options:
low,
medium,
high
sort
enum<string>
default:level

Order of the rows

Available options:
level,
recent,
count
offset
integer
default:0

Rows to skip

Required range: 0 <= x <= 100000
limit
integer
default:50

Rows per page, at most 100

Required range: 1 <= x <= 100

Response

One page of patterns

success
boolean
Example:

true

data
object