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

TD Ameritrade Holding User Management API

User preferences and principal data

TD Ameritrade Holding User Management API is one of 9 APIs that TD Ameritrade Holding publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against a single base URL, https://api.tdameritrade.com/v1.

3 operations 2 paths 3 schemas 2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Base URL
https://api.tdameritrade.com/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

TD Ameritrade Holding User Management API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 3 scopes. By default, every request must be authenticated.

  • OAuth2 — TD Ameritrade uses OAuth 2.0 token-based authentication

Paths & Operations 3

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

User Management 3

User preferences and principal data

GET
/accounts/{accountId}/preferences
Get Preferences
getPreferences 1 param → 200401
PUT
/accounts/{accountId}/preferences
Update Preferences
updatePreferences 1 param body → 200401
GET
/userprincipals
Get User Principals
getUserPrincipals 1 param → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Preferences (14 properties), UserPrincipal (11 properties), Error (2 properties). Each schema is shown below with its type and property counts.

UserPrincipal
object
User principal information including linked accounts
11 properties
Error
object
2 properties
Preferences
object
Account preferences settings
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

td-ameritrade-holding-user-management-api-openapi.yml Raw ↑

Other APIs TD Ameritrade Holding publishes across the network.

TD Ameritrade Holding Accounts API
TD Ameritrade Holding Instruments API
TD Ameritrade Holding Market Data API
TD Ameritrade Holding Options API
TD Ameritrade Holding Orders API
TD Ameritrade Holding Saved Orders API
TD Ameritrade Holding Transactions API
TD Ameritrade Holding Watchlists API