Brokerage Keep-Alive Ping | Interactive Brokers

{
  "fail": {
    "value": {
      "error": "failed to process request"
    }
  },
  "success": {
    "value": {
      "collission": false,
      "hmds": {
        "error": "no bridge"
      },
      "iserver": {
        "authStatus": {
          "MAC": "98:F2:B3:23:BF:A0",
          "authenticated": true,
          "competing": false,
          "connected": true,
          "established": true,
          "message": "",
          "serverInfo": {
            "serverName": "JifN19053",
            "serverVersion": "Build 10.25.0p, Dec 5, 2023 5:48:12 PM"
          }
        }
      },
      "session": "bb665d0f55b6289d70bc7380089fc96f",
      "ssoExpires": 460311,
      "userId": 123456789
    }
  }
}

If the gateway has not received any requests for several minutes an open session will automatically timeout. The tickle endpoint pings the server to prevent the session from ending. It is expected to call this endpoint approximately every 60 seconds to maintain the connection to the brokerage session.

Response

An array of objects detailing contract information.

successfulTickleResponseobject

failedTickleResponseobject

Errors

401

Unauthorized Error