Aicscan Documentation
FrançaisEnglish

Changelog

The API follows the version policy: v1 only receives backward-compatible additions. Breaking changes will open /v2, announced here.

November 2026 — self-service API keys#

  • Owners and administrators of a workspace create and revoke their own API keys from the client area (API keys page): name, read or read + write scope, optional expiry, key shown only once. At most 10 active keys per workspace. Keys issued by the Aicscan team remain visible and revocable from that page. See Authentication.
  • Every creation and revocation is recorded in the workspace activity log and notified to owners.
  • Contact address added to the documentation: support@aicscan.io.

v1 — November 2026#

First public version.

REST API (https://aicscan.io/v1)

  • API key authentication (Authorization: Bearer aic_…), read and write scopes, expiry and revocation.
  • Access limited to the Pro and Business plans; plan limits enforced (plan_limit_reached, channel_kind_not_in_plan, plan_feature_unavailable).
  • Per-key rate limit over a one-second window, RateLimit-* headers; daily quota per workspace, Aicscan-Daily-Quota-* headers.
  • Cursor pagination (limit 1 to 100), POST idempotency (Idempotency-Key, 24 hours), single error format with stable codes.
  • Resources: workspace (/v1/workspace), addresses, rules (large_transfer, new_counterparty, burst), channels (webhook, Discord, Slack, email, Telegram, helloMe), channel invitations, notifications and resend, alerts (/v1/matches), events, tokens, service health.
  • One-hour security delay for pausing and deleting an active critical rule.
  • OpenAPI 3.1 document at /v1/openapi.yaml.

Webhooks

  • Requests signed with HMAC-SHA256 (X-Signature, X-Timestamp, X-Event-Id), 5-minute anti-replay window.
  • Retries over 24 hours, automatic disabling after 24 hours of failures, SSRF protection at every delivery.

Real time

  • WebSocket wss://aicscan.io/api/ws/alertes authenticated with an API key, resume with last_id over 7 days.

Documentation clarifications#

  • OpenAPI schemas completed: balance_drop rule kind (rules created from the dashboard), balance event source, list of notification stages (stage).