This endpoint provides the platform's notifications.
Authentication is required.
|
Endpoint |
Request Type |
Permissible API Keys |
| /api/v3/notifications |
GET
|
Read-only, Read-write, Master |
| Arguments | |||
| none |
| Sample Call |
| https://www.cryptofacilities.com/derivatives/api/v3/notifications |
| Sample Return if Successful |
| { "result":"success", "notifications":[ { "type":"general", "priority":"low", "note":"We've launched a new Telegram group." }, { "type":"settlement", "priority":"medium", "note":"Week contracts with maturity 29/Jun/2018 expire and settle.", "effectiveTime":"2018-06-29T15:00:00Z" } ], "serverTime":"2018-06-29T15:22:05.187Z" } |
|
Field |
Type | Description |
|
result
|
String | Always success |
|
serverTime
|
ISO8601 datetime | The server date and time |
| notifications | list of structures | A list containing the notifications. |
| type | string |
The notification type. Existing types are market, general, new_feature, bug_fix, maintenance, settlement. If type=="maintenance" then it implies downtime will occur at effective_time if priority=="high" |
| priority | string |
The notification priority. Existing priorities are low, medium, high. If priority=="high" then it implies downtime will occur at effective_time when type=="maintenance". |
| note | string | The notification note. A short description about the specific notification. |
| effectiveTime | ISO8601 datetime | The time that notification is taking effect. |
| Sample Return if Unsuccessful |
| { "result":"error", "serverTime":"2016-02-25T09:45:53.818Z", "error":"apiLimitExceeded", } |
|
Field |
Type | Description |
|
result
|
String | Always error |
|
serverTime
|
ISO8601 datetime | The server date and time |
|
error
|
string |
The reason the API call failed, either of:
|