SMS & Notifications API
BETA FEATURE
This feature is currently in beta. API endpoints and functionality may change.
Want early access? Email us at [email protected] to join the beta program.
Overview
The SMS & Notifications API allows you to receive real-time price alerts via SMS text message. Get notified instantly when oil prices hit your target levels or move by a specified percentage.
Features
- SMS Price Alerts: Receive text messages when prices hit targets
- Threshold Alerts: Get notified on percentage moves
- Custom Schedules: Set quiet hours and delivery preferences
- Multiple Numbers: Add backup phone numbers
- In-App Notifications: View all alerts in your dashboard
Phone Management
Get Phone Number
GET /v1/phone
Returns your registered phone number and verification status.
Response:
{
"phone": "+1234567890",
"verified": true,
"country_code": "US",
"added_at": "2025-01-15T10:00:00Z"
}
Add Phone Number
POST /v1/phone
Request Body:
{
"phone_number": "+1234567890",
"country_code": "US"
}
Verify Phone Number
POST /v1/phone/verify
Request Body:
{
"verification_code": "123456"
}
Resend Verification
POST /v1/phone/resend
Remove Phone Number
DELETE /v1/phone
SMS Settings
Get SMS Settings
GET /v1/sms/settings
Response:
{
"enabled": true,
"quiet_hours": {
"start": "22:00",
"end": "07:00",
"timezone": "America/New_York"
},
"max_messages_per_day": 10,
"alert_types": ["price_target", "threshold"]
}
Update SMS Settings
PATCH /v1/sms/settings
Request Body:
{
"quiet_hours": {
"start": "23:00",
"end": "06:00"
},
"max_messages_per_day": 5
}
Opt In to SMS
POST /v1/sms/optin
Opt Out of SMS
DELETE /v1/sms/optin
Check Eligibility
GET /v1/sms/eligibility
Returns whether your account is eligible for SMS notifications.
Test SMS
POST /v1/sms/test
Sends a test message to verify your setup.
Notification Preferences
Get Preferences
GET /v1/notification_preferences
Response:
{
"email": {
"enabled": true,
"price_alerts": true,
"weekly_digest": true,
"product_updates": false
},
"sms": {
"enabled": true,
"price_alerts": true
},
"push": {
"enabled": false
}
}
Update Preferences
PATCH /v1/notification_preferences
Request Body:
{
"sms": {
"price_alerts": true
},
"email": {
"weekly_digest": false
}
}
In-App Notifications
List Notifications
GET /v1/notifications
Response:
{
"notifications": [
{
"id": "notif_123",
"type": "price_alert",
"title": "WTI hit $75.00",
"message": "WTI Crude reached your target price of $75.00",
"read": false,
"created_at": "2025-01-15T14:30:00Z"
}
],
"unread_count": 3
}
Get Unread Count
GET /v1/notifications/unread_count
Mark as Read
POST /v1/notifications/:id/mark_read
Mark All as Read
POST /v1/notifications/mark_all_read
Supported Countries
SMS notifications are currently available in:
| Country | Code | Status |
|---|---|---|
| United States | US | Available |
| Canada | CA | Available |
| United Kingdom | GB | Available |
| Australia | AU | Available |
| Germany | DE | Coming Soon |
| France | FR | Coming Soon |
Pricing
SMS notifications are included with Professional and higher plans.
| Plan | SMS Messages/Month |
|---|---|
| Free | Not available |
| Hobby | Not available |
| Starter | Not available |
| Professional | 50 |
| Business | 200 |
| Enterprise | Unlimited |
Get Beta Access
JOIN THE BETA
SMS Notifications are currently invite-only. To request access:
Include your country, current plan, and how you plan to use SMS alerts.