Get notifications

GET 
/notifications

This endpoint provides the platform's notifications.

Responses

200

application/json

Schema

Schema

oneOf

Success Response

notifications object[]

A list containing the notifications.

Array [

effectiveTime string

The time that notification is taking effect.

note string

The notification note. A short description about the specific notification.

priority string

Possible values: [low, medium, high]

The notification priorities:

• low
• medium
• high

If priority == "high" then it implies downtime will occur at effective_time when type == "maintenance".

type string

Possible values: [new_feature, bug_fix, settlement, general, maintenance, market]

The notification types:

• market
• general
• new_feature
• bug_fix
• maintenance
• settlement

If type == "maintenance" then it implies downtime will occur at effective_time if priority == "high".

expectedDowntimeMinutes integer

The expected downtime in minutes or absent if no downtime is expected.

]

result stringrequired

Possible values: [success]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

ErrorResponse

errors Error (string)[]

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

error Error (string)

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

result stringrequired

Possible values: [error]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

success

{
  "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"
}

failure

{
  "result": "error",
  "serverTime": "2016-02-25T09:45:53.818Z",
  "error": "apiLimitExceeded"
}

Loading...