Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Interactive Brokers Sessions API

Authentication and session management

Interactive Brokers Sessions API is one of 7 APIs that Interactive Brokers publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://localhost:5000/v1/api.

1 operations 1 paths 1 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://localhost:5000/v1/api
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Interactive Brokers Sessions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Sessions 1

Authentication and session management

POST
/iserver/auth/status
Get authentication status
getAuthStatus → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is AuthStatus (3 properties). Each schema is shown below with its type and property counts.

AuthStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

interactive-brokers-sessions-api-openapi.yml Raw ↑

Other APIs Interactive Brokers publishes across the network.

Interactive Brokers Client Portal API
Interactive Brokers Accounts API
Interactive Brokers Contracts API
Interactive Brokers Market Data API
Interactive Brokers Orders API
Interactive Brokers Portfolio API