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 User Info & Preferences API

The User Info & Preferences API from TD Ameritrade — 3 operation(s) for user info & preferences.

TD Ameritrade User Info & Preferences API is one of 15 APIs that TD Ameritrade publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Info & Preferences. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 3.0.1.

Requests are made against 2 base URLs: https://api.tdameritrade.com/v2, http://api.tdameritrade.com/v2.

4 operations 3 paths 9 schemas 3 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.1
Base URL
https://api.tdameritrade.com/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

TD Ameritrade User Info & Preferences API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

Paths & Operations 4

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

User Info & Preferences 4
GET
/accounts/{accountId}/preferences
APIs to access user-authorized accounts and their preferences
getPreferences 1 param → 200400401500503
PUT
/accounts/{accountId}/preferences
APIs to access user-authorized accounts and their preferences
updatePreferences 1 param body → 200400401403500503
GET
/userprincipals/streamersubscriptionkeys
APIs to access user-authorized accounts and their preferences
getStreamerSubscriptionKeys 1 param → 200400401500503
GET
/userprincipals
APIs to access user-authorized accounts and their preferences
getUserPrincipals 1 param → 200400401500503

Schemas 9

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

UpdatePreferences
object
14 properties
EquityPriceLinkType
string
SubscriptionKey
object
1 property
UserPrincipal
object
14 properties
TaxLotMethod
string
Duration
string
Session
string
OrderType
string
Preferences
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

td-ameritrade-user-info-preferences-api-openapi.yml Raw ↑

Other APIs TD Ameritrade publishes across the network.

TD Ameritrade Market Data API
TD Ameritrade Instruments API
TD Ameritrade Authentication API
TD Ameritrade Streaming Market Data API
TD Ameritrade Accounts and Trading API
TD Ameritrade Authentication API
TD Ameritrade Instruments API
TD Ameritrade Market Hours API
TD Ameritrade Movers API
TD Ameritrade Option Chains API
TD Ameritrade Price History API
TD Ameritrade Quotes API