Règles

Créer une règle

POST/v1/rules

Les adresses de la règle sont ajoutées aux adresses surveillées si besoin (comptées dans la limite de l’offre). Les règles sont créées actives (active).

Authentification: Clé d’API (Authorization: Bearer)
Portée requise: write

Rejouable sans risque avec l’en-tête Idempotency-Key : voir Idempotence.

En-têtes#

Idempotency-Keystring
Permet de relancer le POST sans risque pendant 24 heures.

de 1 à 255 caractères

Corps de la requête#

namestringobligatoire
de 1 à 120 caractères
kindstringobligatoire
- large_transfer : un transfert d’au moins threshold.
- new_counterparty : une sortie vers une adresse jamais vue.
- burst : au moins count sorties en window_minutes.
Valeurs large_transfer new_counterparty burst
chain_idintegerobligatoire
addressestableau de stringobligatoire
de 1 à 20 éléments
assetstring
native, any (seuil en unités brutes) ou adresse du contrat d’un jeton connu d’Aicscan.

Par défaut "native"
thresholdstring
large_transfer : montant décimal en unités du jeton, par exemple 50000 ou 0.5.
directionstring
Valeurs outgoing incoming both
Par défaut "both"
countinteger
burst seulement.

de 2 à 1000
window_minutesinteger
burst seulement.

de 1 à 1440
severitystringobligatoire
Valeurs critical warning info
channel_idstableau de string · uuidobligatoire
au moins 1 éléments
immediate_alertbooleanpeut valoir null
true exige une offre avec alerte immédiate (403 plan_feature_unavailable).

Réponses#

201Créée.

En-têtes de réponse

Locationstring
Idempotent-Replayedstring
true quand la réponse est le rejeu d’une requête précédente de même Idempotency-Key.

Valeurs true

Champs de l’objet

idstring · uuid
namestring
kindstring
Les règles créées par l’API sont de type large_transfer, new_counterparty ou burst ; les autres types se créent depuis le tableau de bord et sont renvoyés en lecture seule.

Valeurs large_transfer new_counterparty burst admin_change contract_upgrade low_balance balance_drop
chain_idstableau de integer
paramsobject
Paramètres normalisés de la règle (montants en unités brutes).
severitystring
Valeurs critical warning info
statestring
Valeurs active paused
immediate_alertbooleanpeut valoir null
Alerte avant les confirmations. null = valeur par défaut selon la gravité (oui pour critical).
channel_idstableau de string · uuid
pending_changeobjectpeut valoir null
Pause ou suppression différée d’une règle critique, effective à effective_at.
Champs de l’objet
- idstring · uuid
- actionstring
  Valeurs pause delete
- requested_atstring · date-time
- effective_atstring · date-time
created_atstring · date-time

4xx · 5xxErreur.

Erreur au format standard : voir Erreurs.

Requête

cURL

curl -X POST "https://aicscan.io/v1/rules" \
  -H "Authorization: Bearer $AICSCAN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "name": "Treasury: large USDT outflows",
    "kind": "large_transfer",
    "chain_id": 56,
    "addresses": [
      "0x8894e0a0c962cb723c1976a4421c95949be2d4e3"
    ],
    "asset": "0x55d398326f99059ff775485246999027b3197955",
    "threshold": "50000",
    "direction": "outgoing",
    "severity": "critical",
    "channel_ids": [
      "0193a1b2-0000-7000-8000-000000000001"
    ]
  }'

JavaScript

const res = await fetch('https://aicscan.io/v1/rules', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AICSCAN_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    "name": "Treasury: large USDT outflows",
    "kind": "large_transfer",
    "chain_id": 56,
    "addresses": [
      "0x8894e0a0c962cb723c1976a4421c95949be2d4e3"
    ],
    "asset": "0x55d398326f99059ff775485246999027b3197955",
    "threshold": "50000",
    "direction": "outgoing",
    "severity": "critical",
    "channel_ids": [
      "0193a1b2-0000-7000-8000-000000000001"
    ]
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.code);
console.log(data);

Python

import os, uuid
import requests

resp = requests.post(
    "https://aicscan.io/v1/rules",
    headers={
        "Authorization": f"Bearer {os.environ['AICSCAN_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "name": "Treasury: large USDT outflows",
        "kind": "large_transfer",
        "chain_id": 56,
        "addresses": [
            "0x8894e0a0c962cb723c1976a4421c95949be2d4e3"
        ],
        "asset": "0x55d398326f99059ff775485246999027b3197955",
        "threshold": "50000",
        "direction": "outgoing",
        "severity": "critical",
        "channel_ids": [
            "0193a1b2-0000-7000-8000-000000000001"
        ]
    },
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Réponse 201

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