Filter
curl --request POST \
--url https://api.allium.so/api/v1/streams/data-management/filters \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"filter": {}
}'import requests
url = "https://api.allium.so/api/v1/streams/data-management/filters"
payload = { "filter": {} }
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({filter: {}})
};
fetch('https://api.allium.so/api/v1/streams/data-management/filters', 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.allium.so/api/v1/streams/data-management/filters",
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([
'filter' => [
]
]),
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.allium.so/api/v1/streams/data-management/filters"
payload := strings.NewReader("{\n \"filter\": {}\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.allium.so/api/v1/streams/data-management/filters")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.allium.so/api/v1/streams/data-management/filters")
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 \"filter\": {}\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"result_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Filters
Create filter
Create a new filter by specifying the field, operator and type
POST
/
api
/
v1
/
streams
/
data-management
/
filters
Filter
curl --request POST \
--url https://api.allium.so/api/v1/streams/data-management/filters \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"filter": {}
}'import requests
url = "https://api.allium.so/api/v1/streams/data-management/filters"
payload = { "filter": {} }
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({filter: {}})
};
fetch('https://api.allium.so/api/v1/streams/data-management/filters', 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.allium.so/api/v1/streams/data-management/filters",
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([
'filter' => [
]
]),
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.allium.so/api/v1/streams/data-management/filters"
payload := strings.NewReader("{\n \"filter\": {}\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.allium.so/api/v1/streams/data-management/filters")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.allium.so/api/v1/streams/data-management/filters")
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 \"filter\": {}\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"result_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}This endpoint creates a new filter for use in stream transformations.
Filters support comparison operators (
=, !=, >, >=, <, <=), the in operator for matching against arrays or data sources, the exists operator for field presence checks, and compound AND/OR logic for complex conditions.
See the Filter Syntax documentation for complete details on all operators, nested conditions, and examples.
Example Filter with Data Source
{
"filter": {
"field": "token_address",
"operator": "in",
"data_source_id": "3123712-aqw1-asdg-0293-1f48914e1e3f"
}
}
Example Filter with Array Values
{
"filter": {
"field": "token_address",
"operator": "in",
"value": [
"0x1234567890abcdef1234567890abcdef12345678",
"0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"
]
}
}
Example Compound Filter
{
"filter": {
"op": "AND",
"conditions": [
{
"field": "blockchain",
"operator": "=",
"value": "ethereum"
},
{
"field": "value",
"operator": ">",
"value": "1000000000000000000"
}
]
}
}
Supported Operators
| Operator | Description | Example Value |
|---|---|---|
= | Equals | "ethereum" |
!= | Not equals | "pending" |
> | Greater than | 1000000 |
>= | Greater than or equal | 18000000 |
< | Less than | 50000 |
<= | Less than or equal | 100 |
in | Value in array or data source | ["ethereum", "polygon"] |
exists | Field exists or doesn’t exist | true or false |
Old Filter Syntax (Deprecated)
The old filter syntax with
"type": "data_source" and uppercase operators is deprecated. We recommend using the new syntax shown above.{
"filter": {
"field": "token_address",
"operator": "IN",
"type": "data_source",
"data_source_id": "3123712-aqw1-asdg-0293-1f48914e1e3f"
}
}
Next Steps
Filter Syntax
Learn how to filter streams with complex conditions
Was this page helpful?
⌘I