Create an alert rule

curl --request POST \
  --url https://api.range.org/v1/risk/alert-rules \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "High gas on eth",
  "severity": "high",
  "parameters": {}
}
'

import requests

url = "https://api.range.org/v1/risk/alert-rules"

payload = {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "High gas on eth",
    "severity": "high",
    "parameters": {}
}
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({
    id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    name: 'High gas on eth',
    severity: 'high',
    parameters: {}
  })
};

fetch('https://api.range.org/v1/risk/alert-rules', 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://api.range.org/v1/risk/alert-rules",
  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([
    'id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'name' => 'High gas on eth',
    'severity' => 'high',
    'parameters' => [
        
    ]
  ]),
  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://api.range.org/v1/risk/alert-rules"

	payload := strings.NewReader("{\n  \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"name\": \"High gas on eth\",\n  \"severity\": \"high\",\n  \"parameters\": {}\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://api.range.org/v1/risk/alert-rules")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"name\": \"High gas on eth\",\n  \"severity\": \"high\",\n  \"parameters\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.range.org/v1/risk/alert-rules")

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  \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"name\": \"High gas on eth\",\n  \"severity\": \"high\",\n  \"parameters\": {}\n}"

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

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "workspace_id": "workspace-123",
  "rule_type": "GasPressure",
  "severity": "high",
  "parameters": {
    "threshold": 90
  },
  "trigger": "BLOCK",
  "enabled": true,
  "version": 1,
  "subscribed_channels": [
    {
      "alert_channel_id": "44444444-4444-4444-4444-444444444445",
      "min_severity": null
    }
  ],
  "created_at": "2026-05-14T12:00:00.000Z",
  "updated_at": "2026-05-14T12:00:00.000Z",
  "name": "High gas on eth",
  "network": "eth",
  "runner_id": "alert-runner-eth-v2",
  "alert_template": {
    "id": "1",
    "type": "large_transfer",
    "label": "Large Transfer",
    "description": "A large transfer was detected on {{network}}",
    "network": "eth",
    "severity": "high",
    "tags": [
      "defi",
      "transfer"
    ],
    "trigger": "BLOCK",
    "parameters": [
      {
        "label": "Wallet",
        "description": "The address to monitor",
        "field": "address",
        "field_type": "Address",
        "optional": false
      }
    ]
  }
}

POST

risk

alert-rules

Create an alert rule

curl --request POST \
  --url https://api.range.org/v1/risk/alert-rules \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "High gas on eth",
  "severity": "high",
  "parameters": {}
}
'

import requests

url = "https://api.range.org/v1/risk/alert-rules"

payload = {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "High gas on eth",
    "severity": "high",
    "parameters": {}
}
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({
    id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    name: 'High gas on eth',
    severity: 'high',
    parameters: {}
  })
};

fetch('https://api.range.org/v1/risk/alert-rules', 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://api.range.org/v1/risk/alert-rules",
  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([
    'id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'name' => 'High gas on eth',
    'severity' => 'high',
    'parameters' => [
        
    ]
  ]),
  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://api.range.org/v1/risk/alert-rules"

	payload := strings.NewReader("{\n  \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"name\": \"High gas on eth\",\n  \"severity\": \"high\",\n  \"parameters\": {}\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://api.range.org/v1/risk/alert-rules")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"name\": \"High gas on eth\",\n  \"severity\": \"high\",\n  \"parameters\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.range.org/v1/risk/alert-rules")

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  \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"name\": \"High gas on eth\",\n  \"severity\": \"high\",\n  \"parameters\": {}\n}"

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

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "workspace_id": "workspace-123",
  "rule_type": "GasPressure",
  "severity": "high",
  "parameters": {
    "threshold": 90
  },
  "trigger": "BLOCK",
  "enabled": true,
  "version": 1,
  "subscribed_channels": [
    {
      "alert_channel_id": "44444444-4444-4444-4444-444444444445",
      "min_severity": null
    }
  ],
  "created_at": "2026-05-14T12:00:00.000Z",
  "updated_at": "2026-05-14T12:00:00.000Z",
  "name": "High gas on eth",
  "network": "eth",
  "runner_id": "alert-runner-eth-v2",
  "alert_template": {
    "id": "1",
    "type": "large_transfer",
    "label": "Large Transfer",
    "description": "A large transfer was detected on {{network}}",
    "network": "eth",
    "severity": "high",
    "tags": [
      "defi",
      "transfer"
    ],
    "trigger": "BLOCK",
    "parameters": [
      {
        "label": "Wallet",
        "description": "The address to monitor",
        "field": "address",
        "field_type": "Address",
        "optional": false
      }
    ]
  }
}

Authorizations

X-API-KEY

string

header

required

Authorization method required to allow user to access the api endpoints.

Body

application/json

string<uuid>

required

The id of the template this rule instantiates. The template supplies the rule_type, network, runner_id, severity, and trigger.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

name

string

required

Display name for the rule.

Maximum string length: 255

Example:

"High gas on eth"

severity

string

Severity override. Defaults to the matched template severity.

Maximum string length: 255

Example:

"high"

parameters

object

User-supplied parameter values, as a { field: value } object. A [{ field, value }] array or single-element wrapper is also accepted and normalized to an object on write.

trigger

enum<string>

Trigger override. Defaults to the matched template trigger.

Available options:

BLOCK,

TICK

Response

200 - application/json

string

required

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

workspace_id

string

required

Example:

"workspace-123"

rule_type

string

required

Example:

"GasPressure"

severity

string

required

Example:

"high"

parameters

object

required

Example:

{ "threshold": 90 }

trigger

enum<string>

required

Available options:

BLOCK,

TICK

Example:

"BLOCK"

enabled

boolean

required

Example:

true

version

number

required

Incremented each time the rule parameters change. Starts at 1.

Example:

1

subscribed_channels

object[]

required

Show child attributes

Example:

[
  {
    "alert_channel_id": "44444444-4444-4444-4444-444444444445",
    "min_severity": null
  }
]

created_at

string

required

Example:

"2026-05-14T12:00:00.000Z"

updated_at

string

required

Example:

"2026-05-14T12:00:00.000Z"

name

string | null

Example:

"High gas on eth"

network

string | null

Example:

"eth"

runner_id

string | null

Example:

"alert-runner-eth-v2"

alert_template

object | null

Show child attributes

Last modified on July 22, 2026

List alert rules for the caller workspace Fetch a single alert rule

Overview

API Reference

Alerting

Rule Catalogue

Create an alert rule

Authorizations

Body

Response