Create a condition monitor

curl --request POST \
  --url https://allocait.app/api/v1/monitors \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "portfolio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "input_1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input_2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "threshold_pct": 123,
  "conditions": [
    {
      "input_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>"
    }
  ],
  "source_type": "positions",
  "ticker_symbol": "<string>",
  "source_watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_symbols": [
    "<string>"
  ]
}
'

import requests

url = "https://allocait.app/api/v1/monitors"

payload = {
    "portfolio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "input_1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input_2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "threshold_pct": 123,
    "conditions": [
        {
            "input_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "value": "<string>"
        }
    ],
    "source_type": "positions",
    "ticker_symbol": "<string>",
    "source_watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_symbols": ["<string>"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    portfolio_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    input_1_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    input_2_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    threshold_pct: 123,
    conditions: [{input_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'}],
    source_type: 'positions',
    ticker_symbol: '<string>',
    source_watchlist_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    custom_symbols: ['<string>']
  })
};

fetch('https://allocait.app/api/v1/monitors', 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://allocait.app/api/v1/monitors",
  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([
    'portfolio_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'input_1_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'input_2_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'threshold_pct' => 123,
    'conditions' => [
        [
                'input_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'value' => '<string>'
        ]
    ],
    'source_type' => 'positions',
    'ticker_symbol' => '<string>',
    'source_watchlist_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'custom_symbols' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://allocait.app/api/v1/monitors"

	payload := strings.NewReader("{\n  \"portfolio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"input_1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input_2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threshold_pct\": 123,\n  \"conditions\": [\n    {\n      \"input_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"source_type\": \"positions\",\n  \"ticker_symbol\": \"<string>\",\n  \"source_watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_symbols\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("x-api-key", "<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://allocait.app/api/v1/monitors")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"portfolio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"input_1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input_2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threshold_pct\": 123,\n  \"conditions\": [\n    {\n      \"input_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"source_type\": \"positions\",\n  \"ticker_symbol\": \"<string>\",\n  \"source_watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_symbols\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://allocait.app/api/v1/monitors")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"portfolio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"input_1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input_2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threshold_pct\": 123,\n  \"conditions\": [\n    {\n      \"input_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"source_type\": \"positions\",\n  \"ticker_symbol\": \"<string>\",\n  \"source_watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_symbols\": [\n    \"<string>\"\n  ]\n}"

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

{
  "success": true,
  "monitor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "monitor": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "portfolio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "comparison_mode": "ABOVE",
    "input_1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input_2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "threshold_pct": 123,
    "conditions": [
      {
        "input_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value": "<string>"
      }
    ],
    "source_type": "positions",
    "ticker_symbol": "<string>",
    "source_watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_symbols": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Internal error",
  "error_code": "INTERNAL_ERROR",
  "request_id": "5b1e7c52-3f4a-4d0e-9a55-2d5cbe6f0a11"
}

Monitors

Create a condition monitor

A condition monitor watches a recorded level (or range, in RANGE mode) against a symbol source. Requires the data_monitors feature entitlement (an Advanced plan, trial included). input_1_id (and input_2_id for RANGE mode) must be Input definitions belonging to the caller. Allocait computes no bound itself, it only watches what the user recorded. source_watchlist_id is required when source_type is watchlist and must belong to the caller; ticker_symbol is required when source_type is single; custom_symbols is required when source_type is custom.

This configures the monitor itself. Its configuration and recorded levels are read back through GET /monitors; a priced reading is the monitors key on POST /portfolio/snapshot at the prices you pass (ADR-026, ADR-036). Neither is changed by this endpoint.

Requires the API key to have the write permission.

POST

monitors

Create a condition monitor

curl --request POST \
  --url https://allocait.app/api/v1/monitors \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "portfolio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "input_1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input_2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "threshold_pct": 123,
  "conditions": [
    {
      "input_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>"
    }
  ],
  "source_type": "positions",
  "ticker_symbol": "<string>",
  "source_watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_symbols": [
    "<string>"
  ]
}
'

import requests

url = "https://allocait.app/api/v1/monitors"

payload = {
    "portfolio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "input_1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input_2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "threshold_pct": 123,
    "conditions": [
        {
            "input_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "value": "<string>"
        }
    ],
    "source_type": "positions",
    "ticker_symbol": "<string>",
    "source_watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_symbols": ["<string>"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    portfolio_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    input_1_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    input_2_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    threshold_pct: 123,
    conditions: [{input_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'}],
    source_type: 'positions',
    ticker_symbol: '<string>',
    source_watchlist_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    custom_symbols: ['<string>']
  })
};

fetch('https://allocait.app/api/v1/monitors', 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://allocait.app/api/v1/monitors",
  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([
    'portfolio_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'input_1_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'input_2_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'threshold_pct' => 123,
    'conditions' => [
        [
                'input_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'value' => '<string>'
        ]
    ],
    'source_type' => 'positions',
    'ticker_symbol' => '<string>',
    'source_watchlist_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'custom_symbols' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://allocait.app/api/v1/monitors"

	payload := strings.NewReader("{\n  \"portfolio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"input_1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input_2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threshold_pct\": 123,\n  \"conditions\": [\n    {\n      \"input_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"source_type\": \"positions\",\n  \"ticker_symbol\": \"<string>\",\n  \"source_watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_symbols\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("x-api-key", "<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://allocait.app/api/v1/monitors")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"portfolio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"input_1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input_2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threshold_pct\": 123,\n  \"conditions\": [\n    {\n      \"input_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"source_type\": \"positions\",\n  \"ticker_symbol\": \"<string>\",\n  \"source_watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_symbols\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://allocait.app/api/v1/monitors")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"portfolio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"input_1_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"input_2_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"threshold_pct\": 123,\n  \"conditions\": [\n    {\n      \"input_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"source_type\": \"positions\",\n  \"ticker_symbol\": \"<string>\",\n  \"source_watchlist_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"custom_symbols\": [\n    \"<string>\"\n  ]\n}"

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

{
  "success": true,
  "monitor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "monitor": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "portfolio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "comparison_mode": "ABOVE",
    "input_1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "input_2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "threshold_pct": 123,
    "conditions": [
      {
        "input_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value": "<string>"
      }
    ],
    "source_type": "positions",
    "ticker_symbol": "<string>",
    "source_watchlist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_symbols": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Portfolio not found or access denied",
  "error_code": "NOT_FOUND"
}

{
  "error": "Internal error",
  "error_code": "INTERNAL_ERROR",
  "request_id": "5b1e7c52-3f4a-4d0e-9a55-2d5cbe6f0a11"
}

Authorizations

x-api-key

string

header

required

Raw API key shown once when created in the Allocait app (Settings > API keys). Send it verbatim in this header; the server stores and compares only its SHA-256 hash. Allocait generates every key: alc_ followed by 64 lowercase hex characters. Keys issued before 2026-10-10 are 64 hex characters with no prefix and keep working. A key may carry an expiry (90 days or 1 year, or never). A malformed, unknown, revoked or expired key gets 401 with no further detail, and a malformed one is refused before any lookup. Keys cannot be created through this API.

Body

application/json

portfolio_id

string<uuid>

required

name

string

required

input_1_id

string<uuid>

required

The Input definition holding the recorded level (or lower bound, in RANGE mode).

comparison_mode

enum<string> | null

At the daily close, ABOVE breaks on a close above the recorded level, BELOW on a close below it and RANGE on a close outside the range. NEAR has no close event (ADR-020).

Available options:

ABOVE,

BELOW,

NEAR,

RANGE,

null

input_2_id

string<uuid> | null

The Input definition holding the upper bound, for RANGE mode.

threshold_pct

number | null

Percent-distance warning threshold (near_high/near_low or near_level). Without it no near_* state is reported.

conditions

object[] | null

Display only. The app shows each symbol as Met or Not met; no row is filtered and no event reads them.

Show child attributes

source_type

enum<string>

default:positions

Available options:

positions,

watchlist,

single,

custom

ticker_symbol

string | null

source_watchlist_id

string<uuid> | null

custom_symbols

string[] | null

Response

The condition monitor was created

success

boolean

monitor_id

string<uuid>

monitor

object

The full monitor record, as returned by create/update; the monitor's own configuration, not its recorded levels for a resolved symbol (see ConditionMonitorData for that).

Show child attributes

Start

Conventions

Errors

Webhooks

Endpoints

Create a condition monitor

Authorizations

Body

Response