Skip to content

Latest commit

 

History

History
194 lines (107 loc) · 6.45 KB

AlertApi.md

File metadata and controls

194 lines (107 loc) · 6.45 KB

\AlertApi

All URIs are relative to https://localhost:5000/v1/api

Method HTTP request Description
iserver_account_account_id_alert_activate_post post /iserver/account/{accountId}/alert/activate Activate or deactivate an alert
iserver_account_account_id_alert_alert_id_delete delete /iserver/account/{accountId}/alert/{alertId} Delete an alert
iserver_account_account_id_alert_post post /iserver/account/{accountId}/alert Create or modify alert
iserver_account_account_id_alerts_get get /iserver/account/{accountId}/alerts Get a list of available alerts
iserver_account_alert_id_get get /iserver/account/alert/:id Get details of an alert
iserver_account_mta_get get /iserver/account/mta Get MTA alert

iserver_account_account_id_alert_activate_post

crate::models::InlineResponse20010 iserver_account_account_id_alert_activate_post(account_id, body) Activate or deactivate an alert

Please note, if alertId is 0, it will activate/deactivate all alerts

Parameters

Name Type Description Required Notes
account_id String account id [required]
body InlineObject2 [required]

Return type

crate::models::InlineResponse20010

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_account_id_alert_alert_id_delete

crate::models::InlineResponse20010 iserver_account_account_id_alert_alert_id_delete(account_id, alert_id) Delete an alert

Please be careful, if alertId is 0, it will delete all alerts

Parameters

Name Type Description Required Notes
account_id String account id [required]
alert_id String alert id [required]

Return type

crate::models::InlineResponse20010

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_account_id_alert_post

crate::models::InlineResponse2008 iserver_account_account_id_alert_post(account_id, body) Create or modify alert

Please note here, DO NOT pass orderId when creating a new alert, toolId is only required for MTA alert

Parameters

Name Type Description Required Notes
account_id String account id [required]
body AlertRequest alert info [required]

Return type

crate::models::InlineResponse2008

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_account_id_alerts_get

Veccrate::models::InlineResponse2009 iserver_account_account_id_alerts_get(account_id) Get a list of available alerts

The response will contain both active and inactive alerts, but it won't have MTA alert

Parameters

Name Type Description Required Notes
account_id String account id [required]

Return type

Veccrate::models::InlineResponse2009

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_alert_id_get

crate::models::AlertResponse iserver_account_alert_id_get(id) Get details of an alert

Use the endpoint /iserver/account/:accountId/alerts to receive the alert id. The order_id in the response is the alert id.

Parameters

Name Type Description Required Notes
id String alert id [required]

Return type

crate::models::AlertResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_mta_get

crate::models::AlertResponse iserver_account_mta_get() Get MTA alert

Each login user only has one mobile trading assistant (MTA) alert with it's own unique tool id. The tool id cannot be changed. When modified a new order Id is generated. MTA alerts can not be created or deleted. If you call delete /iserver/account/:accountId/alert/:alertId, it will reset MTA to default. See here for more information on MTA alerts.

Parameters

This endpoint does not need any parameter.

Return type

crate::models::AlertResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]