Skip to main content
API docs by Redocly

QuickAlerts REST API (1.0)

Download OpenAPI specification:Download

Destinations

Create a new destination

Authorizations:
x-api-key
Request Body schema: application/json
name
required
string
to_url
required
string

Webhook URL to send the alert payload

webhook_type
required
string
Enum: "POST" "GET"
service
required
string
Value: "webhook"
payload_type
required
number
Enum: 1 2 3 4 5 6 7

Payload type to send to the webhook

Responses

Request samples

Content type
application/json
{}

Retrieve all destinations

Authorizations:
x-api-key
query Parameters
limit
required
number
Default: 20
offset
required
number
Default: 0

Responses

Retrieve a destination by ID

Authorizations:
x-api-key
path Parameters
id
required
string

Responses

Remove a destination by ID

Authorizations:
x-api-key
path Parameters
id
required
string

Responses

Notifications

Create a new notification

Authorizations:
x-api-key
Request Body schema: application/json
name
required
string
expression
required
string <base64>

Base64 encoded expression

network
required
string
Enum: "ethereum-mainnet" "ethereum-goerli" "ethereum-sepolia" "bnbchain-mainnet" "avalanchec-mainnet" "fantom-mainnet" "polygon-mainnet" "celo-mainnet" "gnosis-mainnet" "optimism-mainnet" "nova-mainnet" "arbitrum-mainnet" "bitcoin-mainnet" "doge-mainnet"
destinationIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "My Notification",
  • "expression": "cXVpY2tBbGVydHMgaXMgY29vbAo=",
  • "network": "ethereum-mainnet",
  • "destinationIds": [
    ]
}

Retrieve all notifications

Authorizations:
x-api-key
query Parameters
limit
required
number
Default: 20
offset
required
number
Default: 0

Responses

Update a notification

Authorizations:
x-api-key
path Parameters
id
required
string
Request Body schema: application/json
name
string
expression
string <base64>

Base64 encoded expression

network
string
Enum: "ethereum-mainnet" "ethereum-goerli" "ethereum-sepolia" "bnbchain-mainnet" "avalanchec-mainnet" "fantom-mainnet" "polygon-mainnet" "celo-mainnet" "gnosis-mainnet" "optimism-mainnet" "nova-mainnet" "arbitrum-mainnet" "bitcoin-mainnet" "doge-mainnet"
destinationIds
Array of strings

Destination IDs

Responses

Request samples

Content type
application/json
{
  • "name": "My Notification",
  • "expression": "cXVpY2tBbGVydHMgaXMgY29vbAo=",
  • "network": "ethereum-mainnet",
  • "destinationIds": [
    ]
}

Retrieve a notification by ID

Authorizations:
x-api-key
path Parameters
id
required
string

Responses

Remove a notification by ID

Authorizations:
x-api-key
path Parameters
id
required
string

Responses

Enable a notification by ID

Authorizations:
x-api-key
path Parameters
id
required
string

Responses

Disable a notification by ID

Authorizations:
x-api-key
path Parameters
id
required
string

Responses

Retrieve event history by notification ID

Authorizations:
x-api-key
path Parameters
id
required
string
query Parameters
limit
required
number
Default: 20
offset
required
number
Default: 0

Responses

Validate expression for a notification

Authorizations:
x-api-key
Request Body schema: application/json
expression
required
string <base64>

Base64 encoded expression

network
required
string
Enum: "ethereum-mainnet" "ethereum-goerli" "ethereum-sepolia" "bnbchain-mainnet" "avalanchec-mainnet" "fantom-mainnet" "polygon-mainnet" "celo-mainnet" "gnosis-mainnet" "optimism-mainnet" "nova-mainnet" "arbitrum-mainnet" "bitcoin-mainnet" "doge-mainnet"

Responses

Request samples

Content type
application/json
{
  • "expression": "cXVpY2tBbGVydHMgaXMgY29vbAo=",
  • "network": "ethereum-mainnet"
}

Backtest expression for a notification

Authorizations:
x-api-key
Request Body schema: application/json
expression
required
string <base64>

Base64 encoded expression

network
required
string
Enum: "ethereum-mainnet" "ethereum-goerli" "ethereum-sepolia" "bnbchain-mainnet" "avalanchec-mainnet" "fantom-mainnet" "polygon-mainnet" "celo-mainnet" "gnosis-mainnet" "optimism-mainnet" "nova-mainnet" "arbitrum-mainnet" "bitcoin-mainnet" "doge-mainnet"
block_number
required
number

Block number to backtest

backtest_count
required
number <= 20

Number of blocks to backtest

Responses

Request samples

Content type
application/json
{
  • "expression": "cXVpY2tBbGVydHMgaXMgY29vbAo=",
  • "network": "ethereum-mainnet",
  • "block_number": 16735528,
  • "backtest_count": 5
}