Alarmlar
Fiyat Alarmları
Description
Sadece sembolün fiyatına değil, yüzeysel veride bulunan adet, hacim vb gibi pek çok alana alarm kurulabilmektedir. Kurulan alarm 90 gün aktif olur. Bir kullanıcın toplam alarm sayısı 90ı geçemez (fiyat+haber+olay).
Endpoint
HTTP POST
Endpoint https://apitest.matriksdata.com/dumrul/v2/arf/rule
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| when | array | true | Alarm kriterlerini belirler. ge (büyük eşit), le (küçük eşit) kullanılabilir |
| then | array | true | Alarm gerçekleştiğinde alınacak aksiyonlar (mail, mqtt, push) |
| wait_until_threshold | boolean | false | Default: false. true verildiğinde alarm tetiklendiğinde pasife çekilir |
| keep_until | timestamp | false | Maksimum 3 ay sonrası. Alarm otomatik silinme zamanı |
Alarm Field Types
- ge, le: Default fiyattan alarm kurulur
- geUSD, leUSD: Default fiyatın USDTRY sembolüne bölünmüş fiyatına alarm kurulur
- geEUR, leEUR: Default fiyatın EURTRY sembolüne bölünmüş fiyatına alarm kurulur
Sample Request-Response
https://apitest.matriksdata.com/dumrul/v2/arf/rule
Request Body:
{
"when": [
{
"ge": [
"GARAN.last@rt",
19
]
}
],
"then": [
{
"send": {
"url": "mailto:deneme@gmail.com"
},
"message": "GARAN fiyat alarmı gerçekleşti",
"subject": "GARAN fiyat alarmı"
},
{
"send": {
"url": "mqtt:mqtt"
},
"message": "GARAN fiyat alarmı gerçekleşti",
"subject": "GARAN fiyat alarmı"
},
{
"send": {
"url": "push://"
},
"message": "İstenen metin girilebilir",
"subject": "İstenen metin girilebilir"
}
],
"wait_until_threshold": true,
"keep_until": 1636557575580
}
Response:
"7095c6f1-797e-4fe4-80e6-fb8d33025af7"
Haber Alarmları
Description
Sadece sembolün fiyatına değil, yüzeysel veride bulunan adet, hacim vb gibi pek çok alana alarm kurulabilmektedir. Kurulan alarm 90 gün aktif olur. Bir kullanıcın toplam alarm sayısı 90'ı geçemez (fiyat+haber+olay).
Endpoint
HTTP POST
Endpoint https://apitest.matriksdata.com/dumrul/v2/arf/rule
Sample Request-Response
https://apitest.matriksdata.com/dumrul/v2/arf/rule
Request Body:
{
"when": [
{
"contains": [
"{news.{field}@{dataType}",
"{value}"
]
}
],
"then": [
{
"send": {
"url": "mailto:deneme@gmail.com"
},
"message": "Mail içeriğinde gösterilecek metin girilir",
"subject": "Mail başlığında gösterilecek metin girilir"
},
{
"send": {
"url": "mqtt:mqtt"
},
"message": "Mqtt mesajında alınmak istenen metin girilebilir",
"subject": "İstenen metin girilebilir"
},
{
"send": {
"url": "push://"
},
"message": "İstenen metin giriliebilir",
"subject": "İstenen metin girilebilir"
}
]
}
Response:
"7095c6f1-797e-4fe4-80e6-fb8d33025af7"
Prime Olay Alarmları
Description
Dedektör, Formasyon, Trend, Kurum Önerileri, Hisse Beklenti Bilgileri kategorilerindeki olaylar için sembol bazlı alarm kurulabilmektedir. Kurulan alarm 90 gün aktif olur. Bir kullanıcın toplam alarm sayısı 90'ı geçemez (fiyat+haber+olay).
Endpoint
HTTP POST
Endpoint https://apitest.matriksdata.com/dumrul/v2/arf/rule
Kullanım Notları
Request body'de contains için topachtan dönen prime events altındaki uygun topic'ler kullanılmalı. Sadece sembol verilebileceği gibi sembol&kategori de verilebilir. Kategori verilmez ise bütün kategorilere kurulmuş olur.
Then için alarm gerçekleştiğinde alınmak istenen aksiyonlar belirlenir. Bu seçenekler mail gönderimi, mqtt mesajı ya da push mesaj olabilir.
Sample Request-Response
POST https://apitest.matriksdata.com/dumrul/v2/arf/rule
Request Body (sembol+kategori):
{
"when": [
{
"contains": [
"event.sym&cate.lvl3@rt",
"ACSEL&DEDEKTOR"
]
}
],
"then": [
{
"send": {
"url": "push:\/\/bridge?action=SYMBOL_DETAIL&eventDescription={{event_description}}&symbol=ACSEL&condition=contains:event.sym&cate.lvl3@rt:ACSEL%26DEDEKTOR&applicationId=MATRIKSIQ"
},
"message": "{{event_description}}",
"subject": "Matriks Alarm Sistemi",
"note": ""
},
{
"send": {
"url": "mqtt:mqtt"
},
"message": "{\"aps\":{\"alert\":{\"title\":\"Olay Alarmı\",\"body\":\"{{event_description}}\"}},\"message\":{\"notification\":{\"title\":\"Olay Alarmı\",\"body\":\"{{event_description}}\"}},\"data\":{\"alarmId\":\"{{id}}\",\"action\":\"SYMBOL_DETAIL\",\"applicationId\":\"MATRIKSIQ\"}}",
"subject": "Olay Alarmı",
"note": ""
}
]
}
Request Body (sadece sembol):
{
"when": [
{
"contains": [
"event.symbol.lvl3@rt",
"ACSEL"
]
}
],
"then": [
{
"send": {
"url": "push:\/\/bridge?action=SYMBOL_DETAIL&eventDescription={{event_description}}&symbol=ACSEL&condition=contains:event.sym&cate.lvl3@rt:ACSEL%26DEDEKTOR&applicationId=MATRIKSIQ"
},
"message": "{{event_description}}",
"subject": "Matriks Alarm Sistemi",
"note": ""
}
]
}
Request Body (sembol+agent):
{
"when": [
{
"contains": [
"event.sym&agent.lvl1@rt",
"THYAO&MLB"
]
}
],
"then": [
{
"send": {
"url": "mailto:mail.adresiniz@matriksdata.com"
},
"message": "{{event_description}}",
"subject": "THYAO&MLB symbol&agent tipinde alarm tetiklendi"
}
]
}
Response:
7095c6f1-797e-4fe4-80e6-fb8d33025af7
Alarm Listesi
Description
Kullanıcıya ait kurulmuş ve henüz silinmemiş olan bütün alarmları (aktif + pasif) listeler.
Endpoint
HTTP GET
Endpoint https://apitest.matriksdata.com/dumrul/v2/arf/rules
Sample Request-Response
https://apitest.matriksdata.com/dumrul/v2/arf/rules
{
"rules": [
{
"rule": {
"when": [
{
"ge": [
"GARAN.last@rt",
19
]
}
],
"then": [
{
"send": {
"url": "mailto:deneme@gmail.com"
},
"message": "GARAN fiyat alarmı gerçekleşti",
"subject": "GARAN fiyat alarmı"
},
{
"send": {
"url": "mqtt:mqtt"
},
"message": "GARAN fiyat alarmı gerçekleşti",
"subject": "GARAN fiyat alarmı"
},
{
"send": {
"url": "push://"
},
"message": "GARAN son fiyat değeri büyük eşittir 19.00 koşulu gerçekleşti!",
"subject": "Matriks Alarm Sistemi"
}
],
"owner": "21001",
"rule_id": "7095c6f1-797e-4fe4-80e6-fb8d33025af7",
"is_news_rule": false,
"wait_until_threshold": false,
"keep_until": 1636557575580,
"timestamp": 1628781575580
},
"active": true,
"trigger_timestamp": 1725549505820
}
]
}
Alarm Silme
Description
İstenen alarm bu istek ile silinebilir. Silinen alarmlar geri alınamaz.
Endpoint
HTTP DELETE
Endpoint https://apitest.matriksdata.com/dumrul/v2/arf/rule
Query Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| id | string | true | 7095c6f1-797e-4fe4-80e6-fb8d33025af7 | Alarm id |
Sample Request-Response
https://apitest.matriksdata.com/dumrul/v2/arf/rule?id=7095c6f1-797e-4fe4-80e6-fb8d33025af7
"OK"
Alarm Statüsünü Değiştirme
Description
İstenen alarmın statüsü aktiften pasife, pasiften aktife çekilebilir.
Endpoint
HTTP PUT
Endpoint https://apitest.matriksdata.com/dumrul/v2/arf/rule
Query Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| id | string | true | 7095c6f1-797e-4fe4-80e6-fb8d33025af7 | Alarm id |
| active | boolean | true | true | true/false değeri alır |
Sample Request-Response
"OK"