User

Create a price alert

Arms an alert on one contract at one price. The trade engine watches the last TRADE price — never the order-book mid — and fires once, then sets the alert to triggered and emails the trader.

condition defaults to crossing, which needs a real cross: the engine must have seen a price on the other side of the level first, so an alert armed at a level the market is already sitting on does not fire immediately. Use greater/less for a plain level comparison that fires on the first qualifying price.

A trader may hold 5 armed alerts; creating more returns 409.

POST

user

price-alerts

Create a price alert

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/user/price-alerts \
  --header 'Content-Type: application/json' \
  --data '
{
  "contract": "ESU6",
  "price": 5432.25,
  "condition": "crossing",
  "label": "breakout level"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/user/price-alerts"

payload = {
    "contract": "ESU6",
    "price": 5432.25,
    "condition": "crossing",
    "label": "breakout level"
}
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({
    contract: 'ESU6',
    price: 5432.25,
    condition: 'crossing',
    label: 'breakout level'
  })
};

fetch('https://api.hyperprop.com/platform/v1/user/price-alerts', 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/user/price-alerts",
  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([
    'contract' => 'ESU6',
    'price' => 5432.25,
    'condition' => 'crossing',
    'label' => 'breakout level'
  ]),
  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/user/price-alerts"

	payload := strings.NewReader("{\n  \"contract\": \"ESU6\",\n  \"price\": 5432.25,\n  \"condition\": \"crossing\",\n  \"label\": \"breakout level\"\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/user/price-alerts")
  .header("Content-Type", "application/json")
  .body("{\n  \"contract\": \"ESU6\",\n  \"price\": 5432.25,\n  \"condition\": \"crossing\",\n  \"label\": \"breakout level\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/user/price-alerts")

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  \"contract\": \"ESU6\",\n  \"price\": 5432.25,\n  \"condition\": \"crossing\",\n  \"label\": \"breakout level\"\n}"

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

{
  "success": true,
  "data": {
    "alert": {
      "id": "9f1c2e64-5a1b-4e2f-9c7a-1b2c3d4e5f60",
      "contract": "ESU6",
      "condition": "crossing",
      "price": 5432.25,
      "status": "armed",
      "label": "breakout level",
      "triggeredAt": null,
      "triggeredPrice": null,
      "createdAt": "2026-07-28T13:00:00.000Z"
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid request data",
  "code": "BAD_REQUEST"
}

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

{
  "success": false,
  "statusCode": 409,
  "message": "You already have 5 active alerts",
  "code": "PRICE_ALERT_LIMIT_REACHED"
}

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

Body

application/json

contract

string

required

Contract code as the market-data feed names it — "ESU6", "BTCUSDT" — not the product symbol "ES".

Maximum string length: 32

Example:

"ESU6"

price

number

required

Price level to watch

Example:

5432.25

condition

enum<string>

default:crossing

crossing (either direction) | crossing-up | crossing-down | greater | less

Available options:

crossing,

crossing-up,

crossing-down,

greater,

less

label

string

Optional note, included in the email

Maximum string length: 200

Example:

"breakout level"

Response

Alert armed

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Create a price alert

curl --request POST \
  --url https://api.hyperprop.com/platform/v1/user/price-alerts \
  --header 'Content-Type: application/json' \
  --data '
{
  "contract": "ESU6",
  "price": 5432.25,
  "condition": "crossing",
  "label": "breakout level"
}
'

import requests

url = "https://api.hyperprop.com/platform/v1/user/price-alerts"

payload = {
    "contract": "ESU6",
    "price": 5432.25,
    "condition": "crossing",
    "label": "breakout level"
}
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({
    contract: 'ESU6',
    price: 5432.25,
    condition: 'crossing',
    label: 'breakout level'
  })
};

fetch('https://api.hyperprop.com/platform/v1/user/price-alerts', 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/user/price-alerts",
  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([
    'contract' => 'ESU6',
    'price' => 5432.25,
    'condition' => 'crossing',
    'label' => 'breakout level'
  ]),
  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/user/price-alerts"

	payload := strings.NewReader("{\n  \"contract\": \"ESU6\",\n  \"price\": 5432.25,\n  \"condition\": \"crossing\",\n  \"label\": \"breakout level\"\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/user/price-alerts")
  .header("Content-Type", "application/json")
  .body("{\n  \"contract\": \"ESU6\",\n  \"price\": 5432.25,\n  \"condition\": \"crossing\",\n  \"label\": \"breakout level\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/user/price-alerts")

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  \"contract\": \"ESU6\",\n  \"price\": 5432.25,\n  \"condition\": \"crossing\",\n  \"label\": \"breakout level\"\n}"

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

{
  "success": true,
  "data": {
    "alert": {
      "id": "9f1c2e64-5a1b-4e2f-9c7a-1b2c3d4e5f60",
      "contract": "ESU6",
      "condition": "crossing",
      "price": 5432.25,
      "status": "armed",
      "label": "breakout level",
      "triggeredAt": null,
      "triggeredPrice": null,
      "createdAt": "2026-07-28T13:00:00.000Z"
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid request data",
  "code": "BAD_REQUEST"
}

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

{
  "success": false,
  "statusCode": 409,
  "message": "You already have 5 active alerts",
  "code": "PRICE_ALERT_LIMIT_REACHED"
}

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

Platform API

Trade API

Market Data API

Create a price alert

Body

Response