OANDA · Schema

TransactionHeartbeat

A TransactionHeartbeat object is injected into the Transaction stream to ensure that the HTTP connection remains active.

ForexFX TradingCFD TradingFinancial-ServicesTrading APIs

Properties

Name	Type	Description
type	string	The string "HEARTBEAT"
lastTransactionID	string	The ID of the most recent Transaction created for the Account
time	string	The date/time when the TransactionHeartbeat was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TransactionHeartbeat",
  "description": "A TransactionHeartbeat object is injected into the Transaction stream to ensure that the HTTP connection remains active.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The string \"HEARTBEAT\""
    },
    "lastTransactionID": {
      "type": "string",
      "description": "The ID of the most recent Transaction created for the Account",
      "format": "String representation of the numerical OANDA-assigned TransactionID"
    },
    "time": {
      "type": "string",
      "description": "The date/time when the TransactionHeartbeat was created.",
      "format": "The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places)."
    }
  }
}