API reference

This reference is generated from the API's OpenAPI document, served by the service itself. Each page gives the method, the path, the required scope, the parameters, the expected body, the responses and examples in cURL, JavaScript and Python.

• Base URL: https://aicscan.io
• Authentication: Authorization: Bearer aic_… on every route except /v1/health and /v1/openapi.yaml. See Authentication.
• Errors: common format, see Errors.

The examples read the key from the AICSCAN_API_KEY environment variable.

Workspace#

• GET/v1/workspaceWorkspace of the API key, plan limits and usage

Addresses#

• GET/v1/addressesList watched addresses
• POST/v1/addressesWatch an address
• GET/v1/addresses/{id}Get a watched address
• PATCH/v1/addresses/{id}Change the label
• DELETE/v1/addresses/{id}Stop watching an address

Rules#

• GET/v1/rulesList rules
• POST/v1/rulesCreate a rule
• GET/v1/rules/{id}Get a rule
• PATCH/v1/rules/{id}Pause, resume or rename a rule
• DELETE/v1/rules/{id}Delete a rule

Channels#

• GET/v1/channelsList notification channels
• POST/v1/channelsCreate a channel
• GET/v1/channels/{id}Get a channel
• PATCH/v1/channels/{id}Disable, enable or rename a channel
• DELETE/v1/channels/{id}Delete a channel
• POST/v1/channels/{id}/testSend a test message
• GET/v1/channel-invites/{token}Status of a Telegram or helloMe invitation

Notifications#

• GET/v1/notificationsList notifications sent (or to send) on your channels
• GET/v1/notifications/{id}Get a notification and its delivery attempts
• POST/v1/notifications/{id}/resendResend a notification

Alerts#

• GET/v1/matchesList alerts (rule matches)

Events#

• GET/v1/eventsList on-chain events touching your watched addresses

Tokens#

• GET/v1/tokens/{chain_id}/{address}Metadata of a known token

Service#

• GET/v1/healthPublic service status
• GET/v1/openapi.yamlThis OpenAPI document

Download openapi.yaml · OpenAPI 3.1.0