---
title: "Initialize Brokerage Session"
method: POST
path: "/iserver/auth/ssodh/init"
tags: ["tradingSession"]
---

# Initialize Brokerage Session

`POST /iserver/auth/ssodh/init`

After retrieving the access token and subsequent Live Session Token, customers can initialize their brokerage session with the ssodh/init endpoint.

## Request body

- BrokerageSessionInitRequest
  - `publish` boolean — publish brokerage session token at the same time when brokerage session initialized. If set false, then session token should be published before calling init. Setting true is preferred way.
  - `compete` boolean — Determines if other brokerage sessions should be disconnected to prioritize this connection.

## Response `200`

An array of objects detailing contract information.

- 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.

## Other responses

- `401` — Missing, invalid, or unparseable Authorization token.
- `500` — internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests. For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.
- `503` — service is unavailable. For example if request takes more than 10s due to some internal service unavailability, request aborted and this status returned

---

[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)