Skip to main content
GET
List trader identity bindings (customer ⇄ Hyperprop login)

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.

Query Parameters

customerId
string

Exact match on your customer ID

Maximum string length: 255
externalRef
string

DEPRECATED alias for customerId — use customerId instead.

Maximum string length: 255
email
string

Partial match on the bound Hyperprop login email

page
integer
default:1

Page number, starting at 1

Required range: x >= 1
limit
integer
default:25

Page size (1-100)

Required range: 1 <= x <= 100

Response

Success

success
boolean
Example:

true

data
object