Authentication

Sign up a new user

Creates a new user account with email and password. A user profile with a random username is automatically created.

Signing up from an account import link. When a trader opens an import link (/connect?key=HP-…) and has no Hyperprop login yet, pass the same key as importKey. The confirmation email then returns the user to the import screen with the key already filled in, instead of dropping them on the dashboard to go hunt for the original link.

{
  "email": "trader@example.com",
  "password": "SecurePass123!",
  "importKey": "HP-EJB38-S8DHB-R7WBY"
}

Notes:

The key is not redeemed here. Signup only creates the login; the trader still confirms the import on the connect screen, which is where the account is actually linked.
A malformed key is ignored rather than rejected, so a bad link can never block someone from creating an account.
Because the key travels in the confirmation email, this also works when the user opens that email on a different device from the one they signed up on.
Not needed for Google sign-in — there is no confirmation email in that flow.

POST

auth

signup

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/auth/signup \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "password": "SecurePass123!",
  "importKey": "HP-EJB38-S8DHB-R7WBY"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/auth/signup"

payload = {
    "email": "user@example.com",
    "password": "SecurePass123!",
    "importKey": "HP-EJB38-S8DHB-R7WBY"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'user@example.com',
    password: 'SecurePass123!',
    importKey: 'HP-EJB38-S8DHB-R7WBY'
  })
};

fetch('https://api.hyperprop.com/platform/v1/auth/signup', 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/auth/signup",
  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([
    'email' => 'user@example.com',
    'password' => 'SecurePass123!',
    'importKey' => 'HP-EJB38-S8DHB-R7WBY'
  ]),
  CURLOPT_HTTPHEADER => [
    "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/auth/signup"

	payload := strings.NewReader("{\n  \"email\": \"user@example.com\",\n  \"password\": \"SecurePass123!\",\n  \"importKey\": \"HP-EJB38-S8DHB-R7WBY\"\n}")

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

	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/auth/signup")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"user@example.com\",\n  \"password\": \"SecurePass123!\",\n  \"importKey\": \"HP-EJB38-S8DHB-R7WBY\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/auth/signup")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"user@example.com\",\n  \"password\": \"SecurePass123!\",\n  \"importKey\": \"HP-EJB38-S8DHB-R7WBY\"\n}"

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

{
  "success": true,
  "message": "User created successfully. Please check your email to verify your account.",
  "data": {
    "user": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "user@example.com",
      "emailVerified": false
    }
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Failed to create user. Email may already be in use or invalid.",
  "code": "SIGNUP_FAILED"
}

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

Body

application/json

string

required

Example:

"user@example.com"

password

string

required

Minimum string length: 8

Example:

"SecurePass123!"

importKey

string

Account import key, when the signup started from an import link. Carried into the confirmation email so the user returns straight to the import screen after verifying. Does NOT redeem the key — the user still confirms the import explicitly.

Pattern: ^HP-[A-Za-z0-9]{5}-[A-Za-z0-9]{5}-[A-Za-z0-9]{5}$

Example:

"HP-EJB38-S8DHB-R7WBY"

Response

User created successfully

success

boolean

Example:

true

message

string

Example:

"User created successfully. Please check your email to verify your account."

data

object

Show child attributes

⌘I

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/auth/signup \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "password": "SecurePass123!",
  "importKey": "HP-EJB38-S8DHB-R7WBY"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/auth/signup"

payload = {
    "email": "user@example.com",
    "password": "SecurePass123!",
    "importKey": "HP-EJB38-S8DHB-R7WBY"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'user@example.com',
    password: 'SecurePass123!',
    importKey: 'HP-EJB38-S8DHB-R7WBY'
  })
};

fetch('https://api.hyperprop.com/platform/v1/auth/signup', 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/auth/signup",
  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([
    'email' => 'user@example.com',
    'password' => 'SecurePass123!',
    'importKey' => 'HP-EJB38-S8DHB-R7WBY'
  ]),
  CURLOPT_HTTPHEADER => [
    "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/auth/signup"

	payload := strings.NewReader("{\n  \"email\": \"user@example.com\",\n  \"password\": \"SecurePass123!\",\n  \"importKey\": \"HP-EJB38-S8DHB-R7WBY\"\n}")

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

	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/auth/signup")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"user@example.com\",\n  \"password\": \"SecurePass123!\",\n  \"importKey\": \"HP-EJB38-S8DHB-R7WBY\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/auth/signup")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"user@example.com\",\n  \"password\": \"SecurePass123!\",\n  \"importKey\": \"HP-EJB38-S8DHB-R7WBY\"\n}"

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

{
  "success": true,
  "message": "User created successfully. Please check your email to verify your account.",
  "data": {
    "user": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "user@example.com",
      "emailVerified": false
    }
  }
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Failed to create user. Email may already be in use or invalid.",
  "code": "SIGNUP_FAILED"
}

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

Platform API

Trade API

Market Data API

Sign up a new user

Body

Response