Organization

Bulk-create unlinked accounts with import keys

Create up to 100 unlinked accounts in one call — for giveaways, competitions, or pre-provisioning inventory.

Every account is created with:

no trader attached (userId: null)
its own one-time importKey (serial-key style, e.g. HP-7K3QF-9XT2M-4WHRD)
not_started status
no billing and no CME entitlement — both start only when a key is redeemed

Hand each importKey to a customer; they redeem it inside the Hyperprop app under Trading Accounts → Import. Each redemption fires an account.imported webhook with the redeemer’s email, the key, and a timestamp — your verification trail.

customerIdPrefix is required: each account gets a sequential customerId (promo-summer-001, promo-summer-002, …) you can query later via GET /trading-accounts?customerId=....

Soulbound note: identity bindings are keyed on customerId, and sequential prefix ids give every account a different placeholder customer — right for giveaways where each key goes to a different winner (each redemption creates its own binding). If several accounts in a batch are for the SAME customer, PATCH their customerId to that customer’s real ID after creation so all their imports enforce one shared Hyperprop login.

List remaining unredeemed accounts (keys included) anytime with GET /trading-accounts?unlinked=true.

An account.created webhook fires for each account with data.importKey, data.metadata.unlinked: true, and a shared batch_id.

Permissions: organization admins only.

Error codes: VALIDATION_ERROR, PLAN_NOT_FOUND, PLAN_NOT_ACTIVE, NO_TRADING_RULE, RULE_NOT_FOUND, BULK_CREATE_ERROR.

POST

organization

trading-accounts

bulk

Bulk-create unlinked accounts with import keys

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "count": 25,
  "type": "evaluation",
  "tradingPlanId": "550e8400-e29b-41d4-a716-446655440000",
  "tradingRuleId": "<string>",
  "initialBalance": 50000,
  "customerIdPrefix": "promo-summer",
  "externalRefPrefix": "promo-summer",
  "metadata": {
    "campaign": "summer-giveaway"
  }
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk"

payload = {
    "count": 25,
    "type": "evaluation",
    "tradingPlanId": "550e8400-e29b-41d4-a716-446655440000",
    "tradingRuleId": "<string>",
    "initialBalance": 50000,
    "customerIdPrefix": "promo-summer",
    "externalRefPrefix": "promo-summer",
    "metadata": { "campaign": "summer-giveaway" }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    count: 25,
    type: 'evaluation',
    tradingPlanId: '550e8400-e29b-41d4-a716-446655440000',
    tradingRuleId: '<string>',
    initialBalance: 50000,
    customerIdPrefix: 'promo-summer',
    externalRefPrefix: 'promo-summer',
    metadata: {campaign: 'summer-giveaway'}
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk', 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/trading-accounts/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'count' => 25,
    'type' => 'evaluation',
    'tradingPlanId' => '550e8400-e29b-41d4-a716-446655440000',
    'tradingRuleId' => '<string>',
    'initialBalance' => 50000,
    'customerIdPrefix' => 'promo-summer',
    'externalRefPrefix' => 'promo-summer',
    'metadata' => [
        'campaign' => 'summer-giveaway'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk"

	payload := strings.NewReader("{\n  \"count\": 25,\n  \"type\": \"evaluation\",\n  \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"tradingRuleId\": \"<string>\",\n  \"initialBalance\": 50000,\n  \"customerIdPrefix\": \"promo-summer\",\n  \"externalRefPrefix\": \"promo-summer\",\n  \"metadata\": {\n    \"campaign\": \"summer-giveaway\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"count\": 25,\n  \"type\": \"evaluation\",\n  \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"tradingRuleId\": \"<string>\",\n  \"initialBalance\": 50000,\n  \"customerIdPrefix\": \"promo-summer\",\n  \"externalRefPrefix\": \"promo-summer\",\n  \"metadata\": {\n    \"campaign\": \"summer-giveaway\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"count\": 25,\n  \"type\": \"evaluation\",\n  \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"tradingRuleId\": \"<string>\",\n  \"initialBalance\": 50000,\n  \"customerIdPrefix\": \"promo-summer\",\n  \"externalRefPrefix\": \"promo-summer\",\n  \"metadata\": {\n    \"campaign\": \"summer-giveaway\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "25 unlinked account(s) created — hand each importKey to its trader",
  "data": {
    "batchId": "<string>",
    "created": 25,
    "tradingPlan": {
      "id": "<string>",
      "name": "<string>"
    },
    "tradingRule": {
      "id": "<string>",
      "name": "<string>"
    },
    "accounts": [
      {
        "id": "<string>",
        "accountNumber": "<string>",
        "customerId": "promo-summer-001",
        "externalRef": "<string>",
        "importKey": "HP-7K3QF-9XT2M-4WHRD"
      }
    ]
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Validation failed",
  "code": "VALIDATION_ERROR"
}

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

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Only organization admins can perform this action",
  "code": "NOT_ADMIN"
}

{
  "success": false,
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading plan not found",
  "code": "PLAN_NOT_FOUND"
}

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

Authorizations

Authorization

string

header

required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Body

application/json

count

integer

required

How many unlinked accounts to create (1-100 per call)

Required range: 1 <= x <= 100

Example:

25

type

enum<string>

required

Account type for every account in the batch

Available options:

evaluation,

sim_funded,

competition

Example:

"evaluation"

tradingPlanId

string

required

Trading plan for every account in the batch

Example:

"550e8400-e29b-41d4-a716-446655440000"

tradingRuleId

string

Override the plan's default rule (optional)

initialBalance

number

Starting balance (defaults to the plan's account size)

Example:

50000

customerIdPrefix

string

REQUIRED. Each account gets customerId {prefix}-001, {prefix}-002, ... — one placeholder customer per account (right for giveaways where every key goes to a different winner). PATCH the real customerId onto an account once you know who it belongs to.

Maximum string length: 200

Example:

"promo-summer"

externalRefPrefix

string

DEPRECATED alias for customerIdPrefix — accepted for backward compatibility only.

Maximum string length: 200

Example:

"promo-summer"

metadata

object

Custom metadata applied to every account in the batch

Example:

{ "campaign": "summer-giveaway" }

Response

Success - batch created

success

boolean

Example:

true

message

string

Example:

"25 unlinked account(s) created — hand each importKey to its trader"

data

object

Show child attributes

⌘I

Bulk-create unlinked accounts with import keys

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "count": 25,
  "type": "evaluation",
  "tradingPlanId": "550e8400-e29b-41d4-a716-446655440000",
  "tradingRuleId": "<string>",
  "initialBalance": 50000,
  "customerIdPrefix": "promo-summer",
  "externalRefPrefix": "promo-summer",
  "metadata": {
    "campaign": "summer-giveaway"
  }
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk"

payload = {
    "count": 25,
    "type": "evaluation",
    "tradingPlanId": "550e8400-e29b-41d4-a716-446655440000",
    "tradingRuleId": "<string>",
    "initialBalance": 50000,
    "customerIdPrefix": "promo-summer",
    "externalRefPrefix": "promo-summer",
    "metadata": { "campaign": "summer-giveaway" }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    count: 25,
    type: 'evaluation',
    tradingPlanId: '550e8400-e29b-41d4-a716-446655440000',
    tradingRuleId: '<string>',
    initialBalance: 50000,
    customerIdPrefix: 'promo-summer',
    externalRefPrefix: 'promo-summer',
    metadata: {campaign: 'summer-giveaway'}
  })
};

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk', 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/trading-accounts/bulk",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'count' => 25,
    'type' => 'evaluation',
    'tradingPlanId' => '550e8400-e29b-41d4-a716-446655440000',
    'tradingRuleId' => '<string>',
    'initialBalance' => 50000,
    'customerIdPrefix' => 'promo-summer',
    'externalRefPrefix' => 'promo-summer',
    'metadata' => [
        'campaign' => 'summer-giveaway'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk"

	payload := strings.NewReader("{\n  \"count\": 25,\n  \"type\": \"evaluation\",\n  \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"tradingRuleId\": \"<string>\",\n  \"initialBalance\": 50000,\n  \"customerIdPrefix\": \"promo-summer\",\n  \"externalRefPrefix\": \"promo-summer\",\n  \"metadata\": {\n    \"campaign\": \"summer-giveaway\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"count\": 25,\n  \"type\": \"evaluation\",\n  \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"tradingRuleId\": \"<string>\",\n  \"initialBalance\": 50000,\n  \"customerIdPrefix\": \"promo-summer\",\n  \"externalRefPrefix\": \"promo-summer\",\n  \"metadata\": {\n    \"campaign\": \"summer-giveaway\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/bulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"count\": 25,\n  \"type\": \"evaluation\",\n  \"tradingPlanId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"tradingRuleId\": \"<string>\",\n  \"initialBalance\": 50000,\n  \"customerIdPrefix\": \"promo-summer\",\n  \"externalRefPrefix\": \"promo-summer\",\n  \"metadata\": {\n    \"campaign\": \"summer-giveaway\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "25 unlinked account(s) created — hand each importKey to its trader",
  "data": {
    "batchId": "<string>",
    "created": 25,
    "tradingPlan": {
      "id": "<string>",
      "name": "<string>"
    },
    "tradingRule": {
      "id": "<string>",
      "name": "<string>"
    },
    "accounts": [
      {
        "id": "<string>",
        "accountNumber": "<string>",
        "customerId": "promo-summer-001",
        "externalRef": "<string>",
        "importKey": "HP-7K3QF-9XT2M-4WHRD"
      }
    ]
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Validation failed",
  "code": "VALIDATION_ERROR"
}

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

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Only organization admins can perform this action",
  "code": "NOT_ADMIN"
}

{
  "success": false,
  "statusCode": 404,
  "error": "Not Found",
  "message": "Trading plan not found",
  "code": "PLAN_NOT_FOUND"
}

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

Platform API

Trade API

Market Data API

Bulk-create unlinked accounts with import keys

Authorizations

Body

Response