Rules

Get a rule

GET/v1/rules/{id}

Authentication: API key (Authorization: Bearer)
Required scope: read

Path parameters#

idstring · uuidrequired

Responses#

200Rule.

Object fields

idstring · uuid
namestring
kindstring
Rules created through the API are large_transfer, new_counterparty or burst; the other kinds are created from the dashboard and are returned read-only.

Values large_transfer new_counterparty burst admin_change contract_upgrade low_balance balance_drop
chain_idsarray of integer
paramsobject
Normalised rule parameters (amounts in raw units).
severitystring
Values critical warning info
statestring
Values active paused
immediate_alertbooleannullable
Alert before confirmations. null = default by severity (yes for critical).
channel_idsarray of string · uuid
pending_changeobjectnullable
Deferred pause or deletion of a critical rule, effective at effective_at.
Object fields
- idstring · uuid
- actionstring
  Values pause delete
- requested_atstring · date-time
- effective_atstring · date-time
created_atstring · date-time

4xx · 5xxError.

Standard error format: see Errors.

Request

cURL

curl "https://aicscan.io/v1/rules/0193a1b4-2e7f-7a10-9b3c-4d5e6f708192" \
  -H "Authorization: Bearer $AICSCAN_API_KEY"

JavaScript

const res = await fetch('https://aicscan.io/v1/rules/0193a1b4-2e7f-7a10-9b3c-4d5e6f708192', {
  headers: {
    Authorization: `Bearer ${process.env.AICSCAN_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.code);
console.log(data);

Python

import os
import requests

resp = requests.get(
    "https://aicscan.io/v1/rules/0193a1b4-2e7f-7a10-9b3c-4d5e6f708192",
    headers={
        "Authorization": f"Bearer {os.environ['AICSCAN_API_KEY']}",
    },
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Response 200

JSON

{
  "id": "0193a1b4-2e7f-7a10-9b3c-4d5e6f708192",
  "name": "Treasury: large USDT outflows",
  "kind": "large_transfer",
  "chain_ids": [
    56
  ],
  "params": {
    "type": "large_transfer",
    "addresses": [
      "0x8894e0a0c962cb723c1976a4421c95949be2d4e3"
    ],
    "direction": "outgoing",
    "asset": {
      "kind": "token",
      "address": "0x55d398326f99059ff775485246999027b3197955"
    },
    "threshold": "0xa968163f0a57b400000"
  },
  "severity": "critical",
  "state": "active",
  "immediate_alert": null,
  "channel_ids": [
    "0193a1b3-7d21-7c55-8e0a-9f1b2c3d4e5f"
  ],
  "pending_change": null,
  "created_at": "2026-11-14T09:14:55.302Z"
}