Check a proposed change against the rules

curl --request POST \
  --url https://allocait.app/api/v1/trades/check \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "portfolio_id": "6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10",
  "trades": [
    {
      "symbol": "ALFA",
      "side": "BUY",
      "shares": 40
    },
    {
      "symbol": "GOLF",
      "side": "SELL",
      "shares": 10
    }
  ],
  "prices": {
    "ALFA": 181.5,
    "BRAV": 98.1,
    "ECHO": 41.6,
    "GOLF": 62.3
  }
}
'

import requests

url = "https://allocait.app/api/v1/trades/check"

payload = {
    "portfolio_id": "6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10",
    "trades": [
        {
            "symbol": "ALFA",
            "side": "BUY",
            "shares": 40
        },
        {
            "symbol": "GOLF",
            "side": "SELL",
            "shares": 10
        }
    ],
    "prices": {
        "ALFA": 181.5,
        "BRAV": 98.1,
        "ECHO": 41.6,
        "GOLF": 62.3
    }
}
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: '6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10',
    trades: [
      {symbol: 'ALFA', side: 'BUY', shares: 40},
      {symbol: 'GOLF', side: 'SELL', shares: 10}
    ],
    prices: {ALFA: 181.5, BRAV: 98.1, ECHO: 41.6, GOLF: 62.3}
  })
};

fetch('https://allocait.app/api/v1/trades/check', 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/trades/check",
  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' => '6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10',
    'trades' => [
        [
                'symbol' => 'ALFA',
                'side' => 'BUY',
                'shares' => 40
        ],
        [
                'symbol' => 'GOLF',
                'side' => 'SELL',
                'shares' => 10
        ]
    ],
    'prices' => [
        'ALFA' => 181.5,
        'BRAV' => 98.1,
        'ECHO' => 41.6,
        'GOLF' => 62.3
    ]
  ]),
  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/trades/check"

	payload := strings.NewReader("{\n  \"portfolio_id\": \"6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10\",\n  \"trades\": [\n    {\n      \"symbol\": \"ALFA\",\n      \"side\": \"BUY\",\n      \"shares\": 40\n    },\n    {\n      \"symbol\": \"GOLF\",\n      \"side\": \"SELL\",\n      \"shares\": 10\n    }\n  ],\n  \"prices\": {\n    \"ALFA\": 181.5,\n    \"BRAV\": 98.1,\n    \"ECHO\": 41.6,\n    \"GOLF\": 62.3\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/trades/check")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"portfolio_id\": \"6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10\",\n  \"trades\": [\n    {\n      \"symbol\": \"ALFA\",\n      \"side\": \"BUY\",\n      \"shares\": 40\n    },\n    {\n      \"symbol\": \"GOLF\",\n      \"side\": \"SELL\",\n      \"shares\": 10\n    }\n  ],\n  \"prices\": {\n    \"ALFA\": 181.5,\n    \"BRAV\": 98.1,\n    \"ECHO\": 41.6,\n    \"GOLF\": 62.3\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10\",\n  \"trades\": [\n    {\n      \"symbol\": \"ALFA\",\n      \"side\": \"BUY\",\n      \"shares\": 40\n    },\n    {\n      \"symbol\": \"GOLF\",\n      \"side\": \"SELL\",\n      \"shares\": 10\n    }\n  ],\n  \"prices\": {\n    \"ALFA\": 181.5,\n    \"BRAV\": 98.1,\n    \"ECHO\": 41.6,\n    \"GOLF\": 62.3\n  }\n}"

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

{
  "portfolio_id": "6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10",
  "scenario_id": "c1a7e0d4-3a52-4b1f-8f4b-0e6b2d9f7a21",
  "within_rules": false,
  "newly_or_further_outside_count": 2,
  "rules_judged_count": 9,
  "rules": [
    {
      "kind": "position_size",
      "symbol": "ALFA",
      "asset_class_id": "3d5b0c1e-7a44-4c52-9a31-5c2f8e0b6d12",
      "asset_class": "Equities",
      "min_pct": 3,
      "max_pct": 12,
      "before_pct": 10.89,
      "after_pct": 13.79,
      "before_status": "COMPLIANT",
      "after_status": "ABOVE_MAX",
      "gap_before_pts": 0,
      "gap_after_pts": 1.79,
      "change": "newly_outside"
    },
    {
      "kind": "class_band",
      "symbol": null,
      "asset_class_id": "8e2a4d7b-5c19-4f60-b3a8-1d9e6c0f4a35",
      "asset_class": "Commodities",
      "min_pct": 3,
      "max_pct": 11,
      "before_pct": 2.59,
      "after_pct": 2.34,
      "before_status": "BELOW_MIN",
      "after_status": "BELOW_MIN",
      "gap_before_pts": 0.41,
      "gap_after_pts": 0.66,
      "change": "further_outside"
    }
  ],
  "not_covered": [
    {
      "symbol": "GOLF",
      "asset_class": "Commodities",
      "reason": "NO_SIZE_RANGE",
      "traded": true
    }
  ],
  "trades": [
    {
      "index": 0,
      "symbol": "ALFA",
      "side": "BUY",
      "shares": 40,
      "price": 181.5,
      "notional": 7260,
      "shares_before": 150,
      "shares_after": 190
    },
    {
      "index": 1,
      "symbol": "GOLF",
      "side": "SELL",
      "shares": 10,
      "price": 62.3,
      "notional": 623,
      "shares_before": 104,
      "shares_after": 94
    }
  ],
  "cash": {
    "before": 12000,
    "after": 5363,
    "sufficient": true
  },
  "total_value": 250000,
  "exposure_after": {
    "total_value": 250000,
    "long_pct": 97.85,
    "short_pct": 0,
    "net_pct": 97.85,
    "gross_pct": 97.85,
    "options_counted": 0,
    "options_not_counted": 0
  },
  "positions_updated_at": "2026-10-09T18:22:04Z",
  "basis": "Computed from this rule set's saved ranges, the holdings Allocait has recorded, and the prices you supplied. Taxes, fees, liquidity and accounts outside Allocait are not considered.",
  "checked_at": "2026-10-11T14:03:11Z"
}

{
  "error": "A price is needed for ECHO.",
  "error_code": "PRICES_INCOMPLETE",
  "missing_symbols": [
    "ECHO"
  ]
}

{
  "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"
}

Checks

Check a proposed change against the rules

States which of the user’s own rules a proposed change puts outside its range or leaves further outside, using prices you supply. It reads and writes nothing, decides nothing and needs only read, so a Core account’s key can call it. A result inside every range does not say a change is advisable. Allocait cannot approve, stop or place an order.

trades is the whole change, 1 to 50 items, applied together and in any order: several trades in one symbol net. side is the direction of the change being asked about: BUY adds shares to the holding, SELL removes shares. Send shares (fractions allowed) or notional (dollars, at the price in prices), not both. A SELL larger than the shares held is INVALID_INPUT, never clamped, unless the portfolio has allow_shorts on: then a SELL can take a holding below zero and a BUY can take a short above it, and shares_after is signed (negative is a short). A holding in the Options class never goes below zero, and a change worth 100000000000000 or more cannot be recorded, so it is refused. CASH is not tradable. A symbol the portfolio does not hold needs asset_class (a class name, rules text alias or id); a held symbol keeps the class it is recorded under.

prices is required and must cover every non-cash holding and every traded symbol, except a held option with a mark or one past its expiry, which is priced from the user’s own number or at 0 (ADR-147). A hole is a 400 with error_code: PRICES_INCOMPLETE and missing_symbols; Allocait never fills a symbol you left out from its own market data (ADR-036). A held symbol may be priced 0 (a worthless option); a price you pass for an unexpired option replaces its mark for this call only. A traded symbol priced 0 or less is PRICES_INVALID. Prices are used for this call only and never stored.

A trade in a held option that has expired is not checked, because the option counts 0 and a trade cannot change the book. It is INVALID_INPUT and the message names the trade’s index and symbol and the write that closes it (shares 0 and price 0).

scenario_id defaults to the portfolio’s active scenario. A portfolio with none set needs scenario_id (a 400 that says so).

Reading the result. rules lists only the rules outside their range before or after the change. Rules inside both are counted in rules_judged_count. change describes a rule’s distance from its range, never the trade. newly_or_further_outside_count answers “did this change add a breach or deepen one”. A bot that must do neither checks that it equals 0.

within_rules answers a different question: is the whole book inside every rule after the change. It is true only when no rule is outside its range after the change, rules_judged_count is above 0 and cash.sufficient is true. Treat false as “not confirmed”, never as a block Allocait enforces. Treat true as saying nothing about any symbol no rule covers; not_covered lists those symbols, traded or held.

exposure_after says how much of the book gains if prices rise once the whole change is applied: long, short, net and gross as percents of total_value, at your prices (shares x price x moves; a holding’s Moves is the setting the user recorded, 1 unless set). It is a reading beside the rules, not part of the verdict, and within_rules does not read it. Options count at their premium, a call as long and a put as short, and an expired option counts 0 (ADR-147).

Report positions_updated_at with the verdict. The book is what Allocait has recorded. Allocait does not read the live account. The symbols in the examples are fictional and their numbers are made up.

POST

trades

check

Check a proposed change against the rules

curl --request POST \
  --url https://allocait.app/api/v1/trades/check \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "portfolio_id": "6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10",
  "trades": [
    {
      "symbol": "ALFA",
      "side": "BUY",
      "shares": 40
    },
    {
      "symbol": "GOLF",
      "side": "SELL",
      "shares": 10
    }
  ],
  "prices": {
    "ALFA": 181.5,
    "BRAV": 98.1,
    "ECHO": 41.6,
    "GOLF": 62.3
  }
}
'

import requests

url = "https://allocait.app/api/v1/trades/check"

payload = {
    "portfolio_id": "6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10",
    "trades": [
        {
            "symbol": "ALFA",
            "side": "BUY",
            "shares": 40
        },
        {
            "symbol": "GOLF",
            "side": "SELL",
            "shares": 10
        }
    ],
    "prices": {
        "ALFA": 181.5,
        "BRAV": 98.1,
        "ECHO": 41.6,
        "GOLF": 62.3
    }
}
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: '6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10',
    trades: [
      {symbol: 'ALFA', side: 'BUY', shares: 40},
      {symbol: 'GOLF', side: 'SELL', shares: 10}
    ],
    prices: {ALFA: 181.5, BRAV: 98.1, ECHO: 41.6, GOLF: 62.3}
  })
};

fetch('https://allocait.app/api/v1/trades/check', 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/trades/check",
  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' => '6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10',
    'trades' => [
        [
                'symbol' => 'ALFA',
                'side' => 'BUY',
                'shares' => 40
        ],
        [
                'symbol' => 'GOLF',
                'side' => 'SELL',
                'shares' => 10
        ]
    ],
    'prices' => [
        'ALFA' => 181.5,
        'BRAV' => 98.1,
        'ECHO' => 41.6,
        'GOLF' => 62.3
    ]
  ]),
  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/trades/check"

	payload := strings.NewReader("{\n  \"portfolio_id\": \"6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10\",\n  \"trades\": [\n    {\n      \"symbol\": \"ALFA\",\n      \"side\": \"BUY\",\n      \"shares\": 40\n    },\n    {\n      \"symbol\": \"GOLF\",\n      \"side\": \"SELL\",\n      \"shares\": 10\n    }\n  ],\n  \"prices\": {\n    \"ALFA\": 181.5,\n    \"BRAV\": 98.1,\n    \"ECHO\": 41.6,\n    \"GOLF\": 62.3\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/trades/check")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"portfolio_id\": \"6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10\",\n  \"trades\": [\n    {\n      \"symbol\": \"ALFA\",\n      \"side\": \"BUY\",\n      \"shares\": 40\n    },\n    {\n      \"symbol\": \"GOLF\",\n      \"side\": \"SELL\",\n      \"shares\": 10\n    }\n  ],\n  \"prices\": {\n    \"ALFA\": 181.5,\n    \"BRAV\": 98.1,\n    \"ECHO\": 41.6,\n    \"GOLF\": 62.3\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10\",\n  \"trades\": [\n    {\n      \"symbol\": \"ALFA\",\n      \"side\": \"BUY\",\n      \"shares\": 40\n    },\n    {\n      \"symbol\": \"GOLF\",\n      \"side\": \"SELL\",\n      \"shares\": 10\n    }\n  ],\n  \"prices\": {\n    \"ALFA\": 181.5,\n    \"BRAV\": 98.1,\n    \"ECHO\": 41.6,\n    \"GOLF\": 62.3\n  }\n}"

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

{
  "portfolio_id": "6f0f6b32-0a52-4c0e-9b7e-2f8a4f1b9a10",
  "scenario_id": "c1a7e0d4-3a52-4b1f-8f4b-0e6b2d9f7a21",
  "within_rules": false,
  "newly_or_further_outside_count": 2,
  "rules_judged_count": 9,
  "rules": [
    {
      "kind": "position_size",
      "symbol": "ALFA",
      "asset_class_id": "3d5b0c1e-7a44-4c52-9a31-5c2f8e0b6d12",
      "asset_class": "Equities",
      "min_pct": 3,
      "max_pct": 12,
      "before_pct": 10.89,
      "after_pct": 13.79,
      "before_status": "COMPLIANT",
      "after_status": "ABOVE_MAX",
      "gap_before_pts": 0,
      "gap_after_pts": 1.79,
      "change": "newly_outside"
    },
    {
      "kind": "class_band",
      "symbol": null,
      "asset_class_id": "8e2a4d7b-5c19-4f60-b3a8-1d9e6c0f4a35",
      "asset_class": "Commodities",
      "min_pct": 3,
      "max_pct": 11,
      "before_pct": 2.59,
      "after_pct": 2.34,
      "before_status": "BELOW_MIN",
      "after_status": "BELOW_MIN",
      "gap_before_pts": 0.41,
      "gap_after_pts": 0.66,
      "change": "further_outside"
    }
  ],
  "not_covered": [
    {
      "symbol": "GOLF",
      "asset_class": "Commodities",
      "reason": "NO_SIZE_RANGE",
      "traded": true
    }
  ],
  "trades": [
    {
      "index": 0,
      "symbol": "ALFA",
      "side": "BUY",
      "shares": 40,
      "price": 181.5,
      "notional": 7260,
      "shares_before": 150,
      "shares_after": 190
    },
    {
      "index": 1,
      "symbol": "GOLF",
      "side": "SELL",
      "shares": 10,
      "price": 62.3,
      "notional": 623,
      "shares_before": 104,
      "shares_after": 94
    }
  ],
  "cash": {
    "before": 12000,
    "after": 5363,
    "sufficient": true
  },
  "total_value": 250000,
  "exposure_after": {
    "total_value": 250000,
    "long_pct": 97.85,
    "short_pct": 0,
    "net_pct": 97.85,
    "gross_pct": 97.85,
    "options_counted": 0,
    "options_not_counted": 0
  },
  "positions_updated_at": "2026-10-09T18:22:04Z",
  "basis": "Computed from this rule set's saved ranges, the holdings Allocait has recorded, and the prices you supplied. Taxes, fees, liquidity and accounts outside Allocait are not considered.",
  "checked_at": "2026-10-11T14:03:11Z"
}

{
  "error": "A price is needed for ECHO.",
  "error_code": "PRICES_INCOMPLETE",
  "missing_symbols": [
    "ECHO"
  ]
}

{
  "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

trades

object[]

required

The whole change, checked together. Trades in one symbol net.

Required array length: 1 - 50 elements

Show child attributes

prices

object

required

Symbol-to-price map. Keys are ticker symbols, matched case-insensitively (normalised to uppercase); values are numbers, 0 or more. 0 is a real price, for example an option that expired worthless. On the agent surface, a symbol you leave out of this map is never priced from Allocait's own data (ADR-036); it comes back null, or the call is refused, depending on the endpoint. Two exceptions are the user's own numbers, not Allocait's: a held option with a mark is priced at its mark, so you may leave it out, and a price you pass for it replaces the mark for that call only and is never stored; an option past its expiry counts 0 whatever you pass (ADR-147).

Show child attributes

Example:

{ "ALFA": 181.5, "ECHO": 98.1, "GOLF": 62.3 }

scenario_id

string<uuid>

Default is the portfolio's active scenario, and only that (ADR-232).

Response

The rules the change puts outside their range, and the whole book after the change

portfolio_id

string<uuid>

required

scenario_id

string<uuid>

required

within_rules

boolean

required

True only when no rule is outside its range after the change, rules_judged_count is above 0 and cash.sufficient is true. A breach that existed before keeps it false. false with rules_judged_count: 0 means no rule was checked. Treat false as "not confirmed", never as a block Allocait enforces, and true as saying nothing about anything no rule covers.

newly_or_further_outside_count

integer

required

Rules with change newly_outside or further_outside. 0 means the change added no breach and deepened none.

rules_judged_count

integer

required

Class bands in the scenario plus holdings size-judged after the change (non-cash, above 0%, in a class with a range for the side the holding ends on: the position size range for a long, the short size range for a short).

rules

object[]

required

Only rules outside their range before or after the change. Rules inside both are counted in rules_judged_count, not listed.

Show child attributes

not_covered

object[]

required

One entry per symbol no rule judges, so within_rules: true is never read as "a rule looked at this symbol". Traded symbols, and held symbols the change does not touch that have no class or that no rule judges (traded: false).

Show child attributes

trades

object[]

required

One row per trade as sent.

Show child attributes

cash

object

required

Show child attributes

total_value

number

required

Priced non-cash holdings plus cash, at the prices you passed. The same before and after.

positions_updated_at

string<date-time> | null

required

When the newest holding record changed, null with no holdings. Report it with the verdict.

basis

string

required

What the result is computed from (the saved ranges, the recorded holdings, the prices you supplied). Always the same sentence.

checked_at

string<date-time>

required

exposure_after

object

The exposure reading once the whole change is applied, at the prices you supplied: the totals of ExposureReading without the by-class and per-holding lists. A fact about the book after the change, not a verdict, and within_rules does not read it. A symbol the change opens counts at Moves 1 in the class the trade named. Options count at their premium, as in ExposureReading (ADR-147).

Show child attributes

Start

Conventions

Errors

Webhooks

Endpoints

Check a proposed change against the rules

Authorizations

Body

Response