Traders

List trader identity bindings (customer ⇄ Hyperprop login)

One firm customer, one Hyperprop login. A binding pins the customerId you set on your accounts to a single Hyperprop login.

How bindings are created (automatic):

Unassigned accounts: the customer redeems the import key with their Hyperprop login, and a binding customerId ⇄ their Hyperprop login is stored — you receive the login email in the account.imported webhook (import.importedEmail) and on the org WebSocket stream, so you can attach it to the customer’s profile on your side.
Directly-linked accounts (traderId/email): the binding is created at account creation (boundVia: "api").

What bindings enforce: Every later import for the same customerId must use the SAME Hyperprop login — a different login gets 409 TRADER_ALREADY_BOUND with a masked hint of the correct email. Likewise, creating a directly-linked account for a bound customer with a different traderId/email is refused with 409 CUSTOMER_ALREADY_BOUND. This stops customers from scattering accounts across multiple Hyperprop identities.

Since customerId is required on every account, every customer is soulbound from their first account onwards.

Bindings are scoped to YOUR organization only. They never restrict what your customer does at other prop firms: the same Hyperprop login can hold accounts from any number of firms (each firm gets its own binding), and a customer of another firm is free to use a different Hyperprop login there. The rule is strictly: one customer of yours = one Hyperprop login for your accounts.

Support flow (customer lost their Hyperprop login): rebind the customer with POST /trader-bindings/{bindingId}/rebind ({ "email": "their-new-login@..." }). There is no plain release — a customer always has exactly one bound login. Rebinding fails every still-active account on the old login (with an account.failed webhook per account) so the old identity can never trade again; terminal accounts keep their history.

Permissions: any organization member (or API key).

GET

organization

trader-bindings

List trader identity bindings (customer ⇄ Hyperprop login)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/trader-bindings \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/trader-bindings', 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.hyperprop.com/platform/v1/organization/trader-bindings",
  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.hyperprop.com/platform/v1/organization/trader-bindings"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trader-bindings")

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

{
  "success": true,
  "data": {
    "bindings": [
      {
        "id": "a3a3d7c1-...",
        "organizationId": "<string>",
        "customerId": "acme-cust-4471",
        "userId": "<string>",
        "email": "trader@example.com",
        "boundAt": "<string>",
        "boundVia": "import"
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "limit": 25
    }
  }
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

X-API-Key

string

header

required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

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

string

Partial match on the bound Hyperprop login email

page

integer

default:1

Required range: x >= 1

limit

integer

default:25

Required range: 1 <= x <= 100

Response

Success

success

boolean

Example:

true

data

object

Show child attributes

⌘I

List trader identity bindings (customer ⇄ Hyperprop login)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/trader-bindings \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/trader-bindings', 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.hyperprop.com/platform/v1/organization/trader-bindings",
  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.hyperprop.com/platform/v1/organization/trader-bindings"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trader-bindings")

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

{
  "success": true,
  "data": {
    "bindings": [
      {
        "id": "a3a3d7c1-...",
        "organizationId": "<string>",
        "customerId": "acme-cust-4471",
        "userId": "<string>",
        "email": "trader@example.com",
        "boundAt": "<string>",
        "boundVia": "import"
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "limit": 25
    }
  }
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

List trader identity bindings (customer ⇄ Hyperprop login)

Authorizations

Query Parameters

Response