Cryptocurrency Alerting

REST API Reference

Our REST API empowers developers to automate, extend and combine our platform with other services. The interface aims to be as user friendly as possible, using JSON responses and HTTP codes to indicate errors. To get started, simply generate an API key below and give one of our CURL examples a try.

How it Works

In a nutshell, our system monitors "Alert Conditions" that users can create and destroy using HTTP requests. When an alert condition becomes true, an alert trigger fires and a message gets sent to the appropriate notification channel (such as a Webhook event, a Telegram message or an SMS).

Please let us know if you have any questions or comments.

Your API Tokens


Authentication is performed via HTTP Basic Auth, where your API token is the basic auth username (the password is left blank). All API requests require authentication and must be made over HTTPS. For help getting started, try pasting one of our CURL examples below into a command line. Never share your API token.

Token
Status
--
--

POST /v1/alert-conditions

Create an Alert Condition

Attribute
Description
type
An alert condition type.
new_coin|price|percent_price|bitcoin_mempool|wallet
currency
A supported cryptocurrency code, such as BTC. View our list of supported coins. We also support ANY for new_coin alert types, which acts as a wildcard.
channel
A supported notification channel. A JSON object with a name of
sms|email|push|phonecall|browser|webhook|slack|telegram|discord
exchange
A supported cryptocurrency exchange. View our list of supported exchanges. We also support ANY, which acts as a wildcard.
target_currency
A supported crypto or fiat code to measure the price of the currency attribute with.
USD|BTC|USDT|EUR|GBP|AUD|CAD|JPY|KRW|CNY|NZD
price
The target price of the currency to be monitored.
threshold
The target value of a currency to cross.
percent
The amount of change required to satisfy a percent_price alert condition.
metric
The metric to monitor the Bitcoin Mempool with.
megabytes|unconfirmedtxns
blockchain
A supported Wallet Watch blockchain: BTC|ETH.
address
A valid Bitcoin or Ethereum address.
direction
The direction to monitor when a threshold is crossed.
For percent_price use up|down. For wallet use increases|decreases|changes.
window
Number of minutes to compare a percent_price change. Minimum value is 5.
run_once
Optional. Once an alert condition fires, it should become disabled. Default: false


Coin Listing Alert Example
{
  type: 'new_coin',
  currency: 'ANY',
  channel: { 'name': 'email' },
  exchange: 'Bittrex'
}
Curl example:


Price Alert Example
{
  type: 'price',
  currency: 'ETH',
  target_currency: 'USD',
  price: '400.00',
  direction: 'above',
  channel: { 'name': 'telegram' },
  exchange: 'Gemini'
}
Curl example:


Percent Price Alert Example
{
  type: 'percent_price',
  currency: 'BTC',
  percent: '10.5',
  direction: 'up',
  window: 60,
  channel: { 'name': 'slack' },
  exchange: 'Binance'
}
Curl example:


Bitcoin Mempool Alert Example
{
  type: 'bitcoin_mempool',
  threshold: '50',
  direction: 'above',
  metric: 'megabytes',
  channel: { 'name': 'sms' }
}
Curl example:


Wallet Watch Alert Example
{
  type: 'wallet',
  blockchain: 'ETH',
  address: '0x72c930652AcbcAc0ceFeA1e5b8e2D83A48523a9E',
  direction: 'changes',
  channel: { 'name': 'discord' }
}
Curl example:


Response Structure:
A JSON object is returned, which corresponds with the newly created alert condition. The id field can be used to modify or delete the alert condition in subsequent API calls.
HTTP/1.1 200 OK
{
  id: 1,
  type: 'new_coin',
  currency: 'ANY',
  channel: {
    'name': 'email',
    'confirmed': true
  },
  exchange: 'Bittrex'
}

GET /v1/alert-conditions[?type=<alert_type>]

Get All Alert Conditions


Curl example:


Response Structure:
An array of alert conditions is returned.
HTTP/1.1 200 OK
[
  {
    id: 1,
    type: 'new_coin',
    currency: 'ANY',
    channel: {
      'name': 'email',
      'confirmed': true
    },
    exchange: 'Bittrex'
  },
  {
    id: 2,
    type: 'price',
    currency: 'ETH',
    target_currency: 'USD',
    price: '400.00',
    direction: 'above',
    channel: {
      'name': 'telegram',
      'confirmed': true
    },
    exchange: 'Gemini'
  },
  ...
]

GET /v1/alert-conditions/<id>

Get a Specific Alert Condition

Curl example:


Response Structure:
HTTP/1.1 200 OK
{
  id: 1,
  type: 'new_coin',
  currency: 'ANY',
  channel: {
    'name': 'email',
    'confirmed': true
  },
  exchange: 'Bittrex'
}

PUT /v1/alert-conditions/<id>

Enable/Disable an Alert Condition

Request Structure:
{
  enabled: false
}
Curl example:


Response Structure:
HTTP/1.1 200 OK
{
  status: "success"
}

DELETE /v1/alert-conditions/<id>

Delete an Alert Condition

Curl example:


Response Structure:
HTTP/1.1 200 OK
{
  status: "success"
}

Errors


Error Response:
HTTP/1.1 400 Bad Request
{
  status: "error"
  message: "A description of the error."
}


Code
Name
Description
200
OK
A successful response
400
Bad Request
The request was unacceptable, often due to missing a required parameter.
401
Unauthorized
Invalid API Token
403
Quota Reached
Alert condition quota reached
404
Not Found
The requested resource does not exist
420
Too Many Requests
You've made too many requests in a given time window. We recommend an exponential backoff for further requests
50X
Server Error
An issue occurred on our end. If the problem persists, contact us.

Rate Limiting

We will rate limit requests per API token to 2 req/sec. If you go over the rate limit, a 429 response will be returned and you should try again in a few minutes.

Reacting to an Alert

Our webhook notifications are generally a good compliment to the REST API. They allow users to programmatically react to an alert as soon as one is triggered. Visit the FAQ to learn more about webhooks, or visit the Webhook Reference to view example JSON objects for each of our alert types.
Have a question?







Forgot Password?      













Already a member?
Pay With Card
Pay With Crypto


When changing plans, any money already spent on a subscription will be pro-rated towards this new plan.
Bill Monthly      Bill Yearly  Save 20%Save 20%


You will be charged $59.88 $47.88 annually.
(equivalent to $3.99 per month)
You may cancel at any time.
You will be charged $299.88 $239.88 annually.
(equivalent to $19.99 per month)
You may cancel at any time.
Current Plan
Hobby
Usage
Using # out of # alerts.

Payment Info

Billing History
Change Password

Referral Code

Delete Account
Default Currency
Default Timezone
Default Alert Method
Default Exchange
Notification Settings


Card and crypto accepted. Cancel any time.
$0.00/mo

Hobby

Create up to 3 active alerts.
$3.99/mo

Trader

Create up to 20 active alerts.
Unlock all premium features
$19.99/mo

Pro

Create up to 120 active alerts.
Unlock all premium features
We provide several incentives for referring others to our platform.
+1

Refer Your Friends

Increase your active alert quota each time a friend signs up and confirms their email. Free plans included!
20%

Monetize Your Brand

Refer others to our platform and earn 20% of the revenue they generate at any point in the future!
Use your referral link to be credited for all referrals: https://cryptocurrencyalerting.com/?ref=REF_CODE


Available for payout: ####.

Please provide us with a valid PayPal address where we can transfer your funds. It does not need to be the same email address that you signed up with.




Your payout will arrive within 2 business days. You will be contacted if we encounter any issues.

Alerting MethodsNotification Settings

Receive SMS text message alerts by simply verifying your phone number. Standard SMS rates apply. 200+ supported countries.




Alerts sent to countries outside of the US & Canada are only available on our Pro plan


Status: Not Configured


Download our app to start receiving push notifications directly on your iOS or Android device:







Status: Not Configured


Push Notifications can be sent to any iOS or Android device by simply downloading the Pushover app.

Download the Pushover app and create an account:


Enter your User Key so we have permission to send you push notifications:





Status: Not Configured


Receive direct Phone Calls for alerts that require immediate attention. An automated recording will read your alert out loud when you answer. Never miss an urgent event in crypto.




Alerts sent to countries outside of the US & Canada are only available on our Pro plan



Status: Not Configured


Browser Notifications allow you to receive alerts right from your desktop — even if the tab is closed! Visit our FAQ for further details.




Simply click "Allow" when the prompt pops up to enable browser notifications in your current browser.


Status: Not Configured


A Webhook allows users to programmatically react to an alert. It's a way to automate, extend and combine our platform with other services. Visit our FAQ to learn more about webhooks, or check out the quick start guide.






Status: Not Configured


Integrate your account with a Slack channel in seconds. Once logged in, simply click "Add to Slack", then select a workspace and channel.

Add to Slack




Status: Not Configured


Link your account with our Telegram bot to receive customizable crypto alerts. Unlike most crypto bots, you create and manage alerts from our web interface. We support both individual users and telegram groups.






Status: Not Configured


Integrate your account with any Discord server. You'll just need to provide us with a specific Webhook URL to send you messages. Click here for a quick guide.






Status: Not Configured


Read our FAQ for answers to common questions.





Please explain what the issue is and we'll look into it.




We're sorry to see you go.
Why did you decide to cancel?



This action will immediately suspend all active alerts and remove your account from our system. This is irreversible, and any paid membership will be forfeited.

Are you sure want to delete your account?



My Alerts
Account & Settings
You're about to delete this alert.








Starting at $3.99/mo.

Go Back


Success! Your alert has been saved. You still need to verify your phone number before you can receive SMS alerts.
You must enable Pushover Notifications before this alert can be received.
You must enable Push Notifications before this alert can be received.
In order to receive Phone Calls, you will need to verify your phone number.
You must allow Browser Notifications before this alert can be received.
You still need to provide us with a valid Webhook URL before this alert can be received.
You must link a Slack Channel before this alert can be received.
You must link a Telegram account before this alert can be received.
You must link a Discord server before this alert can be received.
When using our bulk wallet importer, there may be a delay before the addresses appear in our system. Check back shortly.
Manage My Alerts
Thanks for giving us a try! You've been sent an email in order to confirm this account.

Please let us know if you run into any issues, or if you have any other general feedback. Cheers.