Response fields
array of objects
A list of all connections for the specified user.
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.
brokerage
object
Describes a brokerage that SnapTrade supports.
id
string (format: uuid)
Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
slug
string
A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
name
string
Full name of the brokerage.
display_name
string
A display-friendly name of the brokerage.
description
string
A brief description of the brokerage.
aws_s3_logo_url
string (format: url)
URL to the brokerage's logo.
aws_s3_square_logo_url
string (format: url) or null
URL to the brokerage's logo in square format.
url
string (format: url)
URL to the brokerage's website.
enabled
boolean
Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections.
maintenance_mode
boolean
Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections.
allows_trading
boolean or null
Whether the brokerage allows trading through SnapTrade.
allows_fractional_units
boolean or null
This field is deprecated. Please contact us if you have a valid use case for it.
has_reporting
boolean or null
This field is deprecated. Please contact us if you have a valid use case for it.
is_real_time_connection
boolean
This field is deprecated. Please contact us if you have a valid use case for it.
brokerage_type
object
Type of brokerage. Currently supports traditional brokerages and crypto exchanges.
id
string (format: uuid)
name
string
exchanges
array of any
This field is deprecated. Please contact us if you have a valid use case for it.
open_url
string (format: url) or null
This field is deprecated.
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.
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.
1[2{3"id": "87b24961-b51e-4db8-9226-f198f6518a89",4"created_date": "2024-08-20T21:56:19.123Z",5"brokerage": {6"id": "ebf91a5b-0920-4266-9e36-f6cfe8c40946",7"slug": "ROBINHOOD",8"name": "Robinhood",9"display_name": "Robinhood",10"description": "Robinhood is an American multinational financial services corporation based in Menlo Park, California.",11"aws_s3_logo_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo.png",12"aws_s3_square_logo_url": "https://passiv-brokerage-logos.s3.ca-central-1.amazonaws.com/robinhood-logo-square.png",13"url": "https://robinhood.com",14"enabled": true,15"maintenance_mode": true,16"allows_trading": true,17"allows_fractional_units": true,18"has_reporting": true,19"is_real_time_connection": true,20"brokerage_type": {21"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",22"name": "Traditional Brokerage"23},24"exchanges": [25"2bcd7cc3-e922-4976-bce1-9858296801c3",26"4bcd8cc3-c122-4974-dc21-1858296801f4"27],28"open_url": "string"29},30"name": "Connection-1",31"type": "trade",32"disabled": false,33"disabled_date": "2022-01-21T20:11:19.217Z",34"meta": {35"identifier": 12345636},37"updated_date": "2024-08-20T21:56:20.057Z"38}39]