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 Portfolio API

Portfolio positions and account summaries

Interactive Brokers Portfolio 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 Portfolio. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 2 operations across 2 paths, and defines 2 schemas. 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.

2 operations 2 paths 2 schemas 2 GET

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 Portfolio 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 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Portfolio 2

Portfolio positions and account summaries

GET
/portfolio/{accountId}/positions/{pageId}
Get portfolio positions
getPositions 2 params → 200
GET
/portfolio/{accountId}/summary
Get account summary
getAccountSummary 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Position (8 properties), AccountSummary (4 properties). Each schema is shown below with its type and property counts.

Position
object
8 properties
AccountSummary
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

interactive-brokers-portfolio-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 Sessions API