Response fields
object
A single connection with a brokerage. Note that Connection
and Brokerage Authorization
are interchangeable, but the term Connection
is preferred and used in the doc for consistency.
A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.
SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
id
string (format: uuid)
Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
created_date
string (format: date-time)
Timestamp of when the connection was established in SnapTrade.
updated_date
string (format: date-time)
Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field.
brokerage
object
Describes a brokerage that SnapTrade supports.
name
string
A short, human-readable name for the connection.
type
string
Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are read
and trade
.
disabled
boolean
Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios:
- The user has changed their username or password at the brokerage.
- The user has explicitly removed the access grant at the brokerage.
- The session has expired at the brokerage and now requires explicit user re-authentication.
Please see this guide on how to fix a disabled connection.
disabled_date
string (format: date-time) or null
Timestamp of when the connection was disabled in SnapTrade.
meta
object
Additional data about the connection. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.