---
title: "Brokerage Keep-Alive Ping"
method: POST
path: "/tickle"
tags: ["tradingSession"]
---

# Brokerage Keep-Alive Ping

`POST /tickle`

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 `200`

An array of objects detailing contract information.

- union
  - SuccessfulTickleResponse
    - `session` string — Returns the session token of the contract.
    - `ssoExpires` integer — Returns the number of milliseconds until the current sso session expires.
    - `collission` boolean — (Internal Use Only)
    - `userId` integer — (Internal Use Only)
    - `hmds` SuccessfulTickleResponseHmds — Returns connection details for the historical market data server.
      - `error` string — Relays any internal connection errors.
      - `authStatus` unknown[] — Returns authentication details.
        - unknown
    - `iserver` SuccessfulTickleResponseIserver
      - `authStatus` BrokerageSessionStatus
        - `authenticated` boolean — Returns whether your brokerage session is authenticated or not.
        - `established` boolean — Returns whether your brokerage session is fully established and ready to handle requests. Set to true when the login message is received from underlying brokerage infrastructure, indicating authentication is complete and account information is loaded.
        - `competing` boolean — Returns whether you have a competing brokerage session in another connection.
        - `connected` boolean — Returns whether you are connected to the gateway or not.
        - `message` string — A message about your authenticate status if any.
        - `MAC` string — Device MAC information.
        - `serverInfo` BrokerageSessionStatusServerInfo
          - `serverName` string — IBKR server information. Internal use only.
          - `serverVersion` string — IBKR version information. Internal use only.
        - `hardware_info` string — Client Portal use only.
        - `fail` string — Returns the reason for failing to retrieve authentication status.
  - FailedTickleResponse
    - `error` string — reason why tickle was accepted by not processed

## Other responses

- `401` — Missing, invalid, or unparseable Authorization token.

---

[API](https://skmtc.net/interactivebrokers/apis/api-reference.md) · [All operations](https://skmtc.net/interactivebrokers/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactivebrokers/api-reference/revisions/67f9f562c2c6/schema)
