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 loginis stored — you receive the login email in theaccount.importedwebhook (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.
The reverse is not enforced on import: a login already bound to one of your customers can still import an account of a different customer of yours, and is then bound to both. The account.imported webhook flags this with import.loginAlreadyBoundToOtherCustomer: true and lists the other customerIds in import.otherBoundCustomerIds, so you can review shared logins. (A rebind does enforce it: 409 NEW_LOGIN_ALREADY_BOUND.)
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: requires view access to “Traders & accounts” (or API key).
Access: read-only and full-access API keys. Dashboard members need view access to Traders & accounts.
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/trader-bindings \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trader-bindings"
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.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))
}HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/trader-bindings")
.header("X-API-Key", "<api-key>")
.asString();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": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}Authorizations
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
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/trader-bindings \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trader-bindings"
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.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))
}HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/trader-bindings")
.header("X-API-Key", "<api-key>")
.asString();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": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}