Using Filters
Learn how to use filters to get notifications on the activity you care about.
Filters are a set of conditions and values that allow you to specify the onchain event that should trigger a notification. You can quickly set parameters on any field in the payload. Filters are created using field_name
, operator
, value_type
, and value
.
Name | Definition |
---|---|
| |
| |
| The data type of the value you are filtering with |
| The actual value or list of values to compare against the specified |
Example Request:
List of Operators
Operators must be used with a valid value type to successfully create the notification.
Operator | Definition | Value_Type |
---|---|---|
| variable is equal to a value [ = ] | int, float, str, boolean |
| variable does not equal a value [ != ] | int, float, str, boolean |
| variable is greater than a value [ > ] | int, float |
| variable is less than a value [ < ] | int, float |
| variable is in a list | list |
| variable is not in a list | list |
| a list contains the variable | string |
| a list does not contain the variable | string |
List of Variables
You can apply filters on any of the data fields in the primary payload. Please reference the tables below for list of field_names
and corresponding value_type
.
Address_Activity Filters
Field Name | Definition | Value Type |
---|---|---|
| The unique hash identifying the transaction on the blockchain. |
|
| The address sending the asset in a transaction. |
|
| The address receiving the asset in a transaction. |
|
| The symbol or address of the asset or token involved in the transaction. (e.g. |
|
| The amount of the asset or token transferred or exchanged in the transaction. |
|
| The block number in which the transaction was included. |
|
| The category of the transaction (e.g., "external", "internal"). |
|
GraphQL Filters
Field Name | Definition | Value Type |
---|---|---|
| The hash of the transaction. |
|
| The sender address of the transaction. |
|
| The recipient address of the transaction |
|
| The value of the transaction |
|
Note: additional filters on event address and topic-level parameters can be applied in the GRAPHQL object. See Smart Contracts for more detail.
NFT_Activity Filters
Field Name | Definition | Value Type |
---|---|---|
| The unique hash identifying the transaction on the blockchain. |
|
| The address sending the NFT in a transfer or sale. |
|
| The address receiving the NFT in a transfer or sale. |
|
| The address of the NFT contract. |
|
| The unique identifier (token ID) of the NFT involved in the event. |
|
| The index of the log within the block. |
|
| The hash of the block in which the transaction occurred. |
|
| The index of the transaction within the block. |
|
| The block number in which the transaction was included. |
|
| The raw data associated with the event log. |
|
| A text representation of the topics (indexed parameters) of the event log. |
|
| The topics (indexed parameters) of the event log. |
|
| The address of the contract that emitted the event. |
|
Farcaster_Cast Filters:
Field Name | Definition | Value Type |
---|---|---|
| The unique hash identifying the cast on Farcaster. |
|
| The text content of the cast. |
|
| The Farcaster ID (FID) of the author of the cast. |
|
| The username of the author of the cast. |
|
| The display name of the author of the cast. |
|
| The URL of the author's profile picture. |
|
| The text of the author's profile bio. |
|
| The number of followers the author has. |
|
| The number of users the author is following. |
|
| A boolean of the author's power badge status |
|
| The timestamp of when the cast was created. |
|
| The URL of the farcaster channel |
|
| The hash of the farcaster channel |
|
| The hash of the thread this cast belongs to. |
|
| The number of replies to this cast. |
|
| A text representation of the recast (re-share) reactions to this cast. |
|
| An array of recast (re-share) reactions to this cast. |
|
| The like reactions to this cast. |
|
| An array of like reactions to this cast. |
|
Last updated